Zextras CLI

This sections describes zxsuite, the Command Line Interface to the administration of a Zextras installation. The zxsuite usage is introduced in the next section, Basic Usage, then the list of all commands with details and all options follows in section Commands Full reference.

Basic Usage

Every module of Zextras Suite, 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

Commands Full reference

ZxAdmin CLI Commands

doAddDelegationSettings

zxsuite admin doAddDelegationSettings account domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

domain(M)

String

viewMail(O)

Boolean

true|false

false

editFeatures(O)

Boolean

true|false

false

adminQuota(O)

String

-1

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

Example:
zxsuite admin doAddDelegationSettings john@example.com example.com viewMail true adminQuota -1

Adds John as delegated administrator of domain example.com, with the right to view user mail on such domain and

no right to grand quotas to users.

Example:
zxsuite admin doAddDelegationSettings john@example.com example.com adminQuota 0

Adds John as delegated administrator of domain example.com, with the right to assign unlimited quotas to users.

Example:
zxsuite admin doAddDelegationSettings john@example.com example.com adminQuota 10gb

Adds John as delegated administrator of domain example.com, with the right to assign quotas up to 10gb to each user.

doEditDelegationSettings

zxsuite admin doEditDelegationSettings account domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

domain(M)

String

viewMail(O)

Boolean

true|false

editFeatures(O)

Boolean

true|false

adminQuota(O)

String

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

Example:
zxsuite admin doEditDelegationSettings john@example.com example.com viewMail true adminQuota -1

Edits John’s delegation rights for domain example.com, with the right to view user mail on such domain and

no right to grand quotas to users.

Example:
zxsuite admin doEditDelegationSettings john@example.com example.com adminQuota 0

Edits John’s delegation rights for domain example.com, with the right to assign unlimited quotas to users.

Example:
zxsuite admin doEditDelegationSettings john@example.com example.com adminQuota 10gb

Edits John’s delegation rights for domain example.com, with the right to assign quotas up to 10gb to each user.

doExportQuotaHistory

