ZxMobile CLI Commands
zxsuite mobile ABQ allow
zxsuite mobile ABQ allow *device_id* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
d evice_id(M) |
String |
||
account(O) |
String |
27ee8dd9-d81 3-4ca7-a988-580 df0027a58|us er1@example.com |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile ABQ allow
zxsuite mobile ABQ block
zxsuite mobile ABQ block *device_id* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
d evice_id(M) |
String |
||
account(O) |
String |
27ee8dd9-d81 3-4ca7-a988-580 df0027a58|us er1@example.com |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile ABQ block
zxsuite mobile ABQ delete
zxsuite mobile ABQ delete *device_id* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
d evice_id(M) |
String |
||
account(O) |
String |
27ee8dd9- d813-4ca7-a988- 580df0027a58/us er1@example.com |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile ABQ delete
zxsuite mobile ABQ 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
Usage Example
zxsuite mobile ABQ deleteRule "android.*" domain example.com
zxsuite mobile ABQ import
zxsuite mobile ABQ import *Path to file*
*Allowed|Blocked|Quarantined*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
in put_file(M) |
String |
Path to file |
|
status(M) |
String |
Allowed|Bloc ked|Quarantined |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile ABQ import /path/to/file Allowed
zxsuite mobile ABQ list
zxsuite mobile ABQ list [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
status(O) |
String |
Allowed|Bloc ked|Quarantined |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile ABQ list
zxsuite mobile ABQ 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
Usage Example
zxsuite mobile ABQ listRules
zxsuite mobile ABQ set
zxsuite mobile ABQ set *device_id* *Allowed|Blocked|Quarantined*
[param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
d evice_id(M) |
String |
||
status(M) |
String |
Allowed|Bloc ked|Quarantined |
|
account(O) |
String |
27ee8dd9-d81 3-4ca7-a988-580 df0027a58|us er1@example.com |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile ABQ set
zxsuite mobile ABQ 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
Usage Example
zxsuite mobile ABQ setNotificationInterval 45m
Set notification of new quarantined devices every 6 hours
Usage Example
zxsuite mobile ABQ setNotificationInterval 6h
Set notification of new quarantined devices once every day
Usage Example
zxsuite mobile ABQ setNotificationInterval 1d
Disable notifications of new quarantined devices
Usage Example
zxsuite mobile ABQ setNotificationInterval 0
zxsuite mobile ABQ 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|Bloc ked|Quarantined |
|
order(M) |
Long |
||
domain(O) |
String |
Domain name|id |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile ABQ setRule "android.*" Blocked 10 domain example.com
zxsuite mobile addressBook add 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-d81 3-4ca7-a988-580 df0027a58|us er1@example.com |
|
folder(M) |
String |
all|folder id |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile addressBook add domain example.com user@example.com 2
zxsuite mobile addressBook add 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-d81 3-4ca7-a988-580 df0027a58|us er1@example.com |
|
folder(M) |
String |
all|folder id |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile addressBook add global user@example.com 7
zxsuite mobile addressBook list domain
zxsuite mobile addressBook list domain *domain*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile addressBook list domain example.com
zxsuite mobile addressBook list global
zxsuite mobile addressBook list global
Usage Example
zxsuite mobile addressBook list global
zxsuite mobile addressBook remove 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-d81 3-4ca7-a988-580 df0027a58|us er1@example.com |
|
folder(M) |
String |
all|folder id |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile addressBook remove domain example.com user@example.com 2
zxsuite mobile addressBook remove 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-d81 3-4ca7-a988-580 df0027a58|us er1@example.com |
|
folder(O) |
String |
all|folder id |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile addressBook remove global user@example.com 2
zxsuite mobile deleteABQMessage 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 |
bloc ked|quarantined |
|
locale(M) |
String |
default|a valid locale |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile deleteABQMessage domain example.com default
zxsuite mobile deleteABQMessage global
zxsuite mobile deleteABQMessage global *blocked|quarantined*
*default|a valid locale*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
type(M) |
String |
bloc ked|quarantined |
|
locale(M) |
String |
default|a valid locale |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile deleteABQMessage global blocked it
zxsuite mobile 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 |
||
l og_level(M) |
Multiple choice |
trace|debug|inf o|warn|err|crit |
|
l og_file(M) |
Path |
||
window_size(O) |
Integer |
a value > 0 |
(M) == mandatory parameter, (O) == optional parameter
Usage 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
Usage 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.
zxsuite mobile 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 |
---|---|---|
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
Usage 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’.
Usage 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.
zxsuite mobile doDeleteEASFilter
zxsuite mobile doDeleteEASFilter *id*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
id(M) |
Integer |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile doDeleteEASFilter 2
Removes the filter with id = 2.
To show a list of the filters, use the
zxsuite mobile getAllEASFilters
command.
zxsuite mobile 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
Usage 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.
zxsuite mobile doRemoveDevice
zxsuite mobile doRemoveDevice *account* *device_id*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
Account Name |
||
d evice_id(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile doRemoveDevice john@example.com Appl79032X2WA4S
Removes John’s Appl79032X2WA4S device SyncState
zxsuite mobile doRemoveLogger
zxsuite mobile doRemoveLogger *logger_id|"all_loggers"*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
l ogger_id(M) |
Multiple choice |
logger_i d|”all_loggers” |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile doRemoveLogger 5
Removes the account logger with ID = 5
zxsuite mobile doResetAccount
zxsuite mobile doResetAccount *account*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
Account Name |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile doResetAccount john@example.com
Resets all the device states for John’s account
zxsuite mobile 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
Usage Example
zxsuite mobile doResetDevice john@example.com Appl79032X2WA4S
Resets John’s Appl79032X2WA4S device SyncState
zxsuite mobile doRestartService
zxsuite mobile doRestartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile doRestartService
zxsuite mobile 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
zxsuite mobile doSimulateSync
zxsuite mobile doSimulateSync *account* *LG8955c3fa9|new* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
Account Name/ID |
||
d evice_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
Usage Example
zxsuite mobile doSimulateSync account@example.com android1365173312
Usage Example
zxsuite mobile doSimulateSync account@example.com new days 2 initial false
zxsuite mobile doStartService
zxsuite mobile doStartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile doStartService
zxsuite mobile doStopService
zxsuite mobile doStopService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile doStopService
zxsuite mobile doSuspendDeviceSync
zxsuite mobile doSuspendDeviceSync *account* *device_id*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
Account Name |
||
d evice_id(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
zxsuite mobile doWipeDevice
zxsuite mobile doWipeDevice *account* *device_id* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
|
---|---|---|---|
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
zxsuite mobile duplicateABQMessage 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 |
bloc ked|quarantined |
|
loc ale_from(M) |
String |
default|a valid locale |
|
l ocale_to(M) |
String |
default|a valid locale |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile duplicateABQMessage domain example.com en_US en_UK
zxsuite mobile duplicateABQMessage 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 |
bloc ked|quarantined |
|
loc ale_from(M) |
String |
default|a valid locale |
|
l ocale_to(M) |
String |
default|a valid locale |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile duplicateABQMessage global blocked en_US en_UK
zxsuite mobile getABQMessage 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 |
bloc ked|quarantined |
|
locale(M) |
String |
all|default|a valid locale |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile getABQMessage domain example.com blocked it
Usage Example
zxsuite mobile getABQMessage domain example.com blocked default
Usage Example
zxsuite mobile getABQMessage domain example.com blocked all
zxsuite mobile getABQMessage global
zxsuite mobile getABQMessage global *blocked|quarantined*
*all|default|a valid locale*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
type(M) |
String |
bloc ked|quarantined |
|
locale(M) |
String |
all|default|a valid locale |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile getABQMessage global blocked it
Usage Example
zxsuite mobile getABQMessage global blocked default
Usage Example
zxsuite mobile getABQMessage global blocked all
zxsuite mobile getAccountLoggers
zxsuite mobile getAccountLoggers
Usage Example
zxsuite mobile getAccountLoggers
Shows the account logger list
zxsuite mobile 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
Usage Example
zxsuite mobile getAllDevices
zxsuite mobile getAllEASFilters
zxsuite mobile getAllEASFilters
Usage Example
zxsuite mobile getAllEASFilters
Shows the list of currently set EAS version filters
zxsuite mobile getDeviceInfo
zxsuite mobile getDeviceInfo *account* *device_id* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
Account Name/ID |
||
d evice_id(M) |
String |
||
verbose(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile getDeviceInfo john@example.com Appl79032X2WA4S verbose true
Shows detailed info about John’s device with id Appl79032X2WA4S
zxsuite mobile getDeviceList
zxsuite mobile getDeviceList *account*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
Account Name |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile getDeviceList john@example.com
Shows all John’s devices ids
zxsuite mobile getProperty Deprecated
zxsuite mobile getProperty [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
verbose(O) |
Boolean |
true|false |
|
p roperty_name(O) |
String[,..] |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile getProperty
Warning
This command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]
zxsuite mobile getProvisioning
zxsuite mobile getProvisioning *account|cos* *target* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
tar get_type(M) |
Multiple choice |
account|cos |
|
target(M) |
String |
||
key(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile getProvisioning account john@example.com key zimbraMobilePolicyAllowDesktopSync
Shows the value of the zimbraMobilePolicyAllowDesktopSync property for John’s account
Usage Example
zxsuite mobile getProvisioning account john@example.com
Shows the value of all properties for John’s account
zxsuite mobile getServices
zxsuite mobile getServices
Usage Example
zxsuite mobile getServices
zxsuite mobile 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
zxsuite mobile setABQMessage 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 |
bloc ked|quarantined |
|
locale(M) |
String |
default|a valid locale |
|
from(O) |
String |
||
reply_to(O) |
String |
||
subject(O) |
String |
||
body_plain(O) |
String |
||
bod y_plain_file(O) |
String |
||
body_html(O) |
String |
||
bo dy_html_file(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile setABQMessage domain example.com default u0@example.com admin@example.com "Email subject" "Email plain text body" "<h1>Email HTML body</h1>"
zxsuite mobile setABQMessage global
zxsuite mobile setABQMessage global *blocked|quarantined* *default|a
valid locale* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
type(M) |
String |
bloc ked|quarantined |
|
locale(M) |
String |
default|a valid locale |
|
from(O) |
String |
||
reply_to(O) |
String |
||
subject(O) |
String |
||
body_plain(O) |
String |
||
bod y_plain_file(O) |
String |
||
body_html(O) |
String |
||
bo dy_html_file(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile addAbqMessage global blocked default u0@example.com admin@example.com "Email subject" "Email plain text body" "<h1>Email HTML body</h1>"
zxsuite mobile setProperty Deprecated
zxsuite mobile setProperty *property_name* *property_value*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
prope rty_name(M) |
String |
||
proper ty_value(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile setProperty
Warning
This command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]
zxsuite mobile setProvisioning
zxsuite mobile setProvisioning *account|cos* *target* *key* *value*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
tar get_type(M) |
Multiple choice |
account|cos |
|
target(M) |
String |
||
key(M) |
String |
||
value(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite mobile setProvisioning account john@example.com AllowDesktopSync true
Sets value true to property AllowDesktopSync for John’s account