ZxBackup CLI Commands
zxsuite backup doAccountScan
zxsuite backup doAccountScan *account* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
acc ount(M) |
Account Name/ID |
||
deep(O) |
Boolean |
true|false |
false |
n otifications(O) |
Email Address |
||
remote_met adata_upload(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doAccountScan john@example.com deep true
Performs a deep scan of the account john@example.com
zxsuite backup doBackupAuthToken
zxsuite backup doBackupAuthToken *start* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
action(M) |
String |
start |
|
remote_met adata_upload(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doBackupAuthToken
zxsuite backup doBackupChat
zxsuite backup doBackupChat *start*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
action(M) |
String |
start |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doBackupChat
zxsuite backup doBackupCluster
zxsuite backup doBackupCluster *start* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
action(M) |
String |
start |
|
remote_met adata_upload(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doBackupCluster
zxsuite backup doBackupLDAP
zxsuite backup doBackupLDAP *start* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
action(M) |
String |
start |
|
remote_met adata_upload(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doBackupLDAP
zxsuite backup doBackupServerCustomizations
zxsuite backup doBackupServerCustomizations *start* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
action(M) |
String |
start |
|
remote_met adata_upload(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doBackupServerCustomizations
zxsuite backup doCoherencyCheck
zxsuite backup doCoherencyCheck *backup_path* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
bac kup_path(M) |
Path |
||
accountIds(O) |
String[,..] |
all |
|
checkZimbra(O) |
Boolean |
true|false |
false |
fixBackup(O) |
Boolean |
true|false |
false |
n otifications(O) |
Email Address[,..] |
||
f ixDoubleGzip(O) |
String |
skip|check|fix |
skip |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doCoherencyCheck /opt/zimbra/backup/zextras/ accountIds d10759b2-58d3-48fc-b587-93d507340c79,9e6f4a6d-4b3c-41e9-a5e4-06f9eee136ad
Performs a coherency check on /opt/zimbra/backup/zextras/ for Jack’s and John’s accounts
Usage Example
zxsuite backup doCoherencyCheck /opt/zimbra/backup/zextras/ fixBackup true
Performs a coherency check on /opt/zimbra/backup/zextras/ and moves corrupted backup files and blob files not referenced by any metadata out of backup
zxsuite backup doEnableDisableCOS
zxsuite backup doEnableDisableCOS *cos_name* *enable|disable*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
** cos_name**(M) |
String |
||
c os_state(M) |
String |
enable|disable |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doEnableDisableCOS mainCOS disable
Disables backup on the mainCOS class of service
zxsuite backup doExport
zxsuite backup doExport *destination_path* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
destinat ion_path(M) |
Path |
||
domains(O) |
Domain Name[,..] |
all |
|
cos(O) |
String[,..] |
all |
|
n otifications(O) |
Email Address[,..] |
||
threshold(O) |
Long |
||
read_err or_threshold(O) |
Integer |
||
skip_items(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doExport /opt/zimbra/backup/ domains example.com notifications john@example.com
Exports a backup of example.com to /opt/zimbra/backup/ and notifies john@example.com
Threshold is expressed in MB
zxsuite backup doExternalRestore
zxsuite backup doExternalRestore *source_path* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
sou rce_path(M) |
Path |
||
accounts(O) |
Account Name[,..] |
all |
|
input_file(O) |
String |
list of accounts, one per line |
|
domains(O) |
Domain Name[,..] |
all |
|
fi lter_deleted(O) |
Boolean |
true|false |
true |
skip_sys tem_accounts(O) |
Boolean |
true|false |
true |
skip_aliases(O) |
Boolean |
true|false |
false |
skip_distri bution_lists(O) |
Boolean |
true|false |
false |
skip_coses(O) |
Boolean |
true|false |
false |
skip_account_p rovisioning(O) |
Boolean |
true|false |
false |
skip_domain_p rovisioning(O) |
Boolean |
true|false |
false |
provi sioning_only(O) |
Boolean |
true|false |
false |
n otifications(O) |
Email Address |
||
concurr ent_accounts(O) |
Integer |
||
m ax_file_size(O) |
Integer |
||
restor e_datasource(O) |
Boolean |
true|false |
true |
force_as_exte rnal_restore(O) |
Boolean |
true|false |
false |
b lobs_archive(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doExternalRestore /path/to/data/ accounts john@example.com,jack@example.com domains example.com filter_deleted false skip_system_accounts false
Restores the example.com domain, including all system accounts, and the john@example.com and jack@example.com accounts from a backup located in /path/to/data/
zxsuite backup doItemRestore
zxsuite backup doItemRestore *Account name or id* *item_id* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
Account Name/ID |
Account name or id |
|
item_id (M) |
String |
||
date(O) |
Date |
“dd/MM/yyyy HH:mm:ss” | last |
|
restore_folder(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doItemRestore john@example.com 4784
zxsuite backup doItemRestore 968df11c-8f8b-429a-9f29-4503d08544b3 5923
The first command restores item 4784 in the john@example.com
mailbox; while the second restores item 5923 in the
968df11c-8f8b-429a-9f29-4503d08544b3 mailbox
zxsuite backup doItemSearch
zxsuite backup doItemSearch *account* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
acc ount(M) |
Account Name/ID |
||
backup_path(O) |
String |
||
id(O) |
String |
||
s earch_string(O) |
String |
“Case sensitive string” |
|
type(O) |
Multiple choice |
message | conta ct | folder | document | all |
message |
before(O) |
Date |
“dd/MM/yyyy HH:mm:ss” |
|
after(O) |
Date |
“dd/MM/yyyy HH:mm:ss” |
|
raw_metadata(O) |
Boolean |
true | false |
false |
s earch_filter(O) |
Multiple choice |
all | delet ed | not_deleted |
deleted |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doItemSearch john@example.com type message
Shows all of John’s deleted emails which still are in the backup
zxsuite backup doPurge
zxsuite backup doPurge [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
purgeDays(O) |
String |
||
backup_path(O) |
Path |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doPurge purgeDays 30 backup_path /opt/zimbra/backup/backup_name
zxsuite backup doRawRestore
zxsuite backup doRawRestore *source_path* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
sou rce_path(M) |
String |
||
n otifications(O) |
Email Address[,..] |
||
skip Provisioning(O) |
Boolean |
true|false |
false |
delete WhenConflict(O) |
Boolean |
true|false |
false |
skipVolumes(O) |
Boolean |
true|false |
false |
domains(O) |
String[,..] |
all |
|
threads(O) |
Integer |
4 |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doRawRestore /my/backup/path notifications user1@example.com,user2@example.com skipProvisioning false deleteWhenConflict false skipVolumes true
Performs raw restore without provisioning nor deleting a mailbox when id are conflicting, nor restoring volumes and sends notifications to user1@example.com and user2@example.com
The raw restore operation does not perform blob restore, use doRestoreBlobs when needed.
zxsuite backup doRestartService
zxsuite backup doRestartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doRestartService
zxsuite backup doRestoreBlobs
zxsuite backup doRestoreBlobs *volume_id* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
volume_id(M) |
String |
||
backup_path(O) |
String |
||
dryrun(O) |
Boolean |
true|false |
true |
threads(O) |
Integer |
4 |
|
items(O) |
String |
z imbra|drive|all |
all |
blobs_archive(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doRestoreBlobs 1 dryrun true
Run a restore blob operation on volume 1 without actually restoring data.
Usage Example
zxsuite backup doRestoreBlobs 3 dryrun false compress false
zxsuite backup doRestoreOnNewAccount
zxsuite backup doRestoreOnNewAccount Account name or id destination_account "dd/MM/yyyy HH:mm:ss"|last [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
source_account(M) |
String |
Account name or id |
|
destination_account(M) |
Account Name/ID |
||
date(M) |
Date |
“dd/MM/yyyy HH:mm:ss”| last |
last |
restore_chat_buddies(O) |
Boolean |
true | false |
|
apply_hsm(O) |
Boolean |
true | false |
|
notifications(O) |
Email Address[,..] |
||
restore_datasource(O) |
Boolean |
true|false |
true |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doRestoreOnNewAccount john@example.com john_restored@example.com "28/09/2012 10:15:10"
Restores the john@example.com account in a new account named john_restored@example.com
zxsuite backup doSmartScan
zxsuite backup doSmartScan *start* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
action(M) |
String |
start |
|
n otifications(O) |
Email Address[,..] |
||
read_err or_threshold(O) |
Integer |
||
deep(O) |
Boolean |
true|false |
|
remote_met adata_upload(O) |
Boolean |
true|false |
false |
crea te_fake_blob(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doSmartScan notifications user1@example.com,user2@example.com
Performs a smart scan and sends notifications to user1@example.com and user2@example.com
zxsuite backup doStartService
zxsuite backup doStartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doStartService
zxsuite backup doStopAllOperations
zxsuite backup doStopAllOperations
Usage Example
zxsuite backup doStopAllOperations
Stops all running operations
zxsuite backup doStopOperation
zxsuite backup doStopOperation *operation_uuid*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
operat ion_uuid(M) |
Uuid |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doStopOperation 30ed9eb9-eb28-4ca6-b65e-9940654b8601
Stops operation with id - 30ed9eb9-eb28-4ca6-b65e-9940654b8601
zxsuite backup doStopService
zxsuite backup doStopService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doStopService
zxsuite backup doUndelete
zxsuite backup doUndelete *account* *"dd/MM/yyyy HH:mm:ss"|first*
*"dd/MM/yyyy HH:mm:ss"|last* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
Account Name/ID |
||
start_date(M) |
Date |
“dd/MM/yyyy HH:mm:ss”| first |
|
end_date(M) |
Date |
“dd/MM/yyyy HH:mm:ss”| last |
|
target_original_folder(O) |
Boolean |
true|false |
true |
apply_hsm(O) |
Boolean |
true|false |
|
notifications(O) |
Email Address[,..] |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup doUndelete john@example.com "08/10/2012 10:15:00" last
zxsuite backup doUndelete John ``08/10/2020 10:15:00`` last target_original_folder false
The first command performs an undelete on John’s account of all items
created between 08/10/2012 10:15:00 and the latest data available and
restores them in John’s mailbox, tagged with undelete_04_05_21.
The second command carries out exactly the same operation, but the items will be restored under a separate folder in John’s mailbox.
zxsuite backup getAccountInfo
zxsuite backup getAccountInfo *account* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
acc ount(M) |
Account Name/ID |
||
backup_path(O) |
Path |
||
date(O) |
Multiple choice |
“dd/MM/yyyy HH:mm:ss” | m ost_recent | lea ast_recent | all |
most_recent |
backupstats(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup getAccountInfo john@example.com
Displays info about the account john@example.com
Usage Example
zxsuite backup getAccountInfo 04b4bfbe-6675-43eb-b5ea-098b4681869e
Displays info for the account with id 04b4bfbe-6675-43eb-b5ea-098b4681869e
zxsuite backup getAllOperations
zxsuite backup 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 backup getAllOperations
Shows all running and queued operations
zxsuite backup getAvailableAccounts
zxsuite backup getAvailableAccounts [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
date(O) |
Date |
“dd/MM/yyyy HH:mm:ss” | last |
last |
backup_path(O) |
Path |
||
domains(O) |
Domain Name[,..] |
all |
|
hide_deleted(O) |
Boolean |
true|false |
false |
hide_sys tem_accounts(O) |
Boolean |
true|false |
true |
hide_exist ing_accounts(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup getAvailableAccounts date last backup_path /opt/zimbra/backup/zextras/ hide_deleted false
Shows all accounts in the last backup, showing deleted accounts as well
zxsuite backup getAvailableDomains
zxsuite backup getAvailableDomains *dd/MM/yyyy HH:mm:ss|"last"*
*backup_path*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
date(M) |
Date |
dd/MM/yyyy HH:mm:ss|”last” |
|
bac kup_path(M) |
Path |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup getAvailableDomains last /opt/zimbra/backup/export
Shows all domains in the last backup
zxsuite backup getBackupInfo
zxsuite backup getBackupInfo [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
backup_path(O) |
Path |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup getBackupInfo /opt/zimbra/backup/zextras/
Shows all information about the backup directory ‘/opt/zimbra/backup/zextras/’
zxsuite backup getCOSBackupStatus
zxsuite backup getCOSBackupStatus [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
cos_name(O) |
String |
all |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup getCOSBackupStatus
Shows all the classes of service and their ZxBackup status
zxsuite backup getItem
zxsuite backup getItem *account* *item* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
acc ount(M) |
Account Name/ID |
||
item(M) |
String |
||
backup_path(O) |
Path |
||
dump_blob(O) |
Boolean |
true|false |
false |
date(O) |
Date |
dd/mm/yyyy hh:mm:ss|all |
last |
b lobs_archive(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup getItem a7300a00-56ec-46c3-9773-c6ef7c4f3636 1
Shows item with id - 1 belonging to account a7300a00-56ec-46c3-9773-c6ef7c4f3636
zxsuite backup getMap
zxsuite backup getMap *file_path*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
f ile_path(M) |
Path |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup getMap /opt/zimbra/backup/zextras/map_544d94c6-aaef-4736-8964-56a667f1fe12
Shows the item backup map
zxsuite backup getProperty Deprecated
zxsuite backup 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 backup getProperty
Warning
This command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]
zxsuite backup getServerConfig
zxsuite backup getServerConfig *standard|customizations* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
type(M) |
Multiple choice |
standard | customizations |
|
date(O) |
String |
“dd/MM/yyyy HH:mm:ss” | “last” | “all” |
|
backup_path(O) |
Path |
||
file(O) |
String |
Path to backup file |
|
query(O) |
String |
type/id/key |
|
verbose(O) |
String |
false |
|
colors(O) |
String |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup getServerConfig standard date last
Display a summary of the latest backup data for Server and Global configuration.
Usage Example
zxsuite backup getServerConfig standard date last query /
Display the latest backed up server and global configuration settings.
Usage Example
zxsuite backup getServerConfig standard file /path/to/backup/file
Display the contents of a backup file instead of the current server backup.
Usage Example
zxsuite backup getServerConfig standard date last query zimlets/com_zimbra_ymemoticons colors true verbose true
Displays all settings for the com_zimbra_ymemoticons zimlet, using colored output and high verbosity.
zxsuite backup getServices
zxsuite backup getServices
Usage Example
zxsuite backup getServices
zxsuite backup migrateBackupVolume Default
zxsuite backup migrateBackupVolume Default *start*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
action(M) |
String |
start |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup migrateBackupVolume Default start
zxsuite backup migrateBackupVolume Local
zxsuite backup migrateBackupVolume Local *path* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
path(M) |
String |
||
threads(O) |
Integer |
10 |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup migrateBackupVolume Local /path/to/directory
zxsuite backup migrateBackupVolume S3
zxsuite backup migrateBackupVolume S3 [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
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 |
|
threads(O) |
Integer |
10 |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup migrateBackupVolume S3 bucket_configuration_id {uuid}
zxsuite backup monitor
zxsuite backup 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 backup monitor
zxsuite backup retrieveMetadataFromArchive Local
zxsuite backup retrieveMetadataFromArchive Local *source*
*destination* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
source(M) |
String |
||
des tination(M) |
String |
||
threads(O) |
Integer |
10 |
|
n otifications(O) |
Email Address |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup retrieveMetadataFromArchive Local /path/to/source/directory /path/to/destination/directory
zxsuite backup retrieveMetadataFromArchive S3
zxsuite backup retrieveMetadataFromArchive S3 *destination* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
des tination(M) |
String |
||
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) |
|
threads(O) |
Integer |
10 |
|
n otifications(O) |
Email Address |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup retrieveMetadataFromArchive S3 /path/to/destination/directory bucket_configuration_id {uuid} volume_prefix {path}
zxsuite backup setBackupVolume Default
zxsuite backup setBackupVolume Default *start*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
action(M) |
String |
start |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup setBackupVolume Default start
zxsuite backup setBackupVolume Local
zxsuite backup setBackupVolume Local *path*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
path(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup setBackupVolume Local /path/to/directory
zxsuite backup setBackupVolume S3
zxsuite backup setBackupVolume S3 [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
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 |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup setBackupVolume S3 bucket_configuration_id {uuid} volume_prefix {path}
zxsuite backup setProperty Deprecated
zxsuite backup 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 backup setProperty
Warning
This command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]
zxsuite backup updateBackupVolume S3
zxsuite backup updateBackupVolume S3 [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
use-infre quent-access(O) |
Boolean |
true|false |
|
infrequent-acce ss-threshold(O) |
String |
64 KB |
|
use-intelli gent-tiering(O) |
Boolean |
true|false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite backup updateBackupVolume S3 use-infrequent-access true infrequent-access-threshold 1GB
Sets infrequent access storage class for new backup blobs whose size is bigger than 1GB
Usage Example
zxsuite backup updateBackupVolume S3 use-intelligent-tiering true
Sets intelligent tiering storage class for all new backup blobs