zxsuite admin doExportQuotaHistory users|domains json|csv file_path [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

data_type(M)

String

users|domains

output(M)

String

json|csv

file_path(M)

String

month(O)

String

99/9999

filterByName(O)

String

admin@example.com|example.com

fieldName(O)

String

totAccountsOnDomain|totUsedSpaceOnDomain|systemResourcesOnDomain|calendarResourcesOnDomain|totAccountsWithUnlimitedSpace|totAvailableSpaceOnDomain|totUsedSpaceOnDomainByUnlimitedUsers|maxAccountsOnDomain|spaceUsedAccounts

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

Example:
zxsuite admin doExportQuotaHistory

doMigrateAdmin

zxsuite admin doMigrateAdmin start [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

force(O)

Boolean

true|false

false

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

Example:
zxsuite admin doMigrateAdmin
Example:
zxsuite admin doMigrateAdmin force true

doMonthlyReport

zxsuite admin doMonthlyReport start [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

month(O)

String

mm/yyyy | previousMonth

previousMonth

force(O)

Boolean

true|false

false

notify_admins(O)

Boolean

true|false

false

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

Example:
zxsuite admin doMonthlyReport

Generates the monthly report for the previous month and saves it in the currentZextras Admin log path

Example:
zxsuite admin doMonthlyReport month 05/2021

Generates a PARTIAL monthly report for the current month, without saving it to disk.

  • NOTE**

This command is automatically executed once a month to generate a file containing the report for the

previous month. To overwrite an existing report file, set the 'force' parameter to true.

If you just want to display an existing report, use the zxsuite admin getMonthlyReport instead.

doRemoveDelegationSettings

zxsuite admin doRemoveDelegationSettings account domain

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

domain(M)

String

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

Example:
zxsuite admin doRemoveDelegationSettings john@example.com example.com

John no longer administers domain example.com

doRepairAdmin

zxsuite admin doRepairAdmin start

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

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

Example:
zxsuite admin doRepairAdmin

doRestartService

zxsuite admin doRestartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite admin doRestartService

doSetZimletRights

zxsuite admin doSetZimletRights

Example:
zxsuite admin doSetZimletRights

doShowAdminActivity

zxsuite admin doShowAdminActivity [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

admin(O)

Account Name/ID

action_name(O)

String

date_start(O)

Date

"dd/MM/yyyy HH:mm:ss"

date_end(O)

Date

"dd/MM/yyyy HH:mm:ss"

client_ip(O)

String

success(O)

Boolean

true|false

show_admin_logins(O)

Boolean

true|false

false

max_results(O)

Integer

1000

notification_mode(O)

Multiple choice

none|email|briefcase|both

none

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

Example:
zxsuite admin doShowAdminActivity admin john@example.com date_start 10/03/2013 notification_mode briefcase

Uploads a csv to the global admin’s briefcase containing all of John’s activity recorded after 10/03/2013.

Example:
zxsuite admin doShowAdminActivity admin john@example.com date_start 10/03/2013 notification_mode briefcase

Same as before, but shows results in CLI instead of uploading a csv file to briefcase.

doStartService

zxsuite admin doStartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite admin doStartService

doStopAllOperations

zxsuite admin doStopAllOperations

Example:
zxsuite admin doStopAllOperations

Stops all running operations

doStopOperation

zxsuite admin doStopOperation operation_uuid

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

operation_uuid(M)

Uuid

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

Example:
zxsuite admin doStopOperation 30ed9eb9-eb28-4ca6-b65e-9940654b8601

Stops operation with id = 30ed9eb9-eb28-4ca6-b65e-9940654b8601

doStopService

zxsuite admin doStopService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite admin doStopService

getAllOperations

zxsuite admin getAllOperations [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

verbose(O)

Boolean

true|false

false

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

Example:
zxsuite admin getAllOperations

Shows all running and queued operations

getDelegationSettings

zxsuite admin getDelegationSettings [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(O)

String

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

Example:
zxsuite admin getDelegationSettings

getDomainSettings

zxsuite admin getDomainSettings

Example:
zxsuite admin getDomainSettings

getMonthlyReport

zxsuite admin getMonthlyReport [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

month(O)

String

mm/yyyy | previousMonth

previousMonth

local(O)

Boolean

true|false

false

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

Example:
zxsuite admin getMonthlyReport

Shows the monthly report for the previous month

Example:
zxsuite admin getMonthlyReport month 10/2015

Shows the monthly report for the month '10/2015'.

  • NOTE**

This command reads the report files generated by the doMonthlyReport command, which is automatically executed once a month.

If no report exists for the specified month in the current Zextras Admin log path, this command will fail.

getProperty

zxsuite admin getProperty [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

verbose(O)

Boolean

true|false

property_name(O)

String[,..]

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

Example:
zxsuite admin getProperty
this command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]

getServices

zxsuite admin getServices

Example:
zxsuite admin getServices

monitor

zxsuite admin monitor operation_uuid [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

operation_uuid(M)

Uuid

operation_host(O)

String

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

Example:
zxsuite admin monitor

resetDomainSettings

zxsuite admin resetDomainSettings domain

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

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

Example:
zxsuite admin resetDomainSettings

setDomainSettings

zxsuite admin setDomainSettings domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

account_limit(O)

Integer

no action

domain_account_quota(O)

String

no action

reset_cos_limits(O)

String

cosname1:limit1,cosname2:limit2

no action

add_cos_limits(O)

String

cosname1:limit1,cosname2:limit2

no action

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

Example:
zxsuite admin setDomainSettings example.com account_limit 100 domain_account_quota 100mb reset_cos_limits cos1:30,cos2:80

Sets a global account limit on the domain example.com of 100 accounts, with a domain account quota of 100 megabytes,

and with cos account limits of 30 for cos1 and 80 for cos2 (removing other cos settings).

Example:
zxsuite admin setDomainSettings example.com add_cos_limits cos1:30

Sets cos account limits of 30 for cos1 (leaving other cos settings unchanged).

setProperty

zxsuite admin setProperty property_name property_value

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

property_name(M)

String

property_value(M)

String

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

Example:
zxsuite admin setProperty
this command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]

ZxAuth CLI Commands

credential add | credential delete | credential list | credential update | doDeployAuthZimlet | doRestartService | doStartService | doStopService | enforce2FA get account | enforce2FA get cos | enforce2FA set account | enforce2FA set cos | getServices | loginPage getBackgroundImage domain | loginPage getBackgroundImage global | loginPage getColorPalette domain | loginPage getColorPalette global | loginPage getConfig domain | loginPage getConfig global | loginPage getFavicon domain | loginPage getFavicon global | loginPage getLogo domain | loginPage getLogo global | loginPage getSkinLogoAppBanner domain | loginPage getSkinLogoAppBanner global | loginPage getSkinLogoURL domain | loginPage getSkinLogoURL global | loginPage getTitle domain | loginPage getTitle global | loginPage setBackgroundImage domain | loginPage setBackgroundImage global | loginPage setColorPalette domain | loginPage setColorPalette global | loginPage setFavicon domain | loginPage setFavicon global | loginPage setLogo domain | loginPage setLogo global | loginPage setSkinLogoAppBanner domain | loginPage setSkinLogoAppBanner global | loginPage setSkinLogoURL domain | loginPage setSkinLogoURL global | loginPage setTitle domain | loginPage setTitle global | policy list domain | policy list global | policy set Cli domain | policy set Cli global | policy set Dav domain | policy set Dav global | policy set EAS domain | policy set EAS global | policy set Imap domain | policy set Imap global | policy set MobileApp domain | policy set MobileApp global | policy set Pop3 domain | policy set Pop3 global | policy set Smtp domain | policy set Smtp global | policy set WebAdminUI domain | policy set WebAdminUI global | policy set WebUI domain | policy set WebUI global | policy set ZmWebUI domain | policy set ZmWebUI global | policy trustedDevice getExpiration domain | policy trustedDevice getExpiration global | policy trustedDevice setExpiration domain | policy trustedDevice setExpiration global | saml delete | saml get | saml import | saml update | saml validate | token invalidate | token list | totp delete | totp generate | totp list | trustedDevice delete | trustedDevice list

add

zxsuite auth credential add john@example.com [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

john@example.com

password(O)

String

myPassword

label(O)

String

myLabel

qrcode(O)

Boolean

true|false

false

service(O)

String[,..]

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

Example:
zxsuite auth credential add john@example.com password myPassword label myLabel qrcode false service eas,mobileApp

delete

zxsuite auth credential delete john@example.com f51as

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

john@example.com

password_id(M)

String

f51as

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

zxsuite auth delete john@example.com f51as

list

zxsuite auth credential list john@example.com

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

john@example.com

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

zxsuite auth list john@example.com

update

zxsuite auth credential update john@example.com f51as [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

john@example.com

password_id(M)

String

f51as

label(O)

String

myLabel

enabled(O)

Boolean

true|false

service(O)

String[,..]

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

zxsuite auth update john@example.com f51as label myLabel enabled false service WebUI

doDeployAuthZimlet

zxsuite auth doDeployAuthZimlet

Example:
zxsuite auth doDeployAuthZimlet

doRestartService

zxsuite auth doRestartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite auth doRestartService

doStartService

zxsuite auth doStartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite auth doStartService

doStopService

zxsuite auth doStopService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite auth doStopService

account

zxsuite auth enforce2FA get account 8916a2c1-5ae6-4ed2-be53-4fded8071428

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

8916a2c1-5ae6-4ed2-be53-4fded8071428

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

Example:
zxsuite auth enforce2FA get account

cos

zxsuite auth enforce2FA get cos 8916a2c1-5ae6-4ed2-be53-4fded8071428

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

cos(M)

String

8916a2c1-5ae6-4ed2-be53-4fded8071428

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

Example:
zxsuite auth enforce2FA get cos

account

zxsuite auth enforce2FA set account 8916a2c1-5ae6-4ed2-be53-4fded8071428 0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

8916a2c1-5ae6-4ed2-be53-4fded8071428

value(M)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth enforce2FA set account john.doe@example.com 2

This command enables 2FA on a device for account john.doe@example.com. In case of a multiserver setup, the command can be issued on any server: If the account is not defined on the host on which the command is issued, it will be looked up on the other servers.

cos

zxsuite auth enforce2FA set cos 8916a2c1-5ae6-4ed2-be53-4fded8071428 0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

cos(M)

String

8916a2c1-5ae6-4ed2-be53-4fded8071428

value(M)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth enforce2FA set cos

getServices

zxsuite auth getServices

Example:
zxsuite auth getServices

domain

zxsuite auth loginPage getBackgroundImage domain domain

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

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

Example:
zxsuite auth loginPage getBackgroundImage domain example.com

global

zxsuite auth loginPage getBackgroundImage global

Example:
zxsuite auth loginPage getBackgroundImage global

domain

zxsuite auth loginPage getColorPalette domain domain

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

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

zxsuite auth loginPage getColorPalette domain

global

zxsuite auth loginPage getColorPalette global

zxsuite auth loginPage getColorPalette global

domain

zxsuite auth loginPage getConfig domain domain

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

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

zxsuite auth loginPage getConfigdomain example.com

global

zxsuite auth loginPage getConfig global

zxsuite auth loginPage getConfigglobal

domain

zxsuite auth loginPage getFavicon domain domain

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

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

Example:
zxsuite auth loginPage getFavicon domain example.com

global

zxsuite auth loginPage getFavicon global

Example:
zxsuite auth loginPage getFavicon global

domain

zxsuite auth loginPage getLogo domain domain

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

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

zxsuite auth loginPage getLogo domain example.com

global

zxsuite auth loginPage getLogo global

zxsuite auth loginPage getLogo global

domain

zxsuite auth loginPage getSkinLogoAppBanner domain domain

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

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

Example:
zxsuite auth loginPage getSkinLogoAppBanner domain example.com

global

zxsuite auth loginPage getSkinLogoAppBanner global

Example:
zxsuite auth loginPage getSkinLogoAppBanner global

domain

zxsuite auth loginPage getSkinLogoURL domain domain

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

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

Example:
zxsuite auth loginPage getSkinLogoURL domain example.com

global

zxsuite auth loginPage getSkinLogoURL global

Example:
zxsuite auth loginPage getSkinLogoURL global

domain

zxsuite auth loginPage getTitle domain domain

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

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

Example:
zxsuite auth loginPage getTitle domain example.com

global

zxsuite auth loginPage getTitle global

Example:
zxsuite auth loginPage getTitle global

domain

zxsuite auth loginPage setBackgroundImage domain domain http://wwww.example.com/images/myimage.jpg

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

path(M)

String

http://wwww.example.com/images/myimage.jpg

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

Example:
zxsuite auth loginPage setBackgroundImage domain example.com http://wwww.example.com/images/myimage.jpg

global

zxsuite auth loginPage setBackgroundImage global http://wwww.example.com/images/myimage.jpg

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

path(M)

String

http://wwww.example.com/images/myimage.jpg

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

Example:
zxsuite auth loginPage setBackgroundImage global http://wwww.example.com/images/myimage.jpg

domain

zxsuite auth loginPage setColorPalette domain domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

primary(O)

String

hexadecimal color

secondary(O)

String

hexadecimal color

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

zxsuite auth loginPage setColorPalette domain example.com primary 6174AE

global

zxsuite auth loginPage setColorPalette global [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

primary(O)

String

hexadecimal color

secondary(O)

String

hexadecimal color

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

zxsuite auth loginPage setColorPalette global primary 6174AE

domain

zxsuite auth loginPage setFavicon domain domain http://wwww.example.com/images/myimage.jpg

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

path(M)

String

http://wwww.example.com/images/myimage.jpg

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

Example:
zxsuite auth loginPage setFavicon domain example.com http://wwww.example.com/images/myimage.jpg

global

zxsuite auth loginPage setFavicon global http://wwww.example.com/images/myimage.jpg

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

path(M)

String

http://wwww.example.com/images/myimage.jpg

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

Example:
zxsuite auth loginPage setFavicon global

domain

zxsuite auth loginPage setLogo domain domain http://wwww.example.com/images/myimage.jpg

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

path(M)

String

http://wwww.example.com/images/myimage.jpg

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

Example:
zxsuite auth loginPage setLogo domain example.com http://wwww.example.com/images/myimage.jpg

global

zxsuite auth loginPage setLogo global http://wwww.example.com/images/myimage.jpg

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

path(M)

String

http://wwww.example.com/images/myimage.jpg

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

Example:
zxsuite auth loginPage setLogo global http://wwww.example.com/images/myimage.jpg

domain

zxsuite auth loginPage setSkinLogoAppBanner domain domain http://wwww.example.com/images/myimage.jpg

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

skin_logo_app_banner(M)

String

http://wwww.example.com/images/myimage.jpg

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

Example:
zxsuite auth loginPage setSkinLogoAppBanner domain example.com http://wwww.example.com/images/myimage.jpg

global

zxsuite auth loginPage setSkinLogoAppBanner global http://wwww.example.com/images/myimage.jpg

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

skin_logo_app_banner(M)

String

http://wwww.example.com/images/myimage.jpg

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

Example:
zxsuite auth loginPage setSkinLogoAppBanner global http://wwww.example.com/images/myimage.jpg

domain

zxsuite auth loginPage setSkinLogoURL domain domain http://wwww.example.com/images/myimage.jpg

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

skin_logo_url(M)

String

http://wwww.example.com/images/myimage.jpg

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

Example:
zxsuite auth loginPage setSkinLogoURL domain example.com http://wwww.example.com/images/myimage.jpg

global

zxsuite auth loginPage setSkinLogoURL global http://wwww.example.com/images/myimage.jpg

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

skin_logo_url(M)

String

http://wwww.example.com/images/myimage.jpg

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

Example:
zxsuite auth loginPage setSkinLogoURL global http://wwww.example.com/images/myimage.jpg

domain

zxsuite auth loginPage setTitle domain domain 'My Custom Login Page'

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

title(M)

String

'My Custom Login Page'

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

Example:
zxsuite auth loginPage setTitle domain example.com 'My Custom Login Page'

global

zxsuite auth loginPage setTitle global 'My Custom Login Page'

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

title(M)

String

'My Custom Login Page'

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

Example:
zxsuite auth loginPage setTitle global 'My Custom Login Page'

domain

zxsuite auth policy list domain domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

service(O)

String

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

Example:
zxsuite auth policy list domain example.com

global

zxsuite auth policy list global [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service(O)

String

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

Example:
zxsuite auth policy list global

domain

zxsuite auth policy set Cli domain domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set Cli domain example.com ip_can_change true

global

zxsuite auth policy set Cli global [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set Cli global ip_can_change true

domain

zxsuite auth policy set Dav domain domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set Dav domain example.com ip_can_change true

global

zxsuite auth policy set Dav global [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set Dav global ip_can_change true

domain

zxsuite auth policy set EAS domain domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set EAS domain example.com ip_can_change true

global

zxsuite auth policy set EAS global [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set EAS global ip_can_change true

domain

zxsuite auth policy set Imap domain domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set Imap domain example.com ip_can_change true

global

zxsuite auth policy set Imap global [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set Imap global ip_can_change true

domain

zxsuite auth policy set MobileApp domain domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set MobileApp domain example.com ip_can_change true

global

zxsuite auth policy set MobileApp global [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set MobileApp global ip_can_change true

domain

zxsuite auth policy set Pop3 domain domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set Pop3 domain example.com ip_can_change true

global

zxsuite auth policy set Pop3 global [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set Pop3 global ip_can_change true

domain

zxsuite auth policy set Smtp domain domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set Smtp domain example.com ip_can_change true

global

zxsuite auth policy set Smtp global [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set Smtp global ip_can_change true

domain

zxsuite auth policy set WebAdminUI domain domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set WebAdminUI domain example.com ip_can_change true

global

zxsuite auth policy set WebAdminUI global [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set WebAdminUI global ip_can_change true

domain

zxsuite auth policy set WebUI domain domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set WebUI domain example.com ip_can_change true

global

zxsuite auth policy set WebUI global [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set WebUI global ip_can_change true

domain

zxsuite auth policy set ZmWebUI domain domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set ZmWebUI domain example.com ip_can_change true

global

zxsuite auth policy set ZmWebUI global [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

ip_can_change(O)

Boolean

true|false

trusted_ip_range(O)

String[,..]

192.168.0.1/16,192.168.100.14/24[,…​]

2fa_policy(O)

Integer

0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa)

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

Example:
zxsuite auth policy set ZmWebUI global ip_can_change true

domain

zxsuite auth policy trustedDevice getExpiration domain domain

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

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

Example:
zxsuite auth policy trustedDevice getExpiration domain example.com

global

zxsuite auth policy trustedDevice getExpiration global

Example:
zxsuite auth policy trustedDevice getExpiration global example.com 20

domain

zxsuite auth policy trustedDevice setExpiration domain domain value

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

value(M)

Long

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

Example:
zxsuite auth policy trustedDevice setExpiration domain example.com 20

global

zxsuite auth policy trustedDevice setExpiration global value

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

value(M)

Long

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

Example:
zxsuite auth policy trustedDevice setExpiration global 20

delete

zxsuite auth saml delete example.com organization.name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

example.com

key(M)

String

organization.name

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

Example:
zxsuite auth saml delete

get

zxsuite auth saml get example.com [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

example.com

key(O)

String

organization.name

export_to(O)

Path

./saml-config.json

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

Example:
zxsuite auth saml get

import

zxsuite auth saml import example.com [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

example.com

file(O)

Path

./saml-config.json

url(O)

String

http://domain/sso/saml/

allow_unsecure(O)

Boolean

true|false

false

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

Example:
zxsuite auth saml import

update

zxsuite auth saml update example.com organization.name Zextras

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

example.com

key(M)

String

organization.name

value(M)

String

Zextras

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

Example:
zxsuite auth saml update

validate

zxsuite auth saml validate ./saml-config.json

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

file(M)

Path

./saml-config.json

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

Example:
zxsuite auth saml validate

invalidate

zxsuite auth token invalidate user@example.com|uuid uuid|all

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

user@example.com|uuid

token_id(M)

String

uuid|all

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

Example:
zxsuite auth token invalidate user@example.com 49561162-d3fa-452f-aef0-d5fd2875695d

list

zxsuite auth token list uuid|user1@example.com [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

uuid|user1@example.com

credential_id(O)

String

credential_label(O)

String

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

Example:
zxsuite auth token list {account} credential_id j18ai credential_label myCredential

delete

zxsuite auth totp delete account [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

id(O)

String

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

Example:
zxsuite auth totp delete {account} <id>

generate

zxsuite auth totp generate account [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

algorithm(O)

String

SHA1|SHA256|SHA512

SHA1

pin(O)

String

secret_length(O)

Integer

32

32

period(O)

Integer

30|60

30

digits_length(O)

Integer

6|8|10

6

human_readable(O)

Boolean

true|false

true

pin_prepend(O)

Boolean

true|false

false

static_code(O)

Integer

0|…​|12|

12

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

Example:
zxsuite auth totp generate generate {account} <algorithm> <pin> <secret_length> <period> <digits_length> <human_readable> <pin_prepend> <static_code>

list

zxsuite auth totp list account [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

id(O)

Long

42

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

Example:
zxsuite auth totp list {account} <id>

delete

zxsuite auth trustedDevice delete account [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

deviceId(O)

String

device-id

ip(O)

String

192.168.42.42

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

Example:
zxsuite auth trustedDevice delete

list

zxsuite auth trustedDevice list account

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

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

Example:
zxsuite auth trustedDevice list

ZxBackup CLI Commands

doAccountScan

zxsuite backup doAccountScan account [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name/ID

deep(O)

Boolean

true|false

false

notifications(O)

Email Address

remote_metadata_upload(O)

Boolean

true|false

false

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

Example:
zxsuite backup doAccountScan john@example.com deep true

Performs a deep scan of the account john@example.com

doBackupAuthToken

zxsuite backup doBackupAuthToken start [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

remote_metadata_upload(O)

Boolean

true|false

false

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

Example:
zxsuite backup doBackupAuthToken

doBackupChat

zxsuite backup doBackupChat start

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

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

Example:
zxsuite backup doBackupChat

doBackupCluster

zxsuite backup doBackupCluster start [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

remote_metadata_upload(O)

Boolean

true|false

false

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

Example:
zxsuite backup doBackupCluster

doBackupLDAP

zxsuite backup doBackupLDAP start [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

remote_metadata_upload(O)

Boolean

true|false

false

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

Example:
zxsuite backup doBackupLDAP

doBackupServerCustomizations

zxsuite backup doBackupServerCustomizations start [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

remote_metadata_upload(O)

Boolean

true|false

false

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

Example:
zxsuite backup doBackupServerCustomizations

doCheckShares

zxsuite backup doCheckShares start

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

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

Example:
zxsuite backup doCheckShares

Check all shares on local accounts

doCoherencyCheck

zxsuite backup doCoherencyCheck backup_path [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

backup_path(M)

Path

accountIds(O)

String[,..]

all

checkZimbra(O)

Boolean

true|false

false

fixBackup(O)

Boolean

true|false

false

notifications(O)

Email Address[,..]

fixDoubleGzip(O)

String

skip|check|fix

skip

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

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

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

doEnableDisableCOS

zxsuite backup doEnableDisableCOS cos_name enable|disable

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

cos_name(M)

String

cos_state(M)

String

enable|disable

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

Example:
zxsuite backup doEnableDisableCOS mainCOS disable

Disables backup on the mainCOS class of service

doExport

zxsuite backup doExport destination_path [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

destination_path(M)

Path

domains(O)

Domain Name[,..]

all

cos(O)

String[,..]

all

notifications(O)

Email Address[,..]

threshold(O)

Long

read_error_threshold(O)

Integer

skip_items(O)

Boolean

true|false

false

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

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

doExternalRestore

zxsuite backup doExternalRestore source_path [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

source_path(M)

Path

accounts(O)

Account Name[,..]

all

input_file(O)

String

list of accounts, one per line

domains(O)

Domain Name[,..]

all

filter_deleted(O)

Boolean

true|false

true

skip_system_accounts(O)

Boolean

true|false

true

skip_aliases(O)

Boolean

true|false

false

skip_distribution_lists(O)

Boolean

true|false

false

skip_coses(O)

Boolean

true|false

false

skip_account_provisioning(O)

Boolean

true|false

false

skip_domain_provisioning(O)

Boolean

true|false

false

provisioning_only(O)

Boolean

true|false

false

notifications(O)

Email Address

concurrent_accounts(O)

Integer

max_file_size(O)

Integer

restore_datasource(O)

Boolean

true|false

true

force_as_external_restore(O)

Boolean

true|false

false

blobs_archive(O)

String

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

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/

doFixShares

zxsuite backup doFixShares import_idmap_file

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

import_idmap_file(M)

String

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

Example:
zxsuite backup doFixShares import_idmap_file

Fixes the shares' consistency after an import according to the mapping contained in the import_idmap_file inside backup directory

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

Example:
zxsuite backup doItemRestore john@example.com 4784

Restores item 4784 in the "john@example.com" mailbox

doItemSearch

zxsuite backup doItemSearch account [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name/ID

backup_path(O)

String

id(O)

String

search_string(O)

String

"Case sensitive string"

type(O)

Multiple choice

message|contact|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

search_filter(O)

Multiple choice

all|deleted|not_deleted

deleted

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

Example:
zxsuite backup doItemSearch john@example.com type message

Shows all of John’s deleted emails which still are in the 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

Example:
zxsuite backup doPurge purgeDays 30 backup_path /opt/zimbra/backup/backup_name

doRawRestore

zxsuite backup doRawRestore source_path [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

source_path(M)

String

notifications(O)

Email Address[,..]

skipProvisioning(O)

Boolean

true|false

false

deleteWhenConflict(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

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.

doRestartService

zxsuite backup doRestartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite backup doRestartService

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

zimbra|drive|all

all

blobs_archive(O)

String

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

Example:
zxsuite backup doRestoreBlobs 1 dryrun true

Run a restore blob operation on volume 1 without actually restoring data.

Example:
zxsuite backup doRestoreBlobs 3 dryrun false compress false

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

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

doSmartScan

zxsuite backup doSmartScan start [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

notifications(O)

Email Address[,..]

read_error_threshold(O)

Integer

deep(O)

Boolean

true|false

remote_metadata_upload(O)

Boolean

true|false

false

create_fake_blob(O)

Boolean

true|false

false

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

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

doStartService

zxsuite backup doStartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite backup doStartService

doStopAllOperations

zxsuite backup doStopAllOperations

Example:
zxsuite backup doStopAllOperations

Stops all running operations

doStopOperation

zxsuite backup doStopOperation operation_uuid

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

operation_uuid(M)

Uuid

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

Example:
zxsuite backup doStopOperation 30ed9eb9-eb28-4ca6-b65e-9940654b8601

Stops operation with id = 30ed9eb9-eb28-4ca6-b65e-9940654b8601

doStopService

zxsuite backup doStopService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite backup doStopService

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

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

Example:
zxsuite backup doUndelete john@example.com "08/10/2012 10:15:00" last

Performs an undelete on the john@example.com account of all items deleted between 08/10/2012 10:15:00 and the latest data available

getAccountInfo

zxsuite backup getAccountInfo account [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name/ID

backup_path(O)

Path

date(O)

Multiple choice

"dd/MM/yyyy HH:mm:ss"|most_recent|least_recent|all

most_recent

backupstats(O)

Boolean

true|false

false

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

Example:
zxsuite backup getAccountInfo john@example.com

Displays info about the account john@example.com

Example:
zxsuite backup getAccountInfo 04b4bfbe-6675-43eb-b5ea-098b4681869e

Displays info for the account with id 04b4bfbe-6675-43eb-b5ea-098b4681869e

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

Example:
zxsuite backup getAllOperations

Shows all running and queued operations

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_system_accounts(O)

Boolean

true|false

true

hide_existing_accounts(O)

Boolean

true|false

false

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

Example:
zxsuite backup getAvailableAccounts last /opt/zimbra/backup/zextras/ hide_deleted false

Shows all accounts in the last backup, showing deleted accounts as well

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"

backup_path(M)

Path

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

Example:
zxsuite backup getAvailableDomains last /opt/zimbra/backup/export

Shows all domains in the last 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

Example:
zxsuite backup getBackupInfo /opt/zimbra/backup/zextras/

Shows all information about the backup directory '/opt/zimbra/backup/zextras/'

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

Example:
zxsuite backup getCOSBackupStatus

Shows all the classes of service and their ZxBackup status

getItem

zxsuite backup getItem account item [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(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

blobs_archive(O)

String

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

Example:
zxsuite backup getItem a7300a00-56ec-46c3-9773-c6ef7c4f3636 1

Shows item with id = 1 belonging to account a7300a00-56ec-46c3-9773-c6ef7c4f3636

getMap

zxsuite backup getMap file_path

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

file_path(M)

Path

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

Example:
zxsuite backup getMap /opt/zimbra/backup/zextras/map_544d94c6-aaef-4736-8964-56a667f1fe12

Shows the item backup map

getProperty

zxsuite backup getProperty [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

verbose(O)

Boolean

true|false

property_name(O)

String[,..]

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

Example:
zxsuite backup getProperty
this command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]

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

Example:
zxsuite backup getServerConfig standard date last

Display a summary of the latest backup data for Server and Global configuration.

Example:
zxsuite backup getServerConfig standard date last query /

Display the latest backed up server and global configuration settings.

Example:
zxsuite backup getServerConfig standard file /path/to/backup/file

Display the contents of a backup file instead of the current server backup.

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.

getServices

zxsuite backup getServices

Example:
zxsuite backup getServices

Default

zxsuite backup migrateBackupVolume Default start

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

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

Example:
zxsuite backup migrateBackupVolume Default start

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

Example:
zxsuite backup migrateBackupVolume Local /path/to/directory

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

volume_prefix(O)

String

Prefix to the server id used in all objects keys (Volume configuration)

bucket_configuration_id(O)

String

UUID for already existing S3 service credentials (zxsuite config global get attribute s3BucketConfigurations)

region(O)

String

Amazon AWS Region

url(O)

String

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

prefix(O)

String

Prefix added to blobs keys (Bucket configuration)

use_infrequent_access(O)

Boolean

true|false

infrequent_access_threshold(O)

String

use_intelligent_tiering(O)

Boolean

true|false

threads(O)

Integer

10

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

Example:
zxsuite backup migrateBackupVolume S3 bucket_configuration_id {uuid}

monitor

zxsuite backup monitor operation_uuid [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

operation_uuid(M)

Uuid

operation_host(O)

String

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

Example:
zxsuite backup monitor

Local

zxsuite backup retrieveMetadataFromArchive Local source destination [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

source(M)

String

destination(M)

String

threads(O)

Integer

10

notifications(O)

Email Address

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

Example:
zxsuite backup retrieveMetadataFromArchive Local /path/to/source/directory /path/to/destination/directory

S3

zxsuite backup retrieveMetadataFromArchive S3 destination [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

destination(M)

String

bucket_name(O)

String

Amazon AWS bucket

access_key(O)

String

Service username

secret(O)

String

Service password

volume_prefix(O)

String

Prefix to the server id used in all objects keys (Volume configuration)

bucket_configuration_id(O)

String

UUID for already existing S3 service credentials (zxsuite config global get attribute s3BucketConfigurations)

region(O)

String

Amazon AWS Region

url(O)

String

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

prefix(O)

String

Prefix added to blobs keys (Bucket configuration)

threads(O)

Integer

10

notifications(O)

Email Address

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

Example:
zxsuite backup retrieveMetadataFromArchive S3 /path/to/destination/directory bucket_configuration_id {uuid} volume_prefix {path}

Default

zxsuite backup setBackupVolume Default start

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

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

Example:
zxsuite backup setBackupVolume Default start

Local

zxsuite backup setBackupVolume Local path

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

path(M)

String

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

Example:
zxsuite backup setBackupVolume Local /path/to/directory

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

volume_prefix(O)

String

Prefix to the server id used in all objects keys (Volume configuration)

bucket_configuration_id(O)

String

UUID for already existing S3 service credentials (zxsuite config global get attribute s3BucketConfigurations)

region(O)

String

Amazon AWS Region

url(O)

String

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

prefix(O)

String

Prefix added to blobs keys (Bucket configuration)

use_infrequent_access(O)

Boolean

true|false

infrequent_access_threshold(O)

String

use_intelligent_tiering(O)

Boolean

true|false

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

Example:
zxsuite backup setBackupVolume S3 bucket_configuration_id {uuid} volume_prefix {path}

setProperty

zxsuite backup setProperty property_name property_value

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

property_name(M)

String

property_value(M)

String

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

Example:
zxsuite backup setProperty
this command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]

S3

zxsuite backup updateBackupVolume S3 [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

use-infrequent-access(O)

Boolean

true|false

infrequent-access-threshold(O)

String

64 KB

use-intelligent-tiering(O)

Boolean

true|false

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

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

Example:
zxsuite backup updateBackupVolume S3 use-intelligent-tiering true

Sets intelligent tiering storage class for all new backup blobs

ZxConfig CLI Commands

account

zxsuite config account set|get|empty accountName [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

command(M)

String

set|get|empty

accountName(M)

Account Name/ID

attribute(O)

String

value(O)

String

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

Example:
zxsuite config account get accountName attribute debranded
Example:
zxsuite config account set accountName attribute debranded value true
Example:
zxsuite config account empty accountName attribute debranded
this command is deprecated use instead: zxsuite config get account [object Object] [object Object] zxsuite config set account [object Object] [object Object] [object Object] zxsuite config unset account [object Object] [object Object]

clean

zxsuite config clean

Example:
zxsuite config clean

cos

zxsuite config cos set|get|empty cosName [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

command(M)

String

set|get|empty

cosName(M)

String

attribute(O)

String

value(O)

String

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

Example:
zxsuite config cos get cosName attribute debranded
Example:
zxsuite config cos set cosName attribute debranded value true
Example:
zxsuite config cos empty cosName attribute debranded
this command is deprecated use instead: zxsuite config get cos [object Object] [object Object] zxsuite config set cos [object Object] [object Object] [object Object] zxsuite config unset cos [object Object] [object Object]

distributionList

zxsuite config distributionList set|get|empty distributionListName [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

command(M)

String

set|get|empty

distributionListName(M)

String

attribute(O)

String

value(O)

String

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

Example:
zxsuite config distributionList get distributionListName attribute allowDlMemberAddAsFriend
Example:
zxsuite config distributionList set distributionListName attribute allowDlMemberAddAsFriend value true
Example:
zxsuite config distributionList empty distributionListName attribute allowDlMemberAddAsFriend

domain

zxsuite config domain set|get|empty domainName [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

command(M)

String

set|get|empty

domainName(M)

Domain Name

attribute(O)

String

value(O)

String

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

Example:
zxsuite config domain get domainName attribute debranded
Example:
zxsuite config domain set domainName attribute debranded value true
Example:
zxsuite config domain empty domainName attribute debranded
this command is deprecated use instead: zxsuite config get domain [object Object] [object Object] zxsuite config set domain [object Object] [object Object] [object Object] zxsuite config unset domain [object Object] [object Object]

doRestartService

zxsuite config doRestartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite config doRestartService

doStartService

zxsuite config doStartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite config doStartService

doStopService

zxsuite config doStopService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite config doStopService

account

zxsuite config dump account account [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name/ID

show-inherited(O)

Boolean

true|false

true

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

Example:
zxsuite config dump account user@example.com

Dumps all the attributes related to the account u0@example.com skipping inherited values

Example:
zxsuite config dump account user@example.com show-inherited true

Dumps all the attributes related to the account u0@example.com showing inherited values

cos

zxsuite config dump cos cos [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

cos(M)

Unknown

show-inherited(O)

Boolean

true|false

true

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

Example:
zxsuite config dump cos example_cos

Dumps all the attributes related to the cos example_cos skipping inherited values

Example:
zxsuite config dump cos example_cos show-inherited true

Dumps all the attributes related the the cos example_cos showing inherited values

domain

zxsuite config dump domain domain [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

Domain Name

show-inherited(O)

Boolean

true|false

true

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

Example:
zxsuite config dump domain example.com

Dumps all the attributes related to the domain example.com skipping inherited values

Example:
zxsuite config dump domain example.com show-inherited true

Dumps all the attributes related the the domain example.com showing inherited values

global

zxsuite config dump global

Example:
zxsuite config dump global

Dumps the global config

server

zxsuite config dump server server [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

server(M)

Unknown

show-inherited(O)

Boolean

true|false

true

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

Example:
zxsuite config dump server mail.example.com

Dumps all the attributes related to the server mail.example.com skipping inherited values

Example:
zxsuite config dump server mail.example.com show-inherited true

Dumps all the attributes related to the server mail.example.com showing inherited values

getServices

zxsuite config getServices

Example:
zxsuite config getServices

global

zxsuite config global set|get|empty [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

command(M)

String

set|get|empty

attribute(O)

String

value(O)

String

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

Example:
zxsuite config global get attribute debranded
Example:
zxsuite config global set attribute debranded value true
Example:
zxsuite config global empty attribute debranded
this command is deprecated use instead: zxsuite config get global [object Object] zxsuite config set global [object Object] [object Object] zxsuite config unset global [object Object]

info

zxsuite config info attribute

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

attribute(M)

String

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

Example:
zxsuite config info teamChatEnabled

server

zxsuite config server set|get|empty serverName [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

command(M)

String

set|get|empty

serverName(M)

String

attribute(O)

String

value(O)

String

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

Example:
zxsuite config server get serverName attribute debranded
Example:
zxsuite config server set serverName attribute debranded value true
Example:
zxsuite config server empty serverName attribute debranded
this command is deprecated use instead: zxsuite config get server [object Object] [object Object] zxsuite config set server [object Object] [object Object] [object Object] zxsuite config unset server [object Object] [object Object]

status

zxsuite config status

Example:
zxsuite config status

ZxCore CLI Commands

purgeOrphans

zxsuite core apiVersions purgeOrphans

zxsuite core apiVersions drive purgeOrphans

apply-patch

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

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service(M)

String

hosts(O)

String[,..]

all_servers

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

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

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

Alibaba

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

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_name(M)

String

Bucket name

access_key(M)

String

Service username

secret(M)

String

Service password

url(O)

String

Alibaba endpoint (e.g.: https://oss-ap-example.aliyuncs.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

Ceph

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

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_name(M)

String

Bucket name

access_key(M)

String

Service username

secret(M)

String

Service password

url(M)

String

S3 API compatible service url (ex: s3api.service.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

Cloudian

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

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_name(M)

String

Bucket name

access_key(M)

String

Service username

secret(M)

String

Service password

url(M)

String

S3 API compatible service url (ex: s3api.service.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

CustomS3

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

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_name(M)

String

Bucket name

access_key(M)

String

Service username

secret(M)

String

Service password

url(M)

String

S3 API compatible service url (ex: s3api.service.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

EMC

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

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_name(M)

String

Bucket name

access_key(M)

String

Service username

secret(M)

String

Service password

url(M)

String

S3 API compatible service url (ex: s3api.service.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

S3

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

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_name(M)

String

Amazon AWS bucket

access_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: s3api.service.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

ScalityS3

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

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_name(M)

String

Bucket name

access_key(M)

String

Service username

secret(M)

String

Service password

url(M)

String

S3 API compatible service url (ex: s3api.service.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

Yandex

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

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

bucket_name(M)

String

Bucket name

access_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

doDeleteAllDelegatedRights

zxsuite core doDeleteAllDelegatedRights confirmation string

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

confirm(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.

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>

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>

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>

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>

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>

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>

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>

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>

doDeployClientZimlet

zxsuite core doDeployClientZimlet

Example:
zxsuite core doDeployClientZimlet

doISPRenewal

zxsuite core doISPRenewal

doLicenseChecks

zxsuite core doLicenseChecks

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

Example:
zxsuite core doRemoveLicense iamsure true

Remove the license

doRestartService

zxsuite core doRestartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite core doRestartService

doStartService

zxsuite core doStartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite core doStartService

doStopService

zxsuite core doStopService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite core doStopService

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-example.aliyuncs.com)

region(O)

String

Alibaba OSS Region

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

zxsuite core updateVolume Alibaba bucketName access_key accessKey

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.service.com)

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

zxsuite core updateVolume Ceph bucketName access_key accessKey

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.service.com)

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

zxsuite core updateVolume Cloudian bucketName access_key accessKey

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.service.com)

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

zxsuite core updateVolume CustomS3 bucketName access_key accessKey

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.service.com)

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

zxsuite core updateVolume EMC bucketName access_key accessKey

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.service.com)

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

zxsuite core updateVolume S3 bucketName access_key accessKey

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.service.com)

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

zxsuite core updateVolume ScalityS3 bucketName access_key accessKey

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

doUploadLicense

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

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

license_path(M)

Path

force(O)

Boolean

true|false

false

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

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

getAccountStats

zxsuite core getAccountStats account

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name/ID

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

Example:
zxsuite core getAccountStats John

Shows stats for user John

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

Example:
zxsuite core getAllOperations

Shows all running and queued operations

getLicenseInfo

zxsuite core getLicenseInfo

getNotification

zxsuite core getNotification [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

id(O)

String

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

Example:
zxsuite core getNotification

Shows the notification list

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

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

getOperationLog

zxsuite core getOperationLog

Example:
zxsuite core getOperationLog

getProperty

zxsuite core getProperty [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

verbose(O)

Boolean

true|false

property_name(O)

String[,..]

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

Example:
zxsuite core getProperty
this command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]

getServices

zxsuite core getServices

Example:
zxsuite core getServices

getUnfinishedOperationLog

zxsuite core getUnfinishedOperationLog

Example:
zxsuite core getUnfinishedOperationLog

getUpdateInfo

zxsuite core getUpdateInfo

getVersion

zxsuite core getVersion

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

Example:
zxsuite core listBuckets

List all bucket configurations without displaying secrets

Example:
zxsuite core listBuckets S3 show_secrets true

List all S3 bucket configurations displaying secrets

setProperty

zxsuite core setProperty property_name property_value

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

property_name(M)

String

property_value(M)

String

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

Example:
zxsuite core setProperty
this command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]

verify-patch

zxsuite core verify-patch service [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service(M)

String

hosts(O)

String[,..]

all_servers

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

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

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

interval

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

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

command(M)

String

set|get|empty

attribute(O)

String

value(O)

String

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

Example:
zxsuite metrics interval

Get the current interval value

Example:
zxsuite metrics interval 30

Set the interval to 30 seconds

percentiles

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

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

command(M)

String

set|get|empty

attribute(O)

String

value(O)

String

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

Example:
zxsuite metrics percentiles

Get the current percentiles values

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

remove

zxsuite metrics remove graphite

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

endpoint(M)

String

graphite

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

Example:
zxsuite metrics remove graphite

Remove the graphite endpoint configuration

graphite

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

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

protocol(M)

String

plaintext|udp|pickle

host(M)

String

metrics.example.com

port(O)

Long

2003

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

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

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

Example:
zxsuite metrics status

doCheckUpdate

zxsuite update doCheckUpdate

ZxDocs CLI Commands

doDeployDocsZimlet

zxsuite docs doDeployDocsZimlet

Example:
zxsuite docs doDeployDocsZimlet

Deploy Zextras Suite Docs zimlet

doReloadConfig

zxsuite docs doReloadConfig start

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

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

Example:
zxsuite docs doReloadConfig

doRestartService

zxsuite docs doRestartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite docs doRestartService

doStartService

zxsuite docs doStartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite docs doStartService

doStopService

zxsuite docs doStopService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite docs doStopService

getServices

zxsuite docs getServices

Example:
zxsuite docs getServices

status

zxsuite docs status

Example:
zxsuite docs status

ZxDrive CLI Commands

doDeleteBriefcaseData

zxsuite drive doDeleteBriefcaseData account@example.com,system-account@example.com,test.example.com[,…​] [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

target(M)

String[,..]

account@example.com,system-account@example.com,test.example.com[,…​]

dryRun(O)

Boolean

true|false

true

notifications(O)

Email Address[,..]

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

Example:
zxsuite drive doDeleteBriefcaseData admin@example.com dryRun false

Perform a briefcase deletion for a system account

Example:
zxsuite drive doDeleteBriefcaseData user@example.com dryRun false

Perform a briefcase deletion for an account

Example:
zxsuite drive doDeleteBriefcaseData demo.example.com dryRun false

Perform a briefcase deletion for an entire domain

Example:
zxsuite drive doDeleteBriefcaseData demo.example.com,user@example.com

Perform a briefcase deletion for the entire domain demo.example.com and user user@example.com

Example:
zxsuite drive doDeleteBriefcaseData user@example.com dryRun true

Perform a fake deletion of the briefcase for a generic account, this could be useful for check what the real operation will do

doDeployDriveZimlet

zxsuite drive doDeployDriveZimlet

Example:
zxsuite drive doDeployDriveZimlet

doImportBriefcase

zxsuite drive doImportBriefcase target [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

target(M)

String[,..]

dryRun(O)

Boolean

true|false

false

deleteSources(O)

Boolean

true|false

false

override(O)

Boolean

true|false

false

itemRevisions(O)

Boolean

true|false

true

sendShareNotifications(O)

Boolean

true|false

false

notifications(O)

Email Address[,..]

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

Example:
zxsuite drive doImportBriefcase admin@example.com

Perform a system account migration

Example:
zxsuite drive doImportBriefcase user@example.com

Perform an account migration

Example:
zxsuite drive doImportBriefcase demo.example.com

Perform an entire domain migration

Example:
zxsuite drive doImportBriefcase demo.example.com,user@example.com

Perform entire domain demo.example.com and user user@example.com migration

Example:
zxsuite drive doImportBriefcase user@example.com dryRun false

Perform a fake migration for a generic account, this could be useful for check what the real operation will do

Example:
zxsuite drive doImportBriefcase user@example.com deleteSource false

Perform an account copy-migration

Example:
zxsuite drive doImportBriefcase user@example.com override true

Perform an account migration overriding items that already exists

Example:
zxsuite drive doImportBriefcase user@example.com itemRevision false

Perform an account migration without importing each items revision

Example:
zxsuite drive doImportBriefcase user@example.com sendShareNotifications true

Perform an account migration sending share notifications when imported one

doRestartService

zxsuite drive doRestartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite drive doRestartService

doStartService

zxsuite drive doStartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite drive doStartService

doStopService

zxsuite drive doStopService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite drive doStopService

dumpSessions

zxsuite drive dumpSessions

Example:
zxsuite drive dumpSessions

getQuota

zxsuite drive getQuota [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(O)

String

bob@example.com

domain(O)

String

example.com

server(O)

String

mail1.example.com

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

Example:
zxsuite drive getQuota

getServices

zxsuite drive getServices

Example:
zxsuite drive getServices

monitor

zxsuite drive monitor operation_uuid [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

operation_uuid(M)

Uuid

operation_host(O)

String

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

Example:
zxsuite drive monitor

ZxMobile CLI Commands

allow

zxsuite mobile ABQ allow device_id [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

device_id(M)

String

account(O)

String

27ee8dd9-d813-4ca7-a988-580df0027a58|user1@example.com

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

Example:
zxsuite mobile ABQ allow

block

zxsuite mobile ABQ block device_id [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

device_id(M)

String

account(O)

String

27ee8dd9-d813-4ca7-a988-580df0027a58|user1@example.com

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

Example:
zxsuite mobile ABQ block

delete

zxsuite mobile ABQ delete device_id [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

device_id(M)

String

account(O)

String

27ee8dd9-d813-4ca7-a988-580df0027a58/user1@example.com

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

Example:
zxsuite mobile ABQ delete

deleteRule

zxsuite mobile ABQ deleteRule regex [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

regex(M)

String

domain(O)

String

Domain name|id

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

Example:
zxsuite mobile ABQ deleteRule "android.*" domain example.com

import

zxsuite mobile ABQ import Path to file Allowed|Blocked|Quarantined

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

input_file(M)

String

Path to file

status(M)

String

Allowed|Blocked|Quarantined

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

Example:
zxsuite mobile ABQ import /path/to/file Allowed

list

zxsuite mobile ABQ list [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

status(O)

String

Allowed|Blocked|Quarantined

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

Example:
zxsuite mobile ABQ list

listRules

zxsuite mobile ABQ listRules [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(O)

Domain Name

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

Example:
zxsuite mobile ABQ listRules

set

zxsuite mobile ABQ set device_id Allowed|Blocked|Quarantined [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

device_id(M)

String

status(M)

String

Allowed|Blocked|Quarantined

account(O)

String

27ee8dd9-d813-4ca7-a988-580df0027a58|user1@example.com

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

Example:
zxsuite mobile ABQ set

setNotificationInterval

zxsuite mobile ABQ setNotificationInterval 45m|6h|1d|0

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

interval(M)

String

45m|6h|1d|0

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

Set notification of new quarantined devices every 45 minutes

Example:
zxsuite mobile ABQ setNotificationInterval 45m

Set notification of new quarantined devices every 6 hours

Example:
zxsuite mobile ABQ setNotificationInterval 6h

Set notification of new quarantined devices once every day

Example:
zxsuite mobile ABQ setNotificationInterval 1d

Disable notifications of new quarantined devices

Example:
zxsuite mobile ABQ setNotificationInterval 0

setRule

zxsuite mobile ABQ setRule regex Allowed|Blocked|Quarantined order [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

regex(M)

String

status(M)

String

Allowed|Blocked|Quarantined

order(M)

Long

domain(O)

String

Domain name|id

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

Example:
zxsuite mobile ABQ setRule "android.*" Blocked 10 domain example.com

domain

zxsuite mobile addressBook add domain domain 27ee8dd9-d813-4ca7-a988-580df0027a58|user1@example.com all|folder id

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

account(M)

String

27ee8dd9-d813-4ca7-a988-580df0027a58|user1@example.com

folder(M)

String

all|folder id

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

Example:
zxsuite mobile addressBook add domain example.com user@example.com 2

global

zxsuite mobile addressBook add global 27ee8dd9-d813-4ca7-a988-580df0027a58|user1@example.com all|folder id

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

27ee8dd9-d813-4ca7-a988-580df0027a58|user1@example.com

folder(M)

String

all|folder id

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

Example:
zxsuite mobile addressBook add global user@example.com 2

domain

zxsuite mobile addressBook list domain domain

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

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

Example:
zxsuite mobile addressBook list domain example.com

global

zxsuite mobile addressBook list global

Example:
zxsuite mobile addressBook list global

domain

zxsuite mobile addressBook remove domain domain 27ee8dd9-d813-4ca7-a988-580df0027a58|user1@example.com all|folder id

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

account(M)

String

27ee8dd9-d813-4ca7-a988-580df0027a58|user1@example.com

folder(M)

String

all|folder id

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

Example:
zxsuite mobile addressBook remove domain example.com user@example.com 2

global

zxsuite mobile addressBook remove global 27ee8dd9-d813-4ca7-a988-580df0027a58|user1@example.com [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

27ee8dd9-d813-4ca7-a988-580df0027a58|user1@example.com

folder(O)

String

all|folder id

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

Example:
zxsuite mobile addressBook remove global user@example.com 2

domain

zxsuite mobile deleteABQMessage domain example.com blocked|quarantined default|a valid locale

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

example.com

type(M)

String

blocked|quarantined

locale(M)

String

default|a valid locale

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

Example:
zxsuite mobile deleteABQMessage domain example.com default

global

zxsuite mobile deleteABQMessage global blocked|quarantined default|a valid locale

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

type(M)

String

blocked|quarantined

locale(M)

String

default|a valid locale

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

Example:
zxsuite mobile deleteABQMessage global blocked it

doAddAccountLogger

zxsuite mobile doAddAccountLogger account trace|debug|info|warn|err|crit log_file [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name

log_level(M)

Multiple choice

trace|debug|info|warn|err|crit

log_file(M)

Path

window_size(O)

Integer

a value > 0

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

Example:
zxsuite mobile doAddAccountLogger john@example.com info /tmp/john_logger

Creates an info account logger for john’s account to file /tmp/john_logger

Example:
zxsuite mobile doAddAccountLogger john@example.com info /tmp/john_logger window_size 1

Creates an info account logger for john’s account to file /tmp/john_logger with window size set to 1.

doAddEASFilter

zxsuite mobile doAddEASFilter and|or|regex|contains|account|domain text|people@example.com|account=example@ff.com,contains=android add|subtract|fixed|limit easversions [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

type(M)

Multiple choice

and|or|regex|contains|account|domain

parameter(M)

String

text|people@example.com|account=example@ff.com,contains=android

mode(M)

Multiple choice

add|subtract|fixed|limit

easversions(M)

String[,..]

blocking(O)

Boolean

true|false

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

Example:
zxsuite mobile doAddEASFilter contains android fixed 2.5,12.0,14.1

Adds a protocol filter that will restrict the pool of available EAS versions to 2.5, 12.0 and 14.1 if the user agent name

contains the string 'android'.

Example:
zxsuite mobile doAddEASFilter and account=user@example.com,contains=android fixed 14.1 blocking true

Adds a protocol filter that will restrict the pool of available EAS versions to 14.1 if the user agent name

contains the string 'android' only for user@example.com. No more EAS filters will be evaluated after this one due to the 'blocking' directive.

doDeleteEASFilter

zxsuite mobile doDeleteEASFilter id

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

id(M)

Integer

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

Example:
zxsuite mobile doDeleteEASFilter 2

Removes the filter with id = 2.

To show a list of the filters, use the

zxsuite mobile getAllEASFilters

command.

doMoveEASFilter

zxsuite mobile doMoveEASFilter from to

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

from(M)

Integer

to(M)

Integer

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

Example:
zxsuite mobile doMoveEASFilter 0 5

Moves the filter with id = 0 to the position 5.

To show a list of the filters, use the

zxsuite mobile getAllEASFilters

command.

doRemoveDevice

zxsuite mobile doRemoveDevice account device_id

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name

device_id(M)

String

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

Example:
zxsuite mobile doRemoveDevice john@example.com Appl79032X2WA4S

Removes John’s Appl79032X2WA4S device SyncState

doRemoveLogger

zxsuite mobile doRemoveLogger logger_id|"all_loggers"

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

logger_id(M)

Multiple choice

logger_id|"all_loggers"

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

Example:
zxsuite mobile doRemoveLogger 5

Removes the account logger with ID = 5

doResetAccount

zxsuite mobile doResetAccount account

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name

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

Example:
zxsuite mobile doResetAccount john@example.com

Resets all the device states for John’s account

doResetDevice

zxsuite mobile doResetDevice account [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name

device_id(O)

String

all

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

Example:
zxsuite mobile doResetDevice john@example.com Appl79032X2WA4S

Resets John’s Appl79032X2WA4S device SyncState

doRestartService

zxsuite mobile doRestartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite mobile doRestartService

doResumeDeviceSync

zxsuite mobile doResumeDeviceSync account [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name

device_id(O)

String

all

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

doSimulateSync

zxsuite mobile doSimulateSync account LG8955c3fa9|new [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name/ID

device_id(M)

String

LG8955c3fa9|new

days(O)

Integer

initial(O)

Boolean

true|false

device_type(O)

String

iphone|android

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

Example:
zxsuite mobile doSimulateSync account@example.com android1365173312
Example:
zxsuite mobile doSimulateSync account@example.com new days 2 initial false

doStartService

zxsuite mobile doStartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite mobile doStartService

doStopService

zxsuite mobile doStopService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite mobile doStopService

doSuspendDeviceSync

zxsuite mobile doSuspendDeviceSync account device_id

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name

device_id(M)

String

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

doWipeDevice

zxsuite mobile doWipeDevice account device_id [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name

device_id(M)

String

confirm(O)

Boolean

true|false

false

account_only(O)

Boolean

true|false

false

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

domain

zxsuite mobile duplicateABQMessage domain example.com blocked|quarantined default|a valid locale default|a valid locale

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

example.com

type(M)

String

blocked|quarantined

locale_from(M)

String

default|a valid locale

locale_to(M)

String

default|a valid locale

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

Example:
zxsuite mobile duplicateABQMessage domain example.com en_US en_UK

global

zxsuite mobile duplicateABQMessage global blocked|quarantined default|a valid locale default|a valid locale

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

type(M)

String

blocked|quarantined

locale_from(M)

String

default|a valid locale

locale_to(M)

String

default|a valid locale

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

Example:
zxsuite mobile duplicateABQMessage global blocked en_US en_UK

domain

zxsuite mobile getABQMessage domain example.com blocked|quarantined all|default|a valid locale

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

example.com

type(M)

String

blocked|quarantined

locale(M)

String

all|default|a valid locale

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

Example:
zxsuite mobile getABQMessage domain example.com blocked it
Example:
zxsuite mobile getABQMessage domain example.com blocked default
Example:
zxsuite mobile getABQMessage domain example.com blocked all

global

zxsuite mobile getABQMessage global blocked|quarantined all|default|a valid locale

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

type(M)

String

blocked|quarantined

locale(M)

String

all|default|a valid locale

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

Example:
zxsuite mobile getABQMessage global blocked it
Example:
zxsuite mobile getABQMessage global blocked default
Example:
zxsuite mobile getABQMessage global blocked all

getAccountLoggers

zxsuite mobile getAccountLoggers

Example:
zxsuite mobile getAccountLoggers

Shows the account logger list

getAllDevices

zxsuite mobile getAllDevices [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

verbose(O)

Boolean

true|false

false

all_servers(O)

Boolean

true|false

false

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

Example:
zxsuite mobile getAllDevices

getAllEASFilters

zxsuite mobile getAllEASFilters

Example:
zxsuite mobile getAllEASFilters

Shows the list of currently set EAS version filters

getDeviceInfo

zxsuite mobile getDeviceInfo account device_id [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name/ID

device_id(M)

String

verbose(O)

Boolean

true|false

false

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

Example:
zxsuite mobile getDeviceInfo john@example.com Appl79032X2WA4S verbose true

Shows detailed info about John’s device with id Appl79032X2WA4S

getDeviceList

zxsuite mobile getDeviceList account

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

Account Name

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

Example:
zxsuite mobile getDeviceList john@example.com

Shows all John’s devices ids

getProperty

zxsuite mobile getProperty [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

verbose(O)

Boolean

true|false

property_name(O)

String[,..]

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

Example:
zxsuite mobile getProperty
this command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]

getProvisioning

zxsuite mobile getProvisioning account|cos target [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

target_type(M)

Multiple choice

account|cos

target(M)

String

key(O)

String

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

Example:
zxsuite mobile getProvisioning account john@example.com key zimbraMobilePolicyAllowDesktopSync

Shows the value of the zimbraMobilePolicyAllowDesktopSync property for John’s account

Example:
zxsuite mobile getProvisioning account john@example.com

Shows the value of all properties for John’s account

getServices

zxsuite mobile getServices

Example:
zxsuite mobile getServices

initABQMessage

zxsuite mobile initABQMessage all

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

all

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

zxsuite zxsuite initABQMessage all

domain

zxsuite mobile setABQMessage domain example.com blocked|quarantined default|a valid locale [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

domain(M)

String

example.com

type(M)

String

blocked|quarantined

locale(M)

String

default|a valid locale

from(O)

String

reply_to(O)

String

subject(O)

String

body_plain(O)

String

body_plain_file(O)

String

body_html(O)

String

body_html_file(O)

String

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

zxsuite mobile addAbqMessage domain example.com default u0@example.com admin@example.com "Email subject" "Email plain text body" "<h1>Email HTML body</h1>"

global

zxsuite mobile setABQMessage global blocked|quarantined default|a valid locale [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

type(M)

String

blocked|quarantined

locale(M)

String

default|a valid locale

from(O)

String

reply_to(O)

String

subject(O)

String

body_plain(O)

String

body_plain_file(O)

String

body_html(O)

String

body_html_file(O)

String

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

zxsuite mobile addAbqMessage global blocked default u0@example.com admin@example.com "Email subject" "Email plain text body" "<h1>Email HTML body</h1>"

setProperty

zxsuite mobile setProperty property_name property_value

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

property_name(M)

String

property_value(M)

String

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

Example:
zxsuite mobile setProperty
this command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]

setProvisioning

zxsuite mobile setProvisioning account|cos target key value

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

target_type(M)

Multiple choice

account|cos

target(M)

String

key(M)

String

value(M)

String

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

Example:
zxsuite mobile setProvisioning account john@example.com AllowDesktopSync true

Sets value true to property AllowDesktopSync for John’s account

setSharedFolderSync

zxsuite mobile setSharedFolderSync account item_id true|false

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(M)

String

item_id(M)

Integer

allowed(M)

Boolean

true|false

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

Example:
zxsuite mobile setSharedFolderSync user@example.com 300 TRUE
Example:
zxsuite mobile setSharedFolderSync 3da53b28-d96d-4966-ae79-907b8553c13e 300 TRUE

ZxPowerstore CLI Commands

testS3Connection

zxsuite core testS3Connection s3BucketConfigurationUuid [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

s3BucketConfigurationUuid(M)

String

storeType(O)

String

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

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

Example:
zxsuite core testS3Connection

doCheckBlobs

zxsuite powerstore doCheckBlobs start [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

volumes(O)

String[,..]

message1,hsm[,…​]

mailbox_ids(O)

Integer[,..]

2,9,27

missing_blobs_crosscheck(O)

Boolean

true|false

true

traced(O)

Boolean

true|false

false

fix_incorrect_compressed_digests(O)

Boolean

true|false

false

missing_blob_delete_item(O)

Boolean

true|false

false

check_digests(O)

Boolean

true|false

false

items(O)

String

zimbra|drive|all

all

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

Usage examples:

Example:
zxsuite powerstore doCheckBlobs start

Perform a BLOB coherency check on all message volumes

Example:
zxsuite powerstore doCheckBlobs start volumes message1,hsm

Perform a BLOB coherency check on volumes message1 and hsm

Example:
zxsuite powerstore doCheckBlobs start mailbox_ids 2,9,27

Perform a BLOB coherency check on mailboxes 2,9 and 27

Example:
zxsuite powerstore doCheckBlobs start missing_blobs_crosscheck false

Perform a BLOB coherency check without checking on other volumes

Example:
zxsuite powerstore doCheckBlobs start traced true

Perform a BLOB coherency check, logging even the correct checked items

Example:
zxsuite powerstore doCheckBlobs start fix_incorrect_compressed_digests true

This option verifies if the digest (hash) of every object is correct and eventually fixes it

Example:
zxsuite powerstore doCheckBlobs start check_digests true

Verifies if the blob digests are correct

Example:
zxsuite powerstore doCheckBlobs start missing_blob_delete_item true

Remove entries from the database that are missing their blob file in the hsm volume

Volume names are case sensitive. Run 'zxsuite powerstore getAllVolumes' for a complete list of the volumes.

Alibaba

zxsuite powerstore doCreateVolume Alibaba volume_name primary|secondary [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volume_name(M)

String

volume_type(M)

Multiple choice

primary|secondary

bucket_name(O)

String

Bucket name

url(O)

String

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

region(O)

String

Alibaba OSS Region

access_key(O)

String

Service username

secret(O)

String

Service password

volume_prefix(O)

String

Prefix to the server id used in all objects keys (Volume configuration)

bucket_configuration_id(O)

String

UUID for already existing service credentials (zxsuite config global get attribute s3BucketConfigurations)

prefix(O)

String

Prefix added to blobs keys (Bucket configuration)

centralized(O)

Boolean

true|false

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

Example:
zxsuite powerstore doCreateVolume Alibaba volumeName primary bucket_name bucket access_key accessKey secret secretKet url http://host/service
Example:
zxsuite powerstore doCreateVolume Alibaba volumeName primary bucket_configuration_id uuid

Centralized

zxsuite powerstore doCreateVolume Centralized server_name volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

server_name(M)

String

volume_name(M)

String

volume_type(O)

Multiple choice

primary|secondary

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

zxsuite powerstore doCreateVolume hostname volumeName

Ceph

zxsuite powerstore doCreateVolume Ceph volume_name primary|secondary [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volume_name(M)

String

volume_type(M)

Multiple choice

primary|secondary

bucket_name(O)

String

Bucket name

url(O)

String

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

access_key(O)

String

Service username

secret(O)

String

Service password

volume_prefix(O)

String

Prefix to the server id used in all objects keys (Volume configuration)

bucket_configuration_id(O)

String

UUID for already existing service credentials (zxsuite config global get attribute s3BucketConfigurations)

prefix(O)

String

Prefix added to blobs keys (Bucket configuration)

centralized(O)

Boolean

true|false

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

Example:
zxsuite powerstore doCreateVolume Ceph volumeName primary bucket_name bucket access_key accessKey secret secretKet url http://host/service
Example:
zxsuite powerstore doCreateVolume Ceph volumeName primary bucket_configuration_id uuid

Cloudian

zxsuite powerstore doCreateVolume Cloudian volume_name primary|secondary [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volume_name(M)

String

volume_type(M)

Multiple choice

primary|secondary

bucket_name(O)

String

Bucket name

url(O)

String

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

access_key(O)

String

Service username

secret(O)

String

Service password

volume_prefix(O)

String

Prefix to the server id used in all objects keys (Volume configuration)

bucket_configuration_id(O)

String

UUID for already existing service credentials (zxsuite config global get attribute s3BucketConfigurations)

prefix(O)

String

Prefix added to blobs keys (Bucket configuration)

centralized(O)

Boolean

true|false

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

Example:
zxsuite powerstore doCreateVolume Cloudian volumeName primary bucket_name bucket access_key accessKey secret secretKet url http://host/service
Example:
zxsuite powerstore doCreateVolume Cloudian volumeName primary bucket_configuration_id uuid

CustomS3

zxsuite powerstore doCreateVolume CustomS3 volume_name primary|secondary [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volume_name(M)

String

volume_type(M)

Multiple choice

primary|secondary

bucket_name(O)

String

Bucket name

url(O)

String

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

access_key(O)

String

Service username

secret(O)

String

Service password

volume_prefix(O)

String

Prefix to the server id used in all objects keys (Volume configuration)

bucket_configuration_id(O)

String

UUID for already existing service credentials (zxsuite config global get attribute s3BucketConfigurations)

prefix(O)

String

Prefix added to blobs keys (Bucket configuration)

centralized(O)

Boolean

true|false

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

Example:
zxsuite powerstore doCreateVolume CustomS3 volumeName primary bucket_name bucket access_key accessKey secret secretKet url http://host/service
Example:
zxsuite powerstore doCreateVolume CustomS3 volumeName primary bucket_configuration_id uuid

EMC

zxsuite powerstore doCreateVolume EMC volume_name primary|secondary [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volume_name(M)

String

volume_type(M)

Multiple choice

primary|secondary

bucket_name(O)

String

Bucket name

url(O)

String

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

access_key(O)

String

Service username

secret(O)

String

Service password

volume_prefix(O)

String

Prefix to the server id used in all objects keys (Volume configuration)

bucket_configuration_id(O)

String

UUID for already existing service credentials (zxsuite config global get attribute s3BucketConfigurations)

prefix(O)

String

Prefix added to blobs keys (Bucket configuration)

centralized(O)

Boolean

true|false

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

Example:
zxsuite powerstore doCreateVolume EMC volumeName primary bucket_name bucket access_key accessKey secret secretKet url http://host/service
Example:
zxsuite powerstore doCreateVolume EMC volumeName primary bucket_configuration_id uuid

FileBlob

zxsuite powerstore doCreateVolume FileBlob volume_name primary|secondary volume_path [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volume_name(M)

String

volume_type(M)

Multiple choice

primary|secondary

volume_path(M)

Path

volume_compressed(O)

Boolean

true|false

false

compression_threshold_bytes(O)

Long

4096

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

Example:
zxsuite powerstore doCreateVolume FileBlob volumeName secondary /path/to/store volume_compressed true compression_threshold_bytes 4096

OpenIO

zxsuite powerstore doCreateVolume OpenIO volume_name primary|secondary url account namespace [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volume_name(M)

String

volume_type(M)

Multiple choice

primary|secondary

url(M)

String

account(M)

String

namespace(M)

String

proxy_port(O)

Integer

account_port(O)

Integer

ecd(O)

String

centralized(O)

Boolean

true|false

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

Example:
zxsuite powerstore doCreateVolume OpenIO volumeName primary http://host/service accountName namespaceString proxy_port 6006 account_port 6009

S3

zxsuite powerstore doCreateVolume S3 Name of the zimbra store primary|secondary [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volume_name(M)

String

Name of the zimbra store

volume_type(M)

Multiple choice

primary|secondary

bucket_name(O)

String

Amazon AWS bucket

access_key(O)

String

Service username

secret(O)

String

Service password

volume_prefix(O)

String

Prefix to the server id used in all objects keys (Volume configuration)

bucket_configuration_id(O)

String

UUID for already existing S3 service credentials (zxsuite config global get attribute s3BucketConfigurations)

region(O)

String

Amazon AWS Region

url(O)

String

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

prefix(O)

String

Prefix added to blobs keys (Bucket configuration)

use_infrequent_access(O)

Boolean

true|false

infrequent_access_threshold(O)

String

use_intelligent_tiering(O)

Boolean

true|false

centralized(O)

Boolean

true|false

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

S3 AWS Bucket:

Example:
zxsuite powerstore doCreateVolume S3 volumeName primary bucket_name bucket access_key accessKey secret secretKey prefix objectKeysPrefix region EU_WEST_1 use_infrequent_access TRUE infrequent_access_threshold 4096

S3 compatible object storage:

Example:
zxsuite powerstore doCreateVolume S3 volumeName primary bucket_name bucket access_key accessKey secret secretKey url http://host/service

Using existing bucket configuration:

Example:
zxsuite powerstore doCreateVolume S3 volumeName primary bucket_configuration_id 316813fb-d3ef-4775-b5c8-f7d236fc629c

ScalityS3

zxsuite powerstore doCreateVolume ScalityS3 volume_name primary|secondary [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volume_name(M)

String

volume_type(M)

Multiple choice

primary|secondary

bucket_name(O)

String

Bucket name

url(O)

String

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

access_key(O)

String

Service username

secret(O)

String

Service password

volume_prefix(O)

String

Prefix to the server id used in all objects keys (Volume configuration)

bucket_configuration_id(O)

String

UUID for already existing service credentials (zxsuite config global get attribute s3BucketConfigurations)

prefix(O)

String

Prefix added to blobs keys (Bucket configuration)

centralized(O)

Boolean

true|false

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

Example:
zxsuite powerstore doCreateVolume ScalityS3 volumeName primary bucket_name bucket access_key accessKey secret secretKet url http://host/service
Example:
zxsuite powerstore doCreateVolume ScalityS3 volumeName primary bucket_configuration_id uuid

Swift

zxsuite powerstore doCreateVolume Swift volume_name primary|secondary url username password [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volume_name(M)

String

volume_type(M)

Multiple choice

primary|secondary

url(M)

String

username(M)

String

password(M)

String

authentication_method(O)

String

BASIC|KEYSTONE|KEYSTONE_V3|TEMPAUTH|EXTERNAL

authentication_method_scope(O)

String

DEFAULT|PROJECT_NAME|DOMAIN_NAME

tenant_id(O)

String

tenant_name(O)

String

domain(O)

String

proxy_host(O)

String

proxy_port(O)

Integer

proxy_username(O)

String

proxy_password(O)

String

public_host(O)

String

private_host(O)

String

region(O)

String

max_delete_objects_count(O)

Integer

Number of object in a single bulk delete request

500

centralized(O)

Boolean

true|false

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

Example:
zxsuite powerstore doCreateVolume Swift volumeName primary http://host/service accountName password max_delete_objects_count 100

doDeduplicate

zxsuite powerstore doDeduplicate volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volume_name(M)

String[,..]

dry_run(O)

Boolean

true|false

false

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

Example:
zxsuite powerstore doDeduplicate secondvolume

Starts a deduplication on volume secondvolume

doDeleteDrivePreviews

zxsuite powerstore doDeleteDrivePreviews message1,hsm[,…​] [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volumes(M)

String[,..]

message1,hsm[,…​]

dryrun(O)

Boolean

true|false

true

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

Example:
zxsuite powerstore doDeleteDrivePreviews volumes message1,hsm

Deletes drive previews on volumes message1 and hsm

Example:
zxsuite powerstore doDeleteDrivePreviews volumes all

Deletes drive previews on all volumes except the current primary

This is a cleanup operation. Previews are not deleted if the command is executed against the Drive Current Primary Volume because Drive use this volume to manage the previews.

doDeleteVolume

zxsuite powerstore doDeleteVolume volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volume_name(M)

String

ignore_drive(O)

Boolean

true|false

false

delete_drive_previews(O)

Boolean

true|false

true

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

Example:
zxsuite powerstore doDeleteVolume hsm

Deletes volume with name hsm

doMailboxMove

zxsuite powerstore doMailboxMove destinationHost [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

destinationHost(M)

String

accounts(O)

String[,..]

john@example.com,smith@example.com[,…​]

domains(O)

String[,..]

example.com,test.com[,…​]

input_file(O)

String

stages(O)

String[,..]

blobs|backup|data|account data=blobs+backup[,…​]

blobs,backup,account

compress(O)

Boolean

true|false

true

checkDigest(O)

Boolean

if false skip digest calculation and check

false

overwrite(O)

Boolean

true|false

true

threads(O)

Integer

1

hsm(O)

Boolean

true|false

false

notifications(O)

Email Address

ignore_partial(O)

Boolean

true|false

false

drop_network_backup(O)

Boolean

true|false

false

read_error_threshold(O)

Integer

blob_destination_volume(O)

String

current_primary|current_secondary|6

current_primary

drive_destination_volume(O)

String

drive_primary|drive_secondary|same_as_blob|7

same_as_blob

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

Example:
zxsuite powerstore doMailboxMove mail2.example.com accounts john@example.com stages data,account

Move mailbox for account john@example.com to mail2.example.com host

doMoveBlobs

zxsuite powerstore doMoveBlobs start [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

custom_policy(O)

String

none

read_error_threshold(O)

Integer

perform_deduplicate(O)

Boolean

true|false

false

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

Example:
zxsuite powerstore doMoveBlobs

Move items between the Current Primary Store and the Current Secondary Store according to the default HSM policy

doPurgeMailboxes

zxsuite powerstore doPurgeMailboxes Mailbox id or "all" to delete all mailboxes moved more than 30 days ago [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

mailbox(M)

String

Mailbox id or "all" to delete all mailboxes moved more than 30 days ago

ignore_retention(O)

Boolean

Also remove mailboxes moved in last 30 days

purge_orphan(O)

Boolean

Also remove orphan mailboxes moved or synced

notifications(O)

Email Address[,..]

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

Example:
zxsuite powerstore doPurgeMailboxes all

Delete mailboxes moved more than 30 days ago

Example:
zxsuite powerstore doPurgeMailboxes all ignore_retention true

Delete every moved mailbox

doRemoveHsmPolicy

zxsuite powerstore doRemoveHsmPolicy hsm_policy

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

hsm_policy(M)

String

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

Example:
zxsuite powerstore doRemoveHsmPolicy "message, document:before:-2month"

Remove the HSM policy: "message, document:before:-2month"

doRemoveOrphanedBlobs

zxsuite powerstore doRemoveOrphanedBlobs start [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

volumes(O)

String[,..]

message1,hsm[,…​]

dry_run(O)

Boolean

true|false

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

Example:
zxsuite powerstore doRemoveOrphanedBlobs

doRestartService

zxsuite powerstore doRestartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite powerstore doRestartService

doStartService

zxsuite powerstore doStartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite powerstore doStartService

doStopAllOperations

zxsuite powerstore doStopAllOperations

Example:
zxsuite powerstore doStopAllOperations

Stops all running and queued operations

doStopOperation

zxsuite powerstore doStopOperation operation_uuid

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

operation_uuid(M)

Uuid

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

Example:
zxsuite powerstore doStopOperation 30ed9eb9-eb28-4ca6-b65e-9940654b8601

Stops operation with id = 30ed9eb9-eb28-4ca6-b65e-9940654b8601

doStopService

zxsuite powerstore doStopService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite powerstore doStopService

Alibaba

zxsuite powerstore doUpdateVolume Alibaba current_volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

current_volume_name(M)

String

volume_name(O)

String

volume_type(O)

String

primary|secondary

volume_prefix(O)

String

Prefix to the server id used in all objects keys

bucket_configuration_id(O)

String

UUID for already existing service credentials (zxsuite config global get attribute s3BucketConfigurations)

current_volume(O)

Boolean

true|false

false

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

Example:
zxsuite powerstore doUpdateVolume Alibaba

Ceph

zxsuite powerstore doUpdateVolume Ceph current_volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

current_volume_name(M)

String

volume_name(O)

String

volume_type(O)

String

primary|secondary

volume_prefix(O)

String

Prefix to the server id used in all objects keys

bucket_configuration_id(O)

String

UUID for already existing service credentials (zxsuite config global get attribute s3BucketConfigurations)

current_volume(O)

Boolean

true|false

false

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

Example:
zxsuite powerstore doUpdateVolume Ceph

Cloudian

zxsuite powerstore doUpdateVolume Cloudian current_volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

current_volume_name(M)

String

volume_name(O)

String

volume_type(O)

String

primary|secondary

volume_prefix(O)

String

Prefix to the server id used in all objects keys

bucket_configuration_id(O)

String

UUID for already existing service credentials (zxsuite config global get attribute s3BucketConfigurations)

current_volume(O)

Boolean

true|false

false

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

Example:
zxsuite powerstore doUpdateVolume Cloudian

CustomS3

zxsuite powerstore doUpdateVolume CustomS3 current_volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

current_volume_name(M)

String

volume_name(O)

String

volume_type(O)

String

primary|secondary

volume_prefix(O)

String

Prefix to the server id used in all objects keys

bucket_configuration_id(O)

String

UUID for already existing service credentials (zxsuite config global get attribute s3BucketConfigurations)

current_volume(O)

Boolean

true|false

false

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

Example:
zxsuite powerstore doUpdateVolume CustomS3

EMC

zxsuite powerstore doUpdateVolume EMC current_volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

current_volume_name(M)

String

volume_name(O)

String

volume_type(O)

String

primary|secondary

volume_prefix(O)

String

Prefix to the server id used in all objects keys

bucket_configuration_id(O)

String

UUID for already existing service credentials (zxsuite config global get attribute s3BucketConfigurations)

current_volume(O)

Boolean

true|false

false

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

Example:
zxsuite powerstore doUpdateVolume EMC

FileBlob

zxsuite powerstore doUpdateVolume FileBlob current_volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

current_volume_name(M)

String

volume_type(O)

String

primary|secondary|index

volume_name(O)

String

volume_path(O)

Path

current_volume(O)

Boolean

true|false

false

volume_compressed(O)

Boolean

true|false

compression_threshold(O)

String

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

Example:
zxsuite powerstore doUpdateVolume FileBlob

OpenIO

zxsuite powerstore doUpdateVolume OpenIO current_volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

current_volume_name(M)

String

volume_name(O)

String

volume_type(O)

String

primary|secondary

url(O)

String

account(O)

String

namespace(O)

String

proxy_port(O)

Integer

account_port(O)

Integer

current_volume(O)

Boolean

true|false

false

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

Example:
zxsuite powerstore doUpdateVolume OpenIO

S3

zxsuite powerstore doUpdateVolume S3 current_volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

current_volume_name(M)

String

volume_name(O)

String

volume_type(O)

String

primary|secondary

volume_prefix(O)

String

Prefix to the server id used in all objects keys

bucket_configuration_id(O)

String

UUID for already existing service credentials (zxsuite config global get attribute s3BucketConfigurations)

use_infrequent_access(O)

Boolean

true|false

infrequent_access_threshold(O)

String

use_intelligent_tiering(O)

Boolean

true|false

current_volume(O)

Boolean

true|false

false

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

Example:
zxsuite powerstore doUpdateVolume S3

ScalityS3

zxsuite powerstore doUpdateVolume ScalityS3 current_volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

current_volume_name(M)

String

volume_name(O)

String

volume_type(O)

String

primary|secondary

volume_prefix(O)

String

Prefix to the server id used in all objects keys

bucket_configuration_id(O)

String

UUID for already existing S3 service credentials (zxsuite config global get attribute s3BucketConfigurations)

current_volume(O)

Boolean

true|false

false

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

Example:
zxsuite powerstore doUpdateVolume ScalityS3

Swift

zxsuite powerstore doUpdateVolume Swift current_volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

current_volume_name(M)

String

volume_name(O)

String

volume_type(O)

String

primary|secondary

url(O)

String

username(O)

String

password(O)

String

authentication_method(O)

String

BASIC|KEYSTONE|KEYSTONE_V3|TEMPAUTH|EXTERNAL

authentication_method_scope(O)

String

DEFAULT|PROJECT_NAME|DOMAIN_NAME

tenant_id(O)

String

tenant_name(O)

String

domain(O)

String

proxy_host(O)

String

proxy_port(O)

Integer

proxy_username(O)

String

proxy_password(O)

String

public_host(O)

String

private_host(O)

String

region(O)

String

maxDeleteObjectsCount(O)

Integer

Number of object in a single bulk delete request

500

current_volume(O)

Boolean

true|false

false

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

Example:
zxsuite powerstore doUpdateVolume Swift

doVolumeToVolumeMove

zxsuite powerstore doVolumeToVolumeMove source_volume_name destination_volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

source_volume_name(M)

String

destination_volume_name(M)

String

only_drive(O)

Boolean

true|false

false

read_error_threshold(O)

Integer

policy(O)

String

none

perform_deduplicate(O)

Boolean

true|false

false

delete_drive_previews(O)

Boolean

true|false

true

overwrite_index_destination(O)

Boolean

true|false

false

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

Example:
zxsuite powerstore doVolumeToVolumeMove sourceVolume destVolume

Moves the whole sourceVolume to destVolume

getAllOperations

zxsuite powerstore getAllOperations [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

verbose(O)

Boolean

true|false

false

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

Example:
zxsuite powerstore getAllOperations

Shows all running and queued operations

getAllVolumes

zxsuite powerstore getAllVolumes

Example:
zxsuite powerstore getAllVolumes

Shows info about all the volumes

getHsmPolicy

zxsuite powerstore getHsmPolicy

Example:
zxsuite powerstore getHsmPolicy

Prints all the policies

getMovedMailboxes

zxsuite powerstore getMovedMailboxes

Example:
zxsuite powerstore getMovedMailboxes

getNonLocalMailboxes

zxsuite powerstore getNonLocalMailboxes

Example:
zxsuite powerstore getNonLocalMailboxes

getProperty

zxsuite powerstore getProperty [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

verbose(O)

Boolean

true|false

property_name(O)

String[,..]

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

Example:
zxsuite powerstore getProperty
this command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]

getServices

zxsuite powerstore getServices

Example:
zxsuite powerstore getServices

getVolumeStats

zxsuite powerstore getVolumeStats volume_name [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volume_name(M)

String

show_volume_size(O)

Boolean

true|false

false

show_blob_num(O)

Boolean

true|false

false

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

BE CAREFUL show_volume_size and show_blob_num options are IO intensive and thus disabled by default

Example:
zxsuite powerstore getVolumeStats volumeName

Shows stats for the volume with name equal to volumeName

add

zxsuite powerstore Indexing content-extraction-tool add endpoint [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

endpoint(M)

String

server(O)

String

global(O)

Boolean

true|false

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

Add tika endpoint for this mailbox store:

Example:
zxsuite powerstore Indexing content-extraction-tool add http://10.66.81.35:9998/tika

Add tika endpoint for mailbox store store1.zimbra.com:

Example:
zxsuite powerstore Indexing content-extraction-tool add http://10.66.81.35:9998/tika server store1.zimbra.com

Add tika endpoint for all mailbox stores (applies only to mailbox stores that don’t have any endpoint specified):

Example:
zxsuite powerstore Indexing content-extraction-tool add http://10.66.81.35:9998/tika global true

list

zxsuite powerstore Indexing content-extraction-tool list [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

server(O)

String

global(O)

Boolean

true|false

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

List tika endpoints for this mailbox store:

Example:
zxsuite powerstore Indexing content-extraction-tool list

List tika endpoints for mailbox store store1.zimbra.com:

Example:
zxsuite powerstore Indexing content-extraction-tool list server store1.zimbra.com

List tika endpoints for all mailbox stores that don’t have any endpoint specified:

Example:
zxsuite powerstore Indexing content-extraction-tool list global true

remove

zxsuite powerstore Indexing content-extraction-tool remove endpoint [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

endpoint(M)

String

server(O)

String

global(O)

Boolean

true|false

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

Remove tika endpoint for this mailbox store:

Example:
zxsuite powerstore Indexing content-extraction-tool remove http://10.66.81.35:9998/tika

Remove tika endpoint for mailbox store store1.zimbra.com:

Example:
zxsuite powerstore Indexing content-extraction-tool remove http://10.66.81.35:9998/tika server store1.zimbra.com

Remove tika endpoint used by all mailbox stores that don’t have any endpoint specified:

Example:
zxsuite powerstore Indexing content-extraction-tool remove http://10.66.81.35:9998/tika global true

monitor

zxsuite powerstore monitor operation_uuid [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

operation_uuid(M)

Uuid

operation_host(O)

String

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

Example:
zxsuite powerstore monitor

runBulkDelete

zxsuite powerstore runBulkDelete [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

volumes(O)

String[,..]

message1,message2[,…​]

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

Example:
zxsuite powerstore runBulkDelete

+setHsmPolicy

zxsuite powerstore +setHsmPolicy hsm_policy

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

hsm_policy(M)

String

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

Example:
zxsuite powerstore +sethsmpolicy "message, document:before:-2month"

Adds a new HSM policy

setHSMPolicy

zxsuite powerstore setHSMPolicy hsm_policy

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

hsm_policy(M)

String

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

zxsuite powerstore +sethsmpolicy "message, document:before:-2month"

Sets the new default HSM policy

setProperty

zxsuite powerstore setProperty property_name property_value

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

property_name(M)

String

property_value(M)

String

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

Example:
zxsuite powerstore setProperty
this command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]

ZxTeam CLI Commands

addOwner

zxsuite team addOwner conversation_id owner

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

conversation_id(M)

String

Group, Space, or Channel ID

owner(M)

Account Name

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

Example:
zxsuite team addOwner  aced5e2e-f457-4d30-a3fb-9b18fac486a6@example.com user2@example.com

user2@example.com becomes an owner of the rooms with conversation_id aced5e2e-f457-4d30-a3fb-9b18fac486a6@example.com

clusterStatus

zxsuite team clusterStatus

Example:
zxsuite team clusterStatus

doConversationsMessagesCleanup

zxsuite team doConversationsMessagesCleanup

Example:
zxsuite team doConversationsMessagesCleanup

doClearChatDB

zxsuite team doClearChatDB start [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

action(M)

String

start

iamsure(O)

Boolean

true|false

false

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

Example:
zxsuite team doClearChatDB

doDeployTeamZimlet

zxsuite team doDeployTeamZimlet

Example:
zxsuite team doDeployTeamZimlet

Deploy Zextras Suite Team

doImportChannels

zxsuite team doImportChannels [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

delete_destination_before_import(O)

Boolean

true|false

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

Example:
zxsuite team doImportChannels

doMoveAllRooms

zxsuite team doMoveAllRooms [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

destination(O)

String

mail3.example.com

force(O)

Boolean

false

false

notifications(O)

Email Address[,..]

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

zxsuite --progress team doMoveAllRooms server3.example.com notifications user1@example.com,user2@example.com

zxsuite --progress team doMoveAllRooms server3.example.com force true

Move every room to server3 and sends notifications to user1@example.com and user2@example.com

doMoveRoom

zxsuite team doMoveRoom 0b313912-1334-43d6-b1ad-ec8500fa1505@example.com mail3.example.com [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

room-id(M)

String

0b313912-1334-43d6-b1ad-ec8500fa1505@example.com

destination(M)

String

mail3.example.com

force(O)

Boolean

false

false

notifications(O)

Email Address[,..]

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

zxsuite --progress team doMoveRoom ROOM-ID server3.example.com notifications user1@example.com, user2@example.com

Move room ROOM-ID to server3 and sends notifications to user1@example.com and user2@example.com

doRestartService

zxsuite team doRestartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite team doRestartService

doStartService

zxsuite team doStartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite team doStartService

doStopService

zxsuite team doStopService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite team doStopService

doUsersCleanup

zxsuite team doUsersCleanup

Example:
zxsuite team doUsersCleanup

dumpSessions

zxsuite team dumpSessions

Example:
zxsuite team dumpSessions

flushConversationsCache

zxsuite team flushConversationsCache

Example:
zxsuite team flushConversationsCache

getServices

zxsuite team getServices

Example:
zxsuite team getServices

add

zxsuite team iceServer add turn:turn.example.com:3478?transport=udp [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

url(M)

String

turn:turn.example.com:3478?transport=udp

username(O)

String

myuser

credential(O)

String

mysecretkey

account(O)

String

user@example.com

cos(O)

String

default

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

Example:
zxsuite team iceServer add turn:turn.example.com credential mysecret username myuser
Example:
zxsuite team iceServer add turn:turn.example.com credential mysecret username myuser account testaccount@example.com

get

zxsuite team iceServer get [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

account(O)

String

user@example.com

cos(O)

String

default

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

Example:
zxsuite team iceServer get
Example:
zxsuite team iceServer get cos default

remove

zxsuite team iceServer remove turn:turn.example.com:3478?transport=udp [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

url(M)

String

turn:turn.example.com:3478?transport=udp

username(O)

String

myuser

credential(O)

String

mysecretkey

account(O)

String

user@example.com

cos(O)

String

default

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

Example:
zxsuite team iceServer remove turn:turn.example.com credential mysecret username myuser
Example:
zxsuite team iceServer remove turn:turn.example.com credential mysecret username myuser account testaccount@example.com

monitor

zxsuite team monitor operation_uuid [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

operation_uuid(M)

Uuid

operation_host(O)

String

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

Example:
zxsuite team monitor

rooms

zxsuite team rooms [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

members(O)

Boolean

true|false

false

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

Example:
zxsuite team rooms

get

zxsuite team space get

Example:
zxsuite team space get

add

zxsuite team video-server add videoserver.example.com [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

host(M)

String

videoserver.example.com

port(O)

Integer

8188

secret(O)

String

api-secret

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

zxsuite team video-server add videoserver.example.com

zxsuite team video-server add videoserver.example.com port 12003 secret api-secret

remove

zxsuite team video-server remove videoserver.example.com [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

host(M)

String

videoserver.example.com

port(O)

Integer

2003

8188

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

zxsuite team video-server remove videoserver.example.com

zxsuite team video-server remove videoserver.example.com port 12345

ZxUpdate CLI Commands

doStartService

zxsuite update doStartService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite update doStartService

doStopService

zxsuite update doStopService service_name

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

service_name(M)

String

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

Example:
zxsuite update doStopService

download

zxsuite update download

Example:
zxsuite update download

enable

zxsuite update enable

Example:
zxsuite update enable

getServices

zxsuite update getServices

Example:
zxsuite update getServices

info

zxsuite update info

Example:
zxsuite update info

start

zxsuite update start [param VALUE[,VALUE]]

PARAMETER LIST

NAME

TYPE

EXPECTED VALUES

DEFAULT

version(O)

String

latest|2.2.1

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

Example:
zxsuite update start [version (latest|x.x.x)]