Zextras CLI

zxsuite - Zextras Suite Command-Line Interface

Basic Usage

Every module of Network NG, including the core, has its own set of zxsuite commands. All zxsuite commands are invoked with the following syntax:

zxsuite [--host|--offline] [--json] [--progress] [--sync] {module} {action} [options]
  • --host [hostname|ip] - Specify a target host for the command. Leave blank for localhost. Use all_servers to broadcast the command to all servers.

  • --offline - Use if Zimbra is not started. Some commands will not work

  • --json - The output of the command will be presented in JSON format. Good for scripting.

  • --progress - Prints the operation’s feedback directly to STDOUT. Press Ctrl+C to interrupt the output. The operation itself won’t be interrupted.

  • --sync - Runs the command in synchronous mode, waiting for the operation’s execution to end and returning an exit code relevant with the operation’s result among the following:

    • 0 - Successful

    • 1 - Failed

    • 2 - Stopped

    • 3 - Removed

    • 4 - Interrupted

Command help

An automated help message can be obtained by running

zxsuite help {module} [command]

Omitting the command will display the full list of available commands.

Core CLI

zxsuite core

Table 1. zxsuite core
Command Description Usage

doDeleteAllDelegatedRights

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

zxsuite core doDeleteAllDelegatedRights {confirmation string}

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 {service_name}

doStartService

start a given service

zxsuite core doStartService {service_name}

doStopService

stop a given service

zxsuite core doStopService {service_name}

doUploadLicense

Upload a ZeXtras Suite license

zxsuite core doUploadLicense {license_path} [attr1 value1 [attr2 value2…​]]

getAccountStats

Show statistic informations about provided account name or ID

zxsuite core getAccountStats {account}

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

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

setProperty

Set configuration property

zxsuite core setProperty {property_name} {property_value}

Backup CLI

zxsuite backup

Table 2. zxsuite backup
Command Description Usage

doAccountScan

Perform a Smart Scan on a single account

zxsuite backup doAccountScan {account} [attr1 value1 [attr2 value2…​]]

doBackupCluster

Perform a backup of Cluster

zxsuite backup doBackupCluster

doBackupLDAP

Perform a backup of LDAP

zxsuite backup doBackupLDAP

doBackupServerCustomizations

Perform a backup of customizations

zxsuite backup doBackupServerCustomizations

doCheckShares

Check all shares on local accounts

zxsuite backup doCheckShares

doCoherencyCheck

Check backup coherency

zxsuite backup doCoherencyCheck {backup_path} [attr1 value1 [attr2 value2…​]]

doEnableDisableCOS

Enable or disable the backup for a specific COS

zxsuite backup doEnableDisableCOS {cos_name} {enable|disable}

doExport

Perform an Export limited by domains

zxsuite backup doExport {destination_path} [attr1 value1 [attr2 value2…​]]

doExternalRestore

Perform an External Restore

zxsuite backup doExternalRestore {source_path} [attr1 value1 [attr2 value2…​]]

doFixOrphans

Delete orphan digest files

zxsuite backup doFixOrphans [attr1 value1 [attr2 value2…​]]

doFixShares

Try to fix all shares on local accounts

zxsuite backup doFixShares {import_idmap_file}

doItemRestore

Restores a single item

zxsuite backup doItemRestore {account_name} {item_id} [attr1 value1 [attr2 value2…​]]

doItemSearch

Search for an item

zxsuite backup doItemSearch {account} [attr1 value1 [attr2 value2…​]]

doPurge

Perform a Purge Operation

zxsuite backup doPurge [attr1 value1 [attr2 value2…​]]

doRawRestore

Perform a raw restore [BETA]

zxsuite backup doRawRestore {source_path} [attr1 value1 [attr2 value2…​]]

doRestartService

restart a given service

zxsuite backup doRestartService {service_name}

doRestoreBlobs

Start a restore blobs operation which tries to restore broken zimbra blobs

zxsuite backup doRestoreBlobs {volume_id} [attr1 value1 [attr2 value2…​]]

doRestoreOnNewAccount

Perform a Restore on New Account

zxsuite backup doRestoreOnNewAccount {Account name or id} {destination_account} {"dd/MM/yyyy HH:mm:ss"|last} [attr1 value1 [attr2 value2…​]]

doSmartScan

Perform a Smart Scan

zxsuite backup doSmartScan [attr1 value1 [attr2 value2…​]]

doStartService

start a given service

zxsuite backup doStartService {service_name}

doStopAllOperations

Stops all running operations and empties the operations queue

zxsuite backup doStopAllOperations

doStopOperation

Stop a single running operation

