ZxDrive CLI Commands

zxsuite drive 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@ex ample.com,sys tem-account@exa mple.com,test.e xample.com[,…​]

dryRun(O)

Boolean

true|false

true

n otifications(O)

Email Address[,..]

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

Usage Example

zxsuite drive doDeleteBriefcaseData admin@example.com dryRun false

Perform a briefcase deletion for a system account

Usage Example

zxsuite drive doDeleteBriefcaseData user@example.com dryRun false

Perform a briefcase deletion for an account

Usage Example

zxsuite drive doDeleteBriefcaseData demo.example.com dryRun false

Perform a briefcase deletion for an entire domain

Usage 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

Usage 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

zxsuite drive doDeployDriveZimlet
zxsuite drive doDeployDriveZimlet

Usage Example

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

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

target(M)

String[,..]

dryRun(O)

Boolean

true|false

false

d eleteSources(O)

Boolean

true|false

false

override(O)

Boolean

true|false

false

i temRevisions(O)

Boolean

true|false

true

sendShareN otifications(O)

Boolean

true|false

false

n otifications(O)

Email Address[,..]

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

Usage Example

zxsuite drive doImportBriefcase admin@example.com

Perform a system account migration

Usage Example

zxsuite drive doImportBriefcase user@example.com

Perform an account migration

Usage Example

zxsuite drive doImportBriefcase demo.example.com

Perform an entire domain migration

Usage Example

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

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

Usage 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

Usage Example

zxsuite drive doImportBriefcase user@example.com deleteSource false

Perform an account copy-migration

Usage Example

zxsuite drive doImportBriefcase user@example.com override true

Perform an account migration overriding items that already exists

Usage Example

zxsuite drive doImportBriefcase user@example.com itemRevision false

Perform an account migration without importing each items revision

Usage Example

zxsuite drive doImportBriefcase user@example.com sendShareNotifications true

Perform an account migration sending share notifications when imported one

zxsuite drive doRestartService
zxsuite drive doRestartService *service_name*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

serv ice_name(M)

String

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

Usage Example

zxsuite drive doRestartService
zxsuite drive doStartService
zxsuite drive doStartService *service_name*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

serv ice_name(M)

String

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

Usage Example

zxsuite drive doStartService
zxsuite drive doStopService
zxsuite drive doStopService *service_name*

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

serv ice_name(M)

String

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

Usage Example

zxsuite drive doStopService
zxsuite drive dumpSessions
zxsuite drive dumpSessions

Usage Example

zxsuite drive dumpSessions
zxsuite drive 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

ma il1.example.com

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

Usage Example

zxsuite drive getQuota
zxsuite drive getServices
zxsuite drive getServices

Usage Example

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

Parameter List

NAME

TYPE

EXPECTED VALUES

DEFAULT

operat ion_uuid(M)

Uuid

op eration_host(O)

String

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

Usage Example

zxsuite drive monitor