ZxAdmin CLI Commands
zxsuite admin 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
Usage 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.
Usage 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.
Usage 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.
zxsuite admin 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
Usage 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.
Usage 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.
Usage 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.
zxsuite admin 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 |
||
fieldName (O) |
String |
totAccountsOnDomain | totUsedSpaceOnDomain | systemResourcesOnDomain | calendarResourcesOnDomain | totAccountsWithUnlimitedSpace | totAvailableSpaceOnDomain | totUsedSpaceOnDomainByUnlimitedUsers | maxAccountsOnDomain | spaceUsedAccounts |
(M) == mandatory parameter, (O) – optional parameter
Usage Example
zxsuite admin doExportQuotaHistory
zxsuite admin 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
Usage Example
zxsuite admin doMigrateAdmin
Usage Example
zxsuite admin doMigrateAdmin force true
zxsuite admin 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 |
n otify_admins(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) – optional parameter
Usage Example
zxsuite admin doMonthlyReport
Generates the monthly report for the previous month and saves it in the currentZextras Admin log path
Usage 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 getMonthlyReport instead.
zxsuite admin 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
Usage Example
zxsuite admin doRemoveDelegationSettings john@example.com example.com
John no longer administers domain example.com
zxsuite admin doRepairAdmin
zxsuite admin doRepairAdmin *start*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
action(M) |
String |
start |
(M) == mandatory parameter, (O) – optional parameter
Usage Example
zxsuite admin doRepairAdmin
zxsuite admin doRestartService
zxsuite admin doRestartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) – optional parameter
Usage Example
zxsuite admin doRestartService
zxsuite admin doSetZimletRights
zxsuite admin doSetZimletRights
Usage Example
zxsuite admin doSetZimletRights
zxsuite admin doShowAdminActivity
zxsuite admin doShowAdminActivity [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
---|---|---|---|
admin (O) |
Account Name or 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
Usage 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.
Usage 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.
zxsuite admin doStartService
zxsuite admin doStartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) – optional parameter
Usage Example
zxsuite admin doStartService
zxsuite admin doStopAllOperations
zxsuite admin doStopAllOperations
Usage Example
zxsuite admin doStopAllOperations
Stops all running operations
zxsuite admin doStopOperation
zxsuite admin doStopOperation *operation_uuid*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
operat ion_uuid(M) |
Uuid |
(M) == mandatory parameter, (O) – optional parameter
Usage Example
zxsuite admin doStopOperation 30ed9eb9-eb28-4ca6-b65e-9940654b8601
Stops operation with id - 30ed9eb9-eb28-4ca6-b65e-9940654b8601
zxsuite admin doStopService
zxsuite admin doStopService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) – optional parameter
Usage Example
zxsuite admin doStopService
zxsuite admin 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
Usage Example
zxsuite admin getAllOperations
Shows all running and queued operations
zxsuite admin getDelegationSettings
zxsuite admin getDelegationSettings [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(O) |
String |
(M) == mandatory parameter, (O) – optional parameter
Usage Example
zxsuite admin getDelegationSettings
zxsuite admin getDomainSettings
zxsuite admin getDomainSettings
Usage Example
zxsuite admin getDomainSettings
zxsuite admin 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
Usage Example
zxsuite admin getMonthlyReport
Shows the monthly report for the previous month
Usage 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.
zxsuite admin getProperty Deprecated
zxsuite admin 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 admin getProperty
Warning
This command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]
zxsuite admin getServices
zxsuite admin getServices
Usage Example
zxsuite admin getServices
zxsuite admin monitor
zxsuite admin 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 admin monitor
zxsuite admin resetDomainSettings
zxsuite admin resetDomainSettings *domain*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
(M) == mandatory parameter, (O) – optional parameter
Usage Example
zxsuite admin resetDomainSettings
zxsuite admin setDomainSettings
zxsuite admin setDomainSettings *domain* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
a ccount_limit(O) |
Integer |
no action |
|
domain_a ccount_quota(O) |
String |
no action |
|
rese t_cos_limits(O) |
String |
c osname1:limit1, cosname2:limit2 |
no action |
ad d_cos_limits(O) |
String |
c osname1:limit1, cosname2:limit2 |
no action |
(M) == mandatory parameter, (O) – optional parameter
Usage 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).
Usage Example
zxsuite admin setDomainSettings example.com add_cos_limits cos1:30
Sets cos account limits of 30 for cos1 (leaving other cos settings unchanged).
zxsuite admin setProperty Deprecated
zxsuite admin 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 admin setProperty
Warning
This command is deprecated, please use instead:
zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]