zxsuite backup doStopOperation {operation_uuid}

doStopService

stop a given service

zxsuite backup doStopService {service_name}

doUndelete

Perform an Undelete Restore

zxsuite backup doUndelete {account} {"dd/MM/yyyy HH:mm:ss"|first} {"dd/MM/yyyy HH:mm:ss"|last} [attr1 value1 [attr2 value2…​]]

getAccountInfo

Shows an account’s information

zxsuite backup getAccountInfo {account} [attr1 value1 [attr2 value2…​]]

getAllOperations

Displays all running and queued operations

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

getAvailableAccounts

Displays all accounts available for restore

zxsuite backup getAvailableAccounts [attr1 value1 [attr2 value2…​]]

getAvailableDomains

Displays all domains available for restore

zxsuite backup getAvailableDomains {dd/MM/yyyy HH:mm:ss|"last"} {backup_path}

getBackupInfo

Displays informations about the backup system

zxsuite backup getBackupInfo [attr1 value1 [attr2 value2…​]]

getCOSBackupStatus

Displays the backup status of all COS

zxsuite backup getCOSBackupStatus [attr1 value1 [attr2 value2…​]]

getItem

Display an item in a human-readable format.

zxsuite backup getItem {account} {item} [attr1 value1 [attr2 value2…​]]

getMap

Show binary Map<String, String> object as human readable table

zxsuite backup getMap {file_path}

getProperty

Get configuration properties

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

getServerConfig

Provides a list of stored server configs

zxsuite backup getServerConfig {standard|customizations} [attr1 value1 [attr2 value2…​]]

getServices

show current status of all services for this module

zxsuite backup getServices

monitor

Monitor a running operation

zxsuite backup monitor {operation_uuid} [attr1 value1 [attr2 value2…​]]

setProperty

Set configuration property

zxsuite backup setProperty {property_name} {property_value}

Mobile CLI

zxsuite mobile

Table 3. zxsuite mobile
Command Description Usage

ABQ

Allow/Block/Quarantine mobile devices management

zxsuite mobile ABQ

doAddAccountLogger

Add an account logger

zxsuite mobile doAddAccountLogger {account} {debug|info|warn|err|crit} {log_file} [attr1 value1 [attr2 value2…​]]

doAddEASFilter

Adds a rule to specify which Exchange Active Sync versions can be used with a user agent

zxsuite mobile doAddEASFilter {and|or|regex|contains|account} {text|people@example.com|account=example@ff.com,contains=android} {add|subtract|fixed|limit} {easversions} [attr1 value1 [attr2 value2…​]]

doDeleteEASFilter

Removes an EAS version filter

zxsuite mobile doDeleteEASFilter {id}

doMoveEASFilter

Change the apply order of EAS filter.

zxsuite mobile doMoveEASFilter {from} {to}

doRemoveDevice

Removes all the device’s SyncState and history from the server

zxsuite mobile doRemoveDevice {account} {device_id}

doRemoveLogger

Removes an account logger

zxsuite mobile doRemoveLogger {logger_id|"all_loggers"}

doResetAccount

Reset ALL device states for the provided account

zxsuite mobile doResetAccount {account}

doResetDevice

Resets the device’s SyncState for a single account

zxsuite mobile doResetDevice {account} [attr1 value1 [attr2 value2…​]]

doRestartService

restart a given service

zxsuite mobile doRestartService {service_name}

doResumeDeviceSync

Resumes the device’s synchronization after it has been suspended

zxsuite mobile doResumeDeviceSync {account} [attr1 value1 [attr2 value2…​]]

doSimulateSync

Simulate a Sync command for each synchronization state of the device

zxsuite mobile doSimulateSync {account} {LG8955c3fa9|new} [attr1 value1 [attr2 value2…​]]

doStartService

start a given service

zxsuite mobile doStartService {service_name}

doStopService

stop a given service

zxsuite mobile doStopService {service_name}

doSuspendDeviceSync

Suspends the device’s synchronization

zxsuite mobile doSuspendDeviceSync {account} {device_id}

doWipeDevice

Wipes a device

zxsuite mobile doWipeDevice {account} {device_id} [attr1 value1 [attr2 value2…​]]

getAccountLoggers

Returns informations about all account loggers

zxsuite mobile getAccountLoggers

getAccountMobilePassword

Get the ZeXtras Mobile password information

zxsuite mobile getAccountMobilePassword {account}

getAllDevices

Get all mobile devices

zxsuite mobile getAllDevices

getAllEASFilters

Shows the list of currently set EAS version filters

zxsuite mobile getAllEASFilters

getDeviceInfo

Display information about the provided device

