Zextras Backup CLI

zxsuite backup

Table 1. Zextras Backup CLI
Name Description Usage

doAccountScan

Perform a Smart Scan on a single account

zxsuite backup doAccountScan [object Object] [attr1 value1 [attr2 value2…​]]

doBackupAuthToken

Perform a backup of authentication tokens

zxsuite backup doBackupAuthToken [object Object] [attr1 value1 [attr2 value2…​]]

doBackupChat

Perform a backup of Zextras Team data

zxsuite backup doBackupChat [object Object]

doBackupCluster

Perform a backup of Cluster

zxsuite backup doBackupCluster [object Object] [attr1 value1 [attr2 value2…​]]

doBackupLDAP

Perform a backup of LDAP

zxsuite backup doBackupLDAP [object Object] [attr1 value1 [attr2 value2…​]]

doBackupServerCustomizations

Perform a backup of customizations

zxsuite backup doBackupServerCustomizations [object Object] [attr1 value1 [attr2 value2…​]]

doCheckShares

Check all shares on local accounts

zxsuite backup doCheckShares [object Object]

doCoherencyCheck

Check backup coherency

zxsuite backup doCoherencyCheck [object Object] [attr1 value1 [attr2 value2…​]]

doEnableDisableCOS

Enable or disable the backup for a specific COS

zxsuite backup doEnableDisableCOS [object Object] {enable|disable}

doExport

Perform an Export limited by domains

zxsuite backup doExport [object Object] [attr1 value1 [attr2 value2…​]]

doExternalRestore

Perform an External Restore

zxsuite backup doExternalRestore [object Object] [attr1 value1 [attr2 value2…​]]

doFixShares

Try to fix all shares on local accounts

zxsuite backup doFixShares [object Object]

doItemRestore

Restores a single item

zxsuite backup doItemRestore [object Object] [object Object] [attr1 value1 [attr2 value2…​]]

doItemSearch

Search for an item

zxsuite backup doItemSearch [object Object] [attr1 value1 [attr2 value2…​]]

doPurge

Perform a Purge Operation

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

doRestartService

restart a given service

zxsuite backup doRestartService [object Object]

doRestoreBlobs

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

zxsuite backup doRestoreBlobs [object Object] [attr1 value1 [attr2 value2…​]]

doRestoreOnNewAccount

Perform a Restore on New Account

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

doSmartScan

Perform a Smart Scan

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

doStartService

start a given service

zxsuite backup doStartService [object Object]

doStopAllOperations

Stops all running operations and empties the operations queue

zxsuite backup doStopAllOperations

doStopOperation

Stop a single running operation

zxsuite backup doStopOperation [object Object]

doStopService

stop a given service

zxsuite backup doStopService [object Object]

doUndelete

Perform an Undelete Restore

zxsuite backup doUndelete [object Object] {"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 [object Object] [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 Note: In case a domain does not exist, a warning message will be shown

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

getAvailableDomains

Displays all domains available for restore

zxsuite backup getAvailableDomains {dd/MM/yyyy HH:mm:ss|"last"} [object Object]

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 [object Object] [object Object] [attr1 value1 [attr2 value2…​]]

getMap

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

zxsuite backup getMap [object Object]

getProperty

Get configuration properties Warning: this command is deprecated

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

migrateBackupVolume

Migrate backup volume to a new volume

zxsuite backup migrateBackupVolume

monitor

Monitor a running operation

zxsuite backup monitor [object Object] [attr1 value1 [attr2 value2…​]]

retrieveMetadataFromArchive

Retrieve metadata archives

zxsuite backup retrieveMetadataFromArchive

setBackupVolume

Set backup volume location

zxsuite backup setBackupVolume

setProperty

Set configuration property Warning: this command is deprecated

zxsuite backup setProperty [object Object] [object Object]