zxsuite mobile getDeviceInfo {account} {device_id} [attr1 value1 [attr2 value2…​]]

getDeviceList

Display all devices for the provided account

zxsuite mobile getDeviceList {account}

getProperty

Get configuration properties

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

getProvisioning

Shows one or all mobile provisioning attributes values for the specified target

zxsuite mobile getProvisioning {account|cos} {target} [attr1 value1 [attr2 value2…​]]

getServices

show current status of all services for this module

zxsuite mobile getServices

setAccountMobilePassword

Sets the ZeXtras Mobile mobile password

zxsuite mobile setAccountMobilePassword {account} {password}

setProperty

Set configuration property

zxsuite mobile setProperty {property_name} {property_value}

setProvisioning

Sets a mobile provisioning attribute

zxsuite mobile setProvisioning {account|cos} {target} {key} {value}

setSharedFolderSync

enable/disable shared folder mobile synchronization

zxsuite mobile setSharedFolderSync {account} {item_id} {true|false}

unsetAccountMobilePassword

Unset the ZeXtras Mobile password

zxsuite mobile unsetAccountMobilePassword {account}

Powerstore CLI

zxsuite powerstore

Table 4. zxsuite powerstore
Command Description Usage

+setHsmPolicy

Add an additional policy to HSM.

zxsuite powerstore +setHsmPolicy {hsm_policy}

doCheckBlobs

Start the doCheckBlobs operation.

zxsuite powerstore doCheckBlobs {start} [attr1 value1 [attr2 value2…​]]

doCreateVolume

Create a volume on the server

zxsuite powerstore doCreateVolume

doDeduplicate

Start a deduplication operation.

zxsuite powerstore doDeduplicate {volume_name} [attr1 value1 [attr2 value2…​]]

doDeleteVolume

Delete a specific volume on the server

zxsuite powerstore doDeleteVolume {volume_name}

doMailboxMove

Perform a Mailbox Move on a single account or a domain. In order to remove orphaned mailboxes you should run the command 'zxsuite powerstore doPurgeMailboxes all ignore_retention true'.

zxsuite powerstore doMailboxMove {destinationHost} [attr1 value1 [attr2 value2…​]]

doMoveBlobs

Start the doMoveBlob operation.

zxsuite powerstore doMoveBlobs [attr1 value1 [attr2 value2…​]]

doPurgeMailboxes

Delete all leftover data of a mailbox that has been moved to another server

zxsuite powerstore doPurgeMailboxes {Mailbox id or "all" to delete all mailboxes moved more than 30 days ago} [attr1 value1 [attr2 value2…​]]

doRemoveHsmPolicy

Remove a policy from HSM.

zxsuite powerstore doRemoveHsmPolicy {hsm_policy}

doRemoveOrphanedBlobs

remove orphaned blobs

zxsuite powerstore doRemoveOrphanedBlobs [attr1 value1 [attr2 value2…​]]

doRestartService

restart a given service

zxsuite powerstore doRestartService {service_name}

doStartService

start a given service

zxsuite powerstore doStartService {service_name}

doStopAllOperations

Stops all running operations and empties the operations queue

zxsuite powerstore doStopAllOperations

doStopOperation

Stop a single running operation

zxsuite powerstore doStopOperation {operation_uuid}

doStopService

stop a given service

zxsuite powerstore doStopService {service_name}

doUpdateVolume

Update a specific volume on the server

zxsuite powerstore doUpdateVolume

doVolumeToVolumeMove

Start the doMoveVolumeBlobs operation.

zxsuite powerstore doVolumeToVolumeMove {source_volume_name} {destination_volume_name} [attr1 value1 [attr2 value2…​]]

getAllOperations

Displays all running and queued operations

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

getAllVolumes

Prints all the volumes present in the server

zxsuite powerstore getAllVolumes

getHsmPolicy

Prints all the policies

zxsuite powerstore getHsmPolicy

getMovedMailboxes

Get list of mailboxes moved and no more used

zxsuite powerstore getMovedMailboxes

getProperty

Get configuration properties

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

getServices

show current status of all services for this module

zxsuite powerstore getServices

getVolumeStats

Show space occupation, number of items and blobs contained in a volume

zxsuite powerstore getVolumeStats {volume_name} [attr1 value1 [attr2 value2…​]]

monitor

Monitor a running operation

zxsuite powerstore monitor {operation_uuid} [attr1 value1 [attr2 value2…​]]

runBulkDelete

Run bulk delete requests

zxsuite powerstore runBulkDelete [attr1 value1 [attr2 value2…​]]

setHSMPolicy

Set the default HSM policy

zxsuite powerstore setHSMPolicy {hsm_policy}

setProperty

Set configuration property

zxsuite powerstore setProperty {property_name} {property_value}

testS3Connection

Test the connection to an S3 bucket.

zxsuite powerstore testS3Connection {s3BucketConfigurationUuid}

Admin CLI

zxsuite admin

Table 5. zxsuite admin
Command Description Usage

doAddDelegationSettings

Adds a delegation privilege for a user on a domain

zxsuite admin doAddDelegationSettings {account} {domain} [attr1 value1 [attr2 value2…​]]

doEditDelegationSettings

Edits the delegation privileges for a user on a domain

zxsuite admin doEditDelegationSettings {account} {domain} [attr1 value1 [attr2 value2…​]]

doExportQuotaHistory

Export multiple monthly quota usage information both in text and json form

zxsuite admin doExportQuotaHistory {users|domains} {json|csv} {file_path} [attr1 value1 [attr2 value2…​]]

doMigrateAdmin

update the configuration of rights

zxsuite admin doMigrateAdmin [attr1 value1 [attr2 value2…​]]

doMonthlyReport

Generate a report of admin activity in the specified month

zxsuite admin doMonthlyReport [attr1 value1 [attr2 value2…​]]

doRemoveDelegationSettings

Removes a delegation privilege for a user on a domain

zxsuite admin doRemoveDelegationSettings {account} {domain}

doRepairAdmin

Repair Admin delegation and domain setting

zxsuite admin doRepairAdmin

doRestartService

restart a given service

zxsuite admin doRestartService {service_name}

doSetZimletRights

Fixes the administrative zimlet rights for all delegated admins.

zxsuite admin doSetZimletRights

doShowAdminActivity

Shows all recorded admin activity

zxsuite admin doShowAdminActivity [attr1 value1 [attr2 value2…​]]

doStartService

start a given service

zxsuite admin doStartService {service_name}

doStopAllOperations

Stops all running operations and empties the operations queue

zxsuite admin doStopAllOperations

doStopOperation

Stop a single running operation

zxsuite admin doStopOperation {operation_uuid}

doStopService

stop a given service

zxsuite admin doStopService {service_name}

getAllOperations

Displays all running and queued operations

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

getDelegationSettings

Shows delegated admins with their domains of competency, the viewMail attribute and the admin-assignable quota

zxsuite admin getDelegationSettings [attr1 value1 [attr2 value2…​]]

getDomainSettings

Shows all domains' name, account number limit, and max account quota

zxsuite admin getDomainSettings

getMonthlyReport

Shows a report of admin activity in the specified month

zxsuite admin getMonthlyReport [attr1 value1 [attr2 value2…​]]

getProperty

Get configuration properties

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

getServices

show current status of all services for this module

zxsuite admin getServices

monitor

Monitor a running operation

zxsuite admin monitor {operation_uuid} [attr1 value1 [attr2 value2…​]]

resetDomainSettings

Resets global account limit, account limit per cos, and domain account quota for the selected domain

zxsuite admin resetDomainSettings {domain}

setDomainSettings

Sets domain max account quota and account limit

zxsuite admin setDomainSettings {domain} [attr1 value1 [attr2 value2…​]]

setProperty

Set configuration property

zxsuite admin setProperty {property_name} {property_value}

Drive CLI

zxsuite drive

Table 6. zxsuite drive
Command Description Usage

doStartService

start a given service

zxsuite drive doStartService {service_name}

doStopService

stop a given service

zxsuite drive doStopService {service_name}

getServices

show current status of all services for this module

zxsuite drive getServices

doRestartService

restart a given service

zxsuite drive doRestartService {service_name}

doImport

Import Briefcase files and folders into Drive

zxsuite drive doImport {john@example.com,test.com[,…​]} [attr1 value1 [attr2 value2…​]]

doDeployDriveZimlet

Deploy ZeXtras Suite Drive zimlet

zxsuite drive doDeployDriveZimlet

monitor

Monitor a running operation

zxsuite drive monitor {operation_uuid} [attr1 value1 [attr2 value2…​]]

Docs CLI

zxsuite docs

Table 7. zxsuite docs
Command Description Usage

doReloadConfig

reload docs configuration from ldap, which would happen once a minute.

zxsuite docs doReloadConfig

doRestartService

restart a given service

zxsuite docs doRestartService {service_name}

doStartService

start a given service

zxsuite docs doStartService {service_name}

doStopService

stop a given service

zxsuite docs doStopService {service_name}

getServices

show current status of all services for this module

zxsuite docs getServices

status

show zimbra docs servers status with their resource usage (if connected).

zxsuite docs status