From ajcody
Jump to: navigation, search

Contents

Help For ZeXtras NG Suite 2.5.4

Full help output from zextras suite 2.5.4

$ zxsuite core getVersion

CLI versions:

        network_modules_version                             2.5.4
        network_modules_commit                              fe5605f0742a1dd820b5edb089f46e3157559ac1
        zal_version                                         2.0.0
        zal_commit                                          fe5605f0742a1dd820b5edb089f46e3157559ac1

Server versions:

        version                                             2.5.4
        commit                                              fe5605f0742a1dd820b5edb089f46e3157559ac1
        system_type                                         network_modules
        product                                             Network Modules NG
        network                                             true
        zal_version                                         2.0.0
        zal_commit                                          fe5605f0742a1dd820b5edb089f46e3157559ac1

$ zmcontrol -v
Release 8.8.0_BETA1_1712.RHEL7_64_20170615062344 RHEL7_64 NETWORK edition.

zxsuite help

zxsuite help     

This is the Network Modules CLI.
Basic Usage:

zxsuite [--host] [--json] {module} {action} [options]

Options (for zxsuite - see each command's single help for command options):
    --host [hostname|ip] - Specify a target host for the command. Leave blank for localhost.
                           Use all_servers to broadcast the command to all Zimbra servers (with ZxSuite installed.)
    --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.

  help                     - ZxSuite CLI help command
                             zxsuite help 

  core                     - Commands regarding Network Modules NG Core package
                             zxsuite core 

  backup                   - Commands regarding Backup module
                             zxsuite backup 

  mobile                   - Commands regarding Mobile module
                             zxsuite mobile 

  hsm                      - Commands regarding HSM module
                             zxsuite hsm 

  admin                    - Commands regarding Admin module
                             zxsuite admin 

  config                   - Commands regarding Network Modules NG Config
                             zxsuite config 

zxsuite help core

$ zxsuite help core

Commands regarding Network Modules NG Core package

  doDeleteAllDelegatedRights - This command deletes both Admin and Zimbra's own Admin Delegation settings
                             zxsuite core doDeleteAllDelegatedRights {confirmation string} 

  doDeployClientZimlet     - Deploy Network Modules NG Client zimlet to handle shared folders or calendars mobile sy
                             zxsuite core doDeployClientZimlet 

  doRestartService         - restart a given service
                             zxsuite core doRestartService {service_name} 

  doStartService           - start a given service
                             zxsuite core doStartService {service_name} 

  doStopService            - stop a given service
                             zxsuite core doStopService {service_name} 

  getAccountStats          - Show statistic informations about provided account name or ID
                             zxsuite core getAccountStats {account} 

  getAllOperations         - Displays all running and queued operations
                             zxsuite core getAllOperations [attr1 value1 [attr2 value2...]]

  getLicenseInfo           - Display Network Modules NG license informations
                             zxsuite core getLicenseInfo 

  getNotification          - Shows Network Modules NG notifications
                             zxsuite core getNotification [attr1 value1 [attr2 value2...]]

  getOperationLog          - get all operation log for every module
                             zxsuite core getOperationLog 

  getProperty              - Get configuration properties
                             zxsuite core getProperty [attr1 value1 [attr2 value2...]]

  getServices              - show current status of all services for this module
                             zxsuite core getServices 

  getUnfinishedOperationLog - get unfinished operation log for every module
                             zxsuite core getUnfinishedOperationLog 

  getUpdateInfo            - Display update informations for Network Modules NG
                             zxsuite core getUpdateInfo 

  getVersion               - Display Network Modules NG version
                             zxsuite core getVersion 

  setProperty              - Set configuration property
                             zxsuite core setProperty {property_name} {property_value} 

zxsuite help core doDeleteAllDelegatedRights

zxsuite help core doDeleteAllDelegatedRights
This command deletes both Admin and Zimbra's own Admin Delegation settings                                          
                                                                                                                    
Syntax:                                                                                                             
   zxsuite core doDeleteAllDelegatedRights {confirmation string} 

PARAMETER LIST

NAME          TYPE      EXPECTED VALUES        
confirm(M)    String    confirmation string    

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

Usage example:

***Warning***: This command will delete both 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.

zxsuite help core doDeployClientZimlet

zxsuite help core doDeployClientZimlet
Deploy Network Modules NG Client zimlet to handle shared folders or calendars mobile sync.

Syntax:
   zxsuite core doDeployClientZimlet 

Usage example:

[[email protected] backup]$ zxsuite help core doRestartService
restart a given service

Syntax:
   zxsuite core doRestartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help core doRestartService

zxsuite help core doRestartService
restart a given service

Syntax:
   zxsuite core doRestartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help core doStartService

zxsuite help core doStartService
start a given service

Syntax:
   zxsuite core doStartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help core doStopService

zxsuite help core doStopService
stop a given service

Syntax:
   zxsuite core doStopService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help core getAccountStats

zxsuite help core getAccountStats
Show statistic informations about provided account name or ID

Syntax:
   zxsuite core getAccountStats {account} 

PARAMETER LIST

NAME          TYPE               
account(M)    Account Name/ID    

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

Usage example:

zxsuite core getaccountstats John
Shows stats for user John

zxsuite help core getAllOperations

zxsuite help core getAllOperations
Displays all running and queued operations

Syntax:
   zxsuite core getAllOperations [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME          TYPE       EXPECTED VALUES    DEFAULT
verbose(O)    Boolean    true|false         false

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

Usage example:

zxsuite core getAllOperations
Shows all running and queued operations

zxsuite help core getLicenseInfo

zxsuite help core getLicenseInfo
Display Network Modules NG license informations

Syntax:
   zxsuite core getLicenseInfo 

Usage example:

zxsuite help core getNotification

zxsuite help core getNotification
Shows Network Modules NG notifications

Syntax:
   zxsuite core getNotification [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME     TYPE      
id(O)    String    

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

Usage example:

zxsuite core getNotification
Shows the notification list

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

zxsuite help core getOperationLog

zxsuite help core getOperationLog
get all operation log for every module

Syntax:
   zxsuite core getOperationLog 

Usage example:

zxsuite help core getProperty

zxsuite help core getProperty
Get configuration properties

Syntax:
   zxsuite core getProperty [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                TYPE           EXPECTED VALUES    
verbose(O)          Boolean        true|false         
property_name(O)    String[,..]                       

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

zxsuite help core getServices

zxsuite help core getServices
show current status of all services for this module

Syntax:
   zxsuite core getServices 

Usage example:

zxsuite help core getUnfinishedOperationLog

zxsuite help core getUnfinishedOperationLog
get unfinished operation log for every module

Syntax:
   zxsuite core getUnfinishedOperationLog 

Usage example:

zxsuite help core getUpdateInfo

zxsuite help core getUpdateInfo
Display update informations for Network Modules NG

Syntax:
   zxsuite core getUpdateInfo 

Usage example:

zxsuite help core getVersion

zxsuite help core getVersion
Display Network Modules NG version

Syntax:
   zxsuite core getVersion 

Usage example:

zxsuite help core setProperty

zxsuite help core setProperty
Set configuration property

Syntax:
   zxsuite core setProperty {property_name} {property_value} 

PARAMETER LIST

NAME                 TYPE      
property_name(M)     String    
property_value(M)    String    

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

zxsuite help backup

$ zxsuite help backup

Commands regarding Backup module

  doAccountScan            - Perform a Smart Scan on a single account
                             zxsuite backup doAccountScan {account} [attr1 value1 [attr2 value2...]]

  doBackupServerCustomizations - Perform a backup of customizations
                             zxsuite backup doBackupServerCustomizations 

  doCheckShares            - Check all shares on local accounts
                             zxsuite backup doCheckShares 

  doCoherencyCheck         - Check backup coherency
                             zxsuite backup doCoherencyCheck {backup_path} [attr1 value1 [attr2 value2...]]

  doEnableDisableCOS       - Enable or disable the backup for a specific COS
                             zxsuite backup doEnableDisableCOS {cos_name} {enable|disable} 

  doExport                 - Perform an Export limited by domains
                             zxsuite backup doExport {destination_path} [attr1 value1 [attr2 value2...]]

  doExternalRestore        - Perform an External Restore
                             zxsuite backup doExternalRestore {source_path} [attr1 value1 [attr2 value2...]]

  doFixOrphans             - Delete orphan digest files
                             zxsuite backup doFixOrphans [attr1 value1 [attr2 value2...]]

  doFixShares              - Try to fix all shares on local accounts
                             zxsuite backup doFixShares {import_idmap_file} 

  doItemRestore            - Restores a single item
                             zxsuite backup doItemRestore {account_name} {item_id} [attr1 value1 [attr2 value2...]]

  doItemSearch             - Search for an item
                             zxsuite backup doItemSearch {account} [attr1 value1 [attr2 value2...]]

  doPurge                  - Perform a Purge Operation
                             zxsuite backup doPurge [attr1 value1 [attr2 value2...]]

  doRestartService         - restart a given service
                             zxsuite backup doRestartService {service_name} 

  doRestoreBlobs           - Start a restore blobs operation which tries to restore broken zimbra blobs
                             zxsuite backup doRestoreBlobs {volume_id} [attr1 value1 [attr2 value2...]]

  doRestoreOnNewAccount    - Perform a Restore on New Account
                             zxsuite backup doRestoreOnNewAccount {Account name or id} {destination_account} {"dd/MM/yyyy HH:mm:ss"|last} [attr1 value1 [attr2 value2...]]


  doSmartScan              - Perform a Smart Scan
                             zxsuite backup doSmartScan [attr1 value1 [attr2 value2...]]

  doStartService           - start a given service
                             zxsuite backup doStartService {service_name} 

  doStopAllOperations      - Stops all running operations and empties the operations queue
                             zxsuite backup doStopAllOperations 

  doStopOperation          - Stop a single running operation
                             zxsuite backup doStopOperation {operation_uuid} 

  doStopService            - stop a given service
                             zxsuite backup doStopService {service_name} 

  doUndelete               - Perform an Undelete Restore
                             zxsuite backup doUndelete {account} {"dd/MM/yyyy HH:mm:ss"|first} {"dd/MM/yyyy HH:mm:ss"|last} [attr1 value1 [attr2 value2...]]


  getAccountInfo           - Shows an account's information
                             zxsuite backup getAccountInfo {account} [attr1 value1 [attr2 value2...]]

  getAllOperations         - Displays all running and queued operations
                             zxsuite backup getAllOperations [attr1 value1 [attr2 value2...]]

  getAvailableAccounts     - Displays all accounts available for restore
                             zxsuite backup getAvailableAccounts [attr1 value1 [attr2 value2...]]

  getAvailableDomains      - Displays all domains available for restore
                             zxsuite backup getAvailableDomains {dd/MM/yyyy HH:mm:ss|"last"} {backup_path} 

  getBackupInfo            - Displays informations about the backup system
                             zxsuite backup getBackupInfo [attr1 value1 [attr2 value2...]]

  getCOSBackupStatus       - Displays the backup status of all COS
                             zxsuite backup getCOSBackupStatus [attr1 value1 [attr2 value2...]]

  getItem                  - Display an item in a human-readable format.
                             zxsuite backup getItem {account} {item} [attr1 value1 [attr2 value2...]]

  getMap                   - Show binary Map<String, String> object as human readable table
                             zxsuite backup getMap {file_path} 

  getProperty              - Get configuration properties
                             zxsuite backup getProperty [attr1 value1 [attr2 value2...]]

  getServerConfig          - Provides a list of stored server configs
                             zxsuite backup getServerConfig {standard|customizations} [attr1 value1 [attr2 value2...]]

  getServices              - show current status of all services for this module
                             zxsuite backup getServices 

  monitor                  - Monitor a running operation
                             zxsuite backup monitor {operation_uuid} [attr1 value1 [attr2 value2...]]

  setProperty              - Set configuration property
                             zxsuite backup setProperty {property_name} {property_value} 

zxsuite help backup doAccountScan

zxsuite help backup doAccountScan
Perform a Smart Scan on a single account

Syntax:
   zxsuite backup doAccountScan {account} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                TYPE             EXPECTED VALUES    DEFAULT
account(M)          Account Name                        
deep(O)             Boolean          true|false         false
notifications(O)    Email Address                       

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

Usage example:

zxsuite backup doaccountscan [email protected] deep true
Performs a deep scan of the account [email protected]

zxsuite help backup doBackupServerCustomizations

zxsuite help backup doBackupServerCustomizations
Perform a backup of customizations

Syntax:
   zxsuite backup doBackupServerCustomizations 

Usage example:

zxsuite backup doBackupServerCustomizations

zxsuite help backup doCheckShares

zxsuite help backup doCheckShares
Check all shares on local accounts

Syntax:
   zxsuite backup doCheckShares 

Usage example:

zxsuite backup doCheckShares
Check all shares on local accounts

zxsuite help backup doCoherencyCheck

zxsuite help backup doCoherencyCheck
Check backup coherency

Syntax:
   zxsuite backup doCoherencyCheck {backup_path} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                TYPE                    EXPECTED VALUES    DEFAULT
backup_path(M)      Path                                       
accounts(O)         Account Name/ID[,..]                       all
checkZimbra(O)      Boolean                 true|false         false
fixBackup(O)        Boolean                 true|false         false
notifications(O)    Email Address[,..]                         

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

Usage example:

zxsuite backup docoherencycheck /opt/zimbra/backup/zextras/ accounts [email protected],[email protected]
Performs a coherency check on /opt/zimbra/backup/zextras/ for Jack's and John's accounts
zxsuite backup docoherencycheck /opt/zimbra/backup/zextras/ fixBackup true
Performs a coherency check on /opt/zimbra/backup/zextras/ and moves corrupted backup files and blob files not referenced by any metadata out of backup

zxsuite help backup doEnableDisableCOS

zxsuite help backup doEnableDisableCOS
Enable or disable the backup for a specific COS

Syntax:
   zxsuite backup doEnableDisableCOS {cos_name} {enable|disable} 

PARAMETER LIST

NAME            TYPE      EXPECTED VALUES    
cos_name(M)     String                       
cos_state(M)    String    enable|disable     

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

Usage example:

zxsuite backup doenabledisablecos mainCOS disable
Disables backup on the mainCOS class of service

zxsuite help backup doExport

zxsuite help backup doExport
Perform an Export limited by domains

Syntax:
   zxsuite backup doExport {destination_path} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                       TYPE                  EXPECTED VALUES    DEFAULT
destination_path(M)        Path                                     
domains(O)                 Domain Name[,..]                         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

Usage example:

zxsuite backup doexport /opt/zimbra/backup/ domains example.com notifications [email protected]
Exports a backup of example.com to /opt/zimbra/backup/ and notifies [email protected]
Threshold is expressed in MB

zxsuite help backup doExternalRestore

zxsuite help backup doExternalRestore
Perform an External Restore

Syntax:
   zxsuite backup doExternalRestore {source_path} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                          TYPE                 EXPECTED VALUES    DEFAULT
source_path(M)                Path                                    
accounts(O)                   Account Name[,..]                       all
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
provisioning_only(O)          Boolean              true|false         false
notifications(O)              Email Address                           
concurrent_accounts(O)        Integer                                 
max_file_size(O)              Integer                                 

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

Usage example:

zxsuite backup doexternalrestore /path/to/data/ accounts [email protected],[email protected] domains example.com filter_deleted false skip_system_accounts false
Restores the example.com domain, including all system accounts, and the [email protected] and [email protected] accounts from a backup located in /path/to/data/

zxsuite help backup doFixOrphans

zxsuite help backup doFixOrphans
Delete orphan digest files

Syntax:
   zxsuite backup doFixOrphans [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME              TYPE    
backup_path(O)    Path    

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

Usage example:

zxsuite backup doFixOrphans
Delete orphan digest files in the backup directory.

zxsuite help backup doFixShares

zxsuite help backup doFixShares
Try to fix all shares on local accounts

Syntax:
   zxsuite backup doFixShares {import_idmap_file} 

PARAMETER LIST

NAME                    TYPE      
import_idmap_file(M)    String    

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

Usage example:

zxsuite backup doFixShares idmap_file
Fixes the shares' consistency after an import according to the mapping contained in the /opt/zimbra/backup/zextras/idmap_file

zxsuite help backup doItemRestore

zxsuite help backup doItemRestore
Restores a single item

Syntax:
   zxsuite backup doItemRestore {account_name} {item_id} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                 TYPE            EXPECTED VALUES               
account_name(M)      Account Name                                  
item_id(M)           Integer                                       
date(O)              Date            "dd/MM/yyyy HH:mm:ss"|last    
restore_folder(O)    String                                        

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

Usage example:

zxsuite backup doitemrestore [email protected] 4784
Restores item 4784 in the "[email protected]" mailbox 

zxsuite help backup doItemSearch

zxsuite help backup doItemSearch
Search for an item

Syntax:
   zxsuite backup doItemSearch {account} [attr1 value1 [attr2 value2...]]

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

Usage example:

zxsuite backup doitemsearch [email protected] type message verbose true
Shows all of John's messages, displays metadata of each message as well

zxsuite help backup doPurge

zxsuite help backup doPurge
Perform a Purge Operation

Syntax:
   zxsuite backup doPurge [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME              TYPE      
purgeDays(O)      String    
backup_path(O)    Path      

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

Usage example:

zxsuite backup dopurge purgeDays 30 backup_path /opt/zimbra/backup/backup_name

zxsuite help backup doRestartService

zxsuite help backup doRestartService
restart a given service

Syntax:
   zxsuite backup doRestartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help backup doRestoreBlobs

zxsuite help backup doRestoreBlobs
Start a restore blobs operation which tries to restore broken zimbra blobs

Syntax:
   zxsuite backup doRestoreBlobs {volume_id} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME              TYPE       EXPECTED VALUES    DEFAULT
volume_id(M)      String                        
backup_path(O)    String                        
dryrun(O)         Boolean    true|false         true
compress(O)       Boolean    true|false         true

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

Usage example:

zxsuite backup doRestoreBlobs 1 dryrun true
Run a restore blob operation on volume 1 without actually restoring data.
zxsuite backup doRestoreBlobs 3 dryrun false compress false
Run a restore blob operation on volume 3, this will restore any blob which was wrongly removed.
Restoring with compress enabled is slightly faster.

zxsuite help backup doRestoreOnNewAccount

zxsuite help backup doRestoreOnNewAccount
Perform a Restore on New Account

Syntax:
   zxsuite backup doRestoreOnNewAccount {Account name or id} {destination_account} {"dd/MM/yyyy HH:mm:ss"|last} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                       TYPE                  EXPECTED VALUES               
source_account(M)          String                Account name or id            
destination_account(M)     Account Name/ID                                     
date(M)                    Date                  "dd/MM/yyyy HH:mm:ss"|last    
restore_chat_buddies(O)    Boolean               true|false                    
apply_hsm(O)               Boolean               true|false                    
notifications(O)           Email Address[,..]                                  

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

Usage example:

zxsuite backup dorestoreonnewaccount [email protected] [email protected] "28/09/2012 10:15:10"
Restores the [email protected] account in a new account named [email protected]

zxsuite help backup doSmartScan

zxsuite help backup doSmartScan
Perform a Smart Scan

Syntax:
   zxsuite backup doSmartScan [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                       TYPE                  EXPECTED VALUES    
notifications(O)           Email Address[,..]                       
read_error_threshold(O)    Integer                                  
deep(O)                    Boolean               true|false         

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

Usage example:

zxsuite backup dosmartscan notifications [email protected],[email protected]
Performs a smart scan and sends notifications to [email protected] and [email protected]

zxsuite help backup doStartService

zxsuite help backup doStartService
start a given service

Syntax:
   zxsuite backup doStartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help backup doStopAllOperations

zxsuite help backup doStopAllOperations
Stops all running operations and empties the operations queue

Syntax:
   zxsuite backup doStopAllOperations 

Usage example:

zxsuite backup doStopAllOperations
Stops all running operations

zxsuite help backup doStopOperation

zxsuite help backup doStopOperation
Stop a single running operation

Syntax:
   zxsuite backup doStopOperation {operation_uuid} 

PARAMETER LIST

NAME                 TYPE    
operation_uuid(M)    Uiid    

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

Usage example:

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

zxsuite help backup doStopService

zxsuite help backup doStopService
stop a given service

Syntax:
   zxsuite backup doStopService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help backup doUndelete

zxsuite help backup doUndelete
Perform an Undelete Restore

Syntax:
   zxsuite backup doUndelete {account} {"dd/MM/yyyy HH:mm:ss"|first} {"dd/MM/yyyy HH:mm:ss"|last} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                TYPE                  EXPECTED VALUES                
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     
apply_hsm(O)        Boolean               true|false                     
notifications(O)    Email Address[,..]                                   

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

Usage example:

zxsuite backup doundelete [email protected] "08/10/2012 10:15:00" last
Performs an undelete on the [email protected] account of all items deleted between 08/10/2012 10:15:00 and the latest data available

zxsuite help backup getAccountInfo

zxsuite help backup getAccountInfo
Shows an account's information

Syntax:
   zxsuite backup getAccountInfo {account} [attr1 value1 [attr2 value2...]]

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

Usage example:

zxsuite backup getAccountInfo [email protected]
Displays info about the account [email protected]

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

zxsuite help backup getAllOperations

zxsuite help backup getAllOperations
Displays all running and queued operations

Syntax:
   zxsuite backup getAllOperations [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME          TYPE       EXPECTED VALUES    DEFAULT
verbose(O)    Boolean    true|false         false

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

Usage example:

zxsuite backup getAllOperations
Shows all running and queued operations

zxsuite help backup getAvailableAccounts

zxsuite help backup getAvailableAccounts
Displays all accounts available for restore

Syntax:
   zxsuite backup getAvailableAccounts [attr1 value1 [attr2 value2...]]

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

Usage example:

zxsuite backup getavailableaccounts last /opt/zimbra/backup/zextras/ hide_deleted false
Shows all accounts in the last backup, showing deleted accounts as well

zxsuite help backup getAvailableDomains

zxsuite help backup getAvailableDomains
Displays all domains available for restore

Syntax:
   zxsuite backup getAvailableDomains {dd/MM/yyyy HH:mm:ss|"last"} {backup_path} 

PARAMETER LIST

NAME              TYPE    EXPECTED VALUES               
date(M)           Date    dd/MM/yyyy HH:mm:ss|"last"    
backup_path(M)    Path                                  

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

Usage example:

zxsuite backup getavailabledomains last /opt/zimbra/backup/export
Shows all domains in the last backup

zxsuite help backup getBackupInfo

zxsuite help backup getBackupInfo
Displays informations about the backup system

Syntax:
   zxsuite backup getBackupInfo [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME              TYPE    
backup_path(O)    Path    

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

Usage example:

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

zxsuite help backup getCOSBackupStatus

zxsuite help backup getCOSBackupStatus
Displays the backup status of all COS

Syntax:
   zxsuite backup getCOSBackupStatus [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME           TYPE      DEFAULT
cos_name(O)    String    all

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

Usage example:

zxsuite backup getCOSBackupStatus
Shows all the classes of service and their ZxBackup status

zxsuite help backup getItem

zxsuite help backup getItem
Display an item in a human-readable format.

Syntax:
   zxsuite backup getItem {account} {item} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME              TYPE               EXPECTED VALUES            DEFAULT
account(M)        Account Name/ID                               
item(M)           Integer                                       
backup_path(O)    Path                                          
dump_blob(O)      Boolean            true|false                 false
date(O)           Date               dd/mm/yyyy hh:mm:ss|all    last

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

Usage example:

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

zxsuite help backup getMap

zxsuite help backup getMap
Show binary Map<String, String> object as human readable table

Syntax:
   zxsuite backup getMap {file_path} 

PARAMETER LIST

NAME            TYPE    
file_path(M)    Path    

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

Usage example:

zxsuite backup getmap /opt/zimbra/backup/zextras/map_544d94c6-aaef-4736-8964-56a667f1fe12
Shows the item backup map

zxsuite help backup getProperty

zxsuite help backup getProperty
Get configuration properties

Syntax:
   zxsuite backup getProperty [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                TYPE           EXPECTED VALUES    
verbose(O)          Boolean        true|false         
property_name(O)    String[,..]                       

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

zxsuite help backup getServerConfig

zxsuite help backup getServerConfig
Provides a list of stored server configs

Syntax:
   zxsuite backup getServerConfig {standard|customizations} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME              TYPE               EXPECTED VALUES                       DEFAULT
type(M)           Multiple choice    standard|customizations               
date(O)           String             "dd/MM/yyyy HH:mm:ss"|"last"|"all"    
backup_path(O)    Path                                                     
file(O)           String             Path to backup file                   
query(O)          String             type/id/key                           
verbose(O)        String                                                   false
colors(O)         String                                                   false

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

Usage example:

zxsuite backup getserverconfig standard date last
 Display a summary of the latest backup data for Server and Global configuration.
zxsuite backup getserverconfig standard date last query /
 Display the latest backed up server and global configuration settings.
zxsuite backup getserverconfig standard file /path/to/backup/file
 Display the contents of a backup file instead of the current server backup.
zxsuite backup getserverconfig standard date last query zimlets/com_zimbra_ymemoticons colors true verbose true
 Displays all settings for the com_zimbra_ymemoticons zimlet, using colored output and high verbosity. 

zxsuite help backup getServices

zxsuite help backup getServices
show current status of all services for this module

Syntax:
   zxsuite backup getServices 

Usage example:

zxsuite help backup monitor

zxsuite help backup monitor
Monitor a running operation

Syntax:
   zxsuite backup monitor {operation_uuid} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                 TYPE      
operation_uuid(M)    Uiid      
operation_host(O)    String    

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

zxsuite help backup setProperty

zxsuite help backup setProperty
Set configuration property

Syntax:
   zxsuite backup setProperty {property_name} {property_value} 

PARAMETER LIST

NAME                 TYPE      
property_name(M)     String    
property_value(M)    String    

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

zxsuite help mobile

zxsuite help mobile

Commands regarding Mobile module

  doAddAccountLogger       - Add an account logger
                             zxsuite mobile doAddAccountLogger {account} {debug|info|warn|err|crit} {log_file} [attr1 value1 [attr2 value2...]]

  doAddEASFilter           - Adds a rule to specify which Exchange Active Sync versions can be used with a user agent
                             zxsuite mobile doAddEASFilter {and|or|regex|contains|account} {text|[email protected]|[email protected],contains=android} {add|subtract|fixed|limit} {easversions} [attr1 value1 [attr2 value2...]]

  doDeleteEASFilter        - Removes an EAS version filter
                             zxsuite mobile doDeleteEASFilter {id} 

  doMoveEASFilter          - Change the apply order of EAS filter.
                             zxsuite mobile doMoveEASFilter {from} {to} 

  doRemoveDevice           - Removes all the device's SyncState and history from the server
                             zxsuite mobile doRemoveDevice {account} {device_id} 

  doRemoveLogger           - Removes an account logger
                             zxsuite mobile doRemoveLogger {logger_id|"all_loggers"} 

  doResetAccount           - Reset ALL device states for the provided account
                             zxsuite mobile doResetAccount {account} 

  doResetDevice            - Resets the device's SyncState for a single account
                             zxsuite mobile doResetDevice {account} [attr1 value1 [attr2 value2...]]

  doRestartService         - restart a given service
                             zxsuite mobile doRestartService {service_name} 

  doResumeDeviceSync       - Resumes the device's synchronization after it has been suspended
                             zxsuite mobile doResumeDeviceSync {account} [attr1 value1 [attr2 value2...]]

  doSimulateSync           - Simulate a Sync command for each synchronization state of the device
                             zxsuite mobile doSimulateSync {account} {LG8955c3fa9|new} [attr1 value1 [attr2 value2...]]

  doStartService           - start a given service
                             zxsuite mobile doStartService {service_name} 

  doStopService            - stop a given service
                             zxsuite mobile doStopService {service_name} 

  doSuspendDeviceSync      - Suspends the device's synchronization
                             zxsuite mobile doSuspendDeviceSync {account} {device_id} 

  doWipeDevice             - Wipes a device
                             zxsuite mobile doWipeDevice {account} {device_id} [attr1 value1 [attr2 value2...]]

  getAccountLoggers        - Returns informations about all account loggers
                             zxsuite mobile getAccountLoggers 

  getAccountMobilePassword - Get the Mobile password information
                             zxsuite mobile getAccountMobilePassword {account} 

  getAllDevices            - Get all mobile devices
                             zxsuite mobile getAllDevices 

  getAllEASFilters         - Shows the list of currently set EAS version filters
                             zxsuite mobile getAllEASFilters 

  getDeviceInfo            - Display information about the provided device
                             zxsuite mobile getDeviceInfo {account} {device_id} [attr1 value1 [attr2 value2...]]

  getDeviceList            - Display all devices for the provided account
                             zxsuite mobile getDeviceList {account} 

  getProperty              - Get configuration properties
                             zxsuite mobile getProperty [attr1 value1 [attr2 value2...]]

  getProvisioning          - Shows one or all mobile provisioning attributes values for the specified target
                             zxsuite mobile getProvisioning {account|cos} {target} [attr1 value1 [attr2 value2...]]

  getServices              - show current status of all services for this module
                             zxsuite mobile getServices 

  setAccountMobilePassword - Sets the Mobile mobile password
                             zxsuite mobile setAccountMobilePassword {account} {password} 

  setProperty              - Set configuration property
                             zxsuite mobile setProperty {property_name} {property_value} 

  setProvisioning          - Sets a mobile provisioning attribute
                             zxsuite mobile setProvisioning {account|cos} {target} {key} {value} 

  unsetAccountMobilePassword - Unset the Mobile password
                             zxsuite mobile unsetAccountMobilePassword {account} 

zxsuite help mobile doAddAccountLogger

zxsuite help mobile doAddAccountLogger
Add an account logger

Syntax:
   zxsuite mobile doAddAccountLogger {account} {debug|info|warn|err|crit} {log_file} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME              TYPE               EXPECTED VALUES             
account(M)        Account Name                                   
log_level(M)      Multiple choice    debug|info|warn|err|crit    
log_file(M)       Path                                           
window_size(O)    Integer            a value > 0                 

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

Usage example:

zxsuite mobile doaddaccountlogger [email protected] info /tmp/john_logger
Creates an info account logger for john's account to file /tmp/john_logger

zxsuite mobile doaddaccountlogger [email protected] 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 help mobile doAddEASFilter

zxsuite help mobile doAddEASFilter
Adds a rule to specify which Exchange Active Sync versions can be used with a user agent

Syntax:
   zxsuite mobile doAddEASFilter {and|or|regex|contains|account} {text|[email protected]|[email protected],contains=android} {add|subtract|fixed|limit} {easversions} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME              TYPE               EXPECTED VALUES                                                    
type(M)           Multiple choice    and|or|regex|contains|account                                      
parameter(M)      String             text|[email protected]|[email protected],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'.

zxsuite mobile doAddEASFilter and [email protected],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 [email protected] No more EAS filters will be evaluated after this one due to the 'blocking' directive.

zxsuite help mobile doDeleteEASFilter

zxsuite help mobile doDeleteEASFilter
Removes an EAS version filter

Syntax:
   zxsuite mobile doDeleteEASFilter {id} 

PARAMETER LIST

NAME     TYPE       
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 help mobile doMoveEASFilter

zxsuite help mobile doMoveEASFilter
Change the apply order of EAS filter.

Syntax:
   zxsuite mobile doMoveEASFilter {from} {to} 

PARAMETER LIST

NAME       TYPE       
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 help mobile doRemoveDevice

zxsuite help mobile doRemoveDevice
Removes all the device's SyncState and history from the server

Syntax:
   zxsuite mobile doRemoveDevice {account} {device_id} 

PARAMETER LIST

NAME            TYPE            
account(M)      Account Name    
device_id(M)    String          

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

Usage example:

zxsuite mobile doRemoveDevice [email protected] Appl79032X2WA4S
Removes John's Appl79032X2WA4S device SyncState

zxsuite help mobile doRemoveLogger

zxsuite help mobile doRemoveLogger
Removes an account logger

Syntax:
   zxsuite mobile doRemoveLogger {logger_id|"all_loggers"} 

PARAMETER LIST

NAME            TYPE               EXPECTED VALUES            
logger_id(M)    Multiple choice    logger_id|"all_loggers"    

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

Usage example:

zxsuite mobile doremovelogger 5
Removes the account logger with ID = 5

zxsuite help mobile doResetAccount

zxsuite help mobile doResetAccount
Reset ALL device states for the provided account

Syntax:
   zxsuite mobile doResetAccount {account} 

PARAMETER LIST

NAME          TYPE            
account(M)    Account Name    

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

Usage example:

zxsuite mobile doResetAccount [email protected]
Resets all the device states for John's account

zxsuite help mobile doResetDevice

zxsuite help mobile doResetDevice
Resets the device's SyncState for a single account

Syntax:
   zxsuite mobile doResetDevice {account} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME            TYPE            DEFAULT
account(M)      Account Name    
device_id(O)    String          all

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

Usage example:

zxsuite mobile doResetDevice [email protected] Appl79032X2WA4S
Resets John's Appl79032X2WA4S device SyncState

zxsuite help mobile doRestartService

zxsuite help mobile doRestartService
restart a given service

Syntax:
   zxsuite mobile doRestartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help mobile doResumeDeviceSync

zxsuite help mobile doResumeDeviceSync
Resumes the device's synchronization after it has been suspended

Syntax:
   zxsuite mobile doResumeDeviceSync {account} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME            TYPE            DEFAULT
account(M)      Account Name    
device_id(O)    String          all

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

zxsuite help mobile doSimulateSync

zxsuite help mobile doSimulateSync
Simulate a Sync command for each synchronization state of the device

Syntax:
   zxsuite mobile doSimulateSync {account} {LG8955c3fa9|new} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME              TYPE               EXPECTED VALUES    
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

Usage example:

zxsuite mobile doSimulateSync [email protected] android1365173312
zxsuite mobile doSimulateSync [email protected] new days 2 initial false

zxsuite help mobile doStartService

zxsuite help mobile doStartService
start a given service

Syntax:
   zxsuite mobile doStartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help mobile doStopService

zxsuite help mobile doStopService
stop a given service

Syntax:
   zxsuite mobile doStopService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help mobile doSuspendDeviceSync

zxsuite help mobile doSuspendDeviceSync
Suspends the device's synchronization

Syntax:
   zxsuite mobile doSuspendDeviceSync {account} {device_id} 

PARAMETER LIST

NAME            TYPE            
account(M)      Account Name    
device_id(M)    String          

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

zxsuite help mobile doWipeDevice

zxsuite help mobile doWipeDevice
Wipes a device

Syntax:
   zxsuite mobile doWipeDevice {account} {device_id} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME            TYPE            EXPECTED VALUES    DEFAULT
account(M)      Account Name                       
device_id(M)    String                             
confirm(O)      Boolean         true|false         false

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

zxsuite help mobile getAccountLoggers

zxsuite help mobile getAccountLoggers
Returns informations about all account loggers

Syntax:
   zxsuite mobile getAccountLoggers 

Usage example:

zxsuite mobile getAccountLoggers
Shows the account logger list

zxsuite help mobile getAccountMobilePassword

zxsuite help mobile getAccountMobilePassword
Get the Mobile password information

Syntax:
   zxsuite mobile getAccountMobilePassword {account} 

PARAMETER LIST

NAME          TYPE      
account(M)    String    

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

Usage example:

zxsuite mobile getAccountMobilePassword [email protected] password f9dsf8j3
Show the SHA1 of [email protected]'s mobile password

zxsuite help mobile getAllDevices

zxsuite help mobile getAllDevices
Get all mobile devices

Syntax:
   zxsuite mobile getAllDevices 

Usage example:

zxsuite help mobile getAllEASFilters

zxsuite help mobile getAllEASFilters
Shows the list of currently set EAS version filters

Syntax:
   zxsuite mobile getAllEASFilters 

Usage example:

zxsuite mobile getAllEASFilters
Shows the list of currently set EAS version filters

zxsuite help mobile getDeviceInfo

zxsuite help mobile getDeviceInfo
Display information about the provided device

Syntax:
   zxsuite mobile getDeviceInfo {account} {device_id} [attr1 value1 [attr2 value2...]]

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

Usage example:

zxsuite mobile getdeviceinfo [email protected] Appl79032X2WA4S verbose true
Shows detailed info about John's device with id Appl79032X2WA4S

zxsuite help mobile getDeviceList

zxsuite help mobile getDeviceList
Display all devices for the provided account

Syntax:
   zxsuite mobile getDeviceList {account} 

PARAMETER LIST

NAME          TYPE            
account(M)    Account Name    

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

Usage example:

zxsuite mobile getdevicelist [email protected]
Shows all John's devices ids

zxsuite help mobile getProperty

zxsuite help mobile getProperty
Get configuration properties

Syntax:
   zxsuite mobile getProperty [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                TYPE           EXPECTED VALUES    
verbose(O)          Boolean        true|false         
property_name(O)    String[,..]                       

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

zxsuite help mobile getProvisioning

zxsuite help mobile getProvisioning
Shows one or all mobile provisioning attributes values for the specified target

Syntax:
   zxsuite mobile getProvisioning {account|cos} {target} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME              TYPE               EXPECTED VALUES    
target_type(M)    Multiple choice    account|cos        
target(M)         String                                
key(O)            String                                

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

Usage example:

zxsuite mobile getProvisioning account [email protected] key zimbraMobilePolicyAllowDesktopSync
Shows the value of the zimbraMobilePolicyAllowDesktopSync property for John's account

zxsuite mobile getProvisioning account [email protected]
Shows the value of all properties for John's account

zxsuite help mobile getServices

zxsuite help mobile getServices
show current status of all services for this module

Syntax:
   zxsuite mobile getServices 

Usage example:

zxsuite help mobile setAccountMobilePassword

zxsuite help mobile setAccountMobilePassword
Sets the Mobile mobile password

Syntax:
   zxsuite mobile setAccountMobilePassword {account} {password} 

PARAMETER LIST

NAME           TYPE      
account(M)     String    
password(M)    String    

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

Usage example:

zxsuite mobile userMobilePassword [email protected] f9dsf8j3
Set [email protected]'s mobile password

zxsuite help mobile setProperty

zxsuite help mobile setProperty
Set configuration property

Syntax:
   zxsuite mobile setProperty {property_name} {property_value} 

PARAMETER LIST

NAME                 TYPE      
property_name(M)     String    
property_value(M)    String    

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

zxsuite help mobile setProvisioning

zxsuite help mobile setProvisioning
Sets a mobile provisioning attribute

Syntax:
   zxsuite mobile setProvisioning {account|cos} {target} {key} {value} 

PARAMETER LIST

NAME              TYPE               EXPECTED VALUES    
target_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 [email protected] AllowDesktopSync true
Sets value true to property AllowDesktopSync for John's account

zxsuite help mobile unsetAccountMobilePassword

zxsuite help mobile unsetAccountMobilePassword
Unset the Mobile password

Syntax:
   zxsuite mobile unsetAccountMobilePassword {account} 

PARAMETER LIST

NAME          TYPE      
account(M)    String    

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

Usage example:

zxsuite mobile unsetAccountMobilePassword [email protected]
Remove [email protected]'s mobile password

zxsuite help hsm

zxsuite help hsm

Commands regarding HSM module

  +setHsmPolicy            - Add an additional policy to HSM.
                             zxsuite hsm +setHsmPolicy {hsm_policy} 

  addS3Store               - Add an S3 compatible store
                             zxsuite hsm addS3Store {Name of the zimbra store} [attr1 value1 [attr2 value2...]]

  doCheckBlobs             - Start the doCheckBlobs operation.
                             zxsuite hsm doCheckBlobs {start} [attr1 value1 [attr2 value2...]]

  doCreateVolume           - Create a volume on the server
                             zxsuite hsm doCreateVolume {primary|secondary|index} {volume_name} {volume_path} {true|false} {compression_threshold_bytes} 

  doDeduplicate            - Start a deduplication operation.
                             zxsuite hsm doDeduplicate {volume_name} [attr1 value1 [attr2 value2...]]

  doDeleteVolume           - Delete a specific volume on the server
                             zxsuite hsm doDeleteVolume {volume_name} 

  doMoveBlobs              - Start the doMoveBlob operation.
                             zxsuite hsm doMoveBlobs [attr1 value1 [attr2 value2...]]

  doRemoveHsmPolicy        - Remove a policy from HSM.
                             zxsuite hsm doRemoveHsmPolicy {hsm_policy} 

  doRestartService         - restart a given service
                             zxsuite hsm doRestartService {service_name} 

  doStartService           - start a given service
                             zxsuite hsm doStartService {service_name} 

  doStopAllOperations      - Stops all running operations and empties the operations queue
                             zxsuite hsm doStopAllOperations 

  doStopOperation          - Stop a single running operation
                             zxsuite hsm doStopOperation {operation_uuid} 

  doStopService            - stop a given service
                             zxsuite hsm doStopService {service_name} 

  doUpdateVolume           - Update a specific volume on the server
                             zxsuite hsm doUpdateVolume {current_volume_name} [attr1 value1 [attr2 value2...]]

  doVolumeToVolumeMove     - Start the doMoveVolumeBlobs operation.
                             zxsuite hsm doVolumeToVolumeMove {source_volume_name} {destination_volume_name} 

  getAllOperations         - Displays all running and queued operations
                             zxsuite hsm getAllOperations [attr1 value1 [attr2 value2...]]

  getAllVolumes            - Prints all the volumes present in the server
                             zxsuite hsm getAllVolumes 

  getHsmPolicy             - Prints all the policies
                             zxsuite hsm getHsmPolicy 

  getProperty              - Get configuration properties
                             zxsuite hsm getProperty [attr1 value1 [attr2 value2...]]

  getServices              - show current status of all services for this module
                             zxsuite hsm getServices 

  getVolumeStats           - Show space occupation, number of items and blobs contained in a volume
                             zxsuite hsm getVolumeStats {volume_name} [attr1 value1 [attr2 value2...]]

  monitor                  - Monitor a running operation
                             zxsuite hsm monitor {operation_uuid} [attr1 value1 [attr2 value2...]]

  setHSMPolicy             - Set the default HSM policy
                             zxsuite hsm setHSMPolicy {hsm_policy} 

  setProperty              - Set configuration property
                             zxsuite hsm setProperty {property_name} {property_value} 

  testS3Connection         - Test the connection to an S3 bucket.
                             zxsuite hsm testS3Connection {s3BucketConfigurationUuid} 

zxsuite help hsm +setHsmPolicy

zxsuite help hsm +setHsmPolicy
Add an additional policy to HSM.

Syntax:
   zxsuite hsm +setHsmPolicy {hsm_policy} 

PARAMETER LIST

NAME             TYPE      
hsm_policy(M)    String    

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

Usage example:

zxsuite powerstore +sethsmpolicy "message, document:before:-2month"
Adds a new HSM policy

zxsuite help hsm addS3Store

zxsuite help hsm addS3Store
Add an S3 compatible store

Syntax:
   zxsuite hsm addS3Store {Name of the zimbra store} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                            TYPE       EXPECTED VALUES                                                                                                  
name(M)                         String     Name of the zimbra store                                                                                         
serverPrefix(O)                 String     Prefix to the server id used in all objects keys                                                                 
bucketConfigurationId(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)                                                            
accessKey(O)                    String     Service username                                                                                                 
secret(O)                       String     Service password                                                                                                 
bucketName(O)                   String     Amazon AWS bucket                                                                                                
prefix(O)                       String     Prefix added to blobs keys                                                                                       
protocol(O)                     String     HTTP|HTTPS                                                                                                       
useInfrequentAccess(O)          Boolean    true|false                                                                                                       
infrequentAccessThreshold(O)    String     Bytes                                                                                                            

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

zxsuite help hsm doCheckBlobs

zxsuite help hsm doCheckBlobs
Start the doCheckBlobs operation.

Syntax:
   zxsuite hsm doCheckBlobs {start} [attr1 value1 [attr2 value2...]]

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

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

Usage example:

Usage examples:
zxsuite powerstore doCheckBlobs start
Perform a BLOB coherency check on all message volumes

zxsuite powerstore doCheckBlobs start volumes message1,hsm
Perform a BLOB coherency check on volumes message1 and hsm

zxsuite powerstore doCheckBlobs start mailbox_ids 2,9,27
Perform a BLOB coherency check on mailboxes 2,9 and 27

zxsuite powerstore doCheckBlobs start missing_blobs_crosscheck false
Perform a BLOB coherency check without checking on other volumes

zxsuite powerstore doCheckBlobs start traced true
Perform a BLOB coherency check, logging even the correct checked items

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

zxsuite help hsm doCreateVolume

zxsuite help hsm doCreateVolume
Create a volume on the server

Syntax:
   zxsuite hsm doCreateVolume {primary|secondary|index} {volume_name} {volume_path} {true|false} {compression_threshold_bytes} 

PARAMETER LIST

NAME                              TYPE               EXPECTED VALUES            DEFAULT
volume_type(M)                    Multiple choice    primary|secondary|index    
volume_name(M)                    String                                        
volume_path(M)                    Path                                          
volume_compressed(M)              Boolean            true|false                 false
compression_threshold_bytes(M)    Long                                          4096

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

Usage example:

zxsuite powerstore docreatevolume secondary "volume B" "/opt/zimbra/store_B/" volume_compressed true compression_threshold_bytes 4096
Creates a new secondary volume named "volume B" in /opt/zimbra/store_B/, with compression and compression threshold to 4096 bytes

zxsuite help hsm doDeduplicate

zxsuite help hsm doDeduplicate
Start a deduplication operation.

Syntax:
   zxsuite hsm doDeduplicate {volume_name} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME              TYPE           EXPECTED VALUES    DEFAULT
volume_name(M)    String[,..]                       
dry_run(O)        Boolean        true|false         false

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

Usage example:

zxsuite powerstore dodeduplicate secondvolume
Starts a deduplication on volume secondvolume

zxsuite help hsm doDeleteVolume

zxsuite help hsm doDeleteVolume
Delete a specific volume on the server

Syntax:
   zxsuite hsm doDeleteVolume {volume_name} 

PARAMETER LIST

NAME              TYPE      
volume_name(M)    String    

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

Usage example:

zxsuite powerstore dodeletevolume hsm
Deletes volume with name hsm

zxsuite help hsm doMoveBlobs

zxsuite help hsm doMoveBlobs
Start the doMoveBlob operation.

Syntax:
   zxsuite hsm doMoveBlobs [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                TYPE      DEFAULT
custom_policy(O)    String    none

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

Usage example:

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

zxsuite help hsm doRemoveHsmPolicy

zxsuite help hsm doRemoveHsmPolicy
Remove a policy from HSM.

Syntax:
   zxsuite hsm doRemoveHsmPolicy {hsm_policy} 

PARAMETER LIST

NAME             TYPE      
hsm_policy(M)    String    

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

Usage example:

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

zxsuite help hsm doRestartService

zxsuite help hsm doRestartService
restart a given service

Syntax:
   zxsuite hsm doRestartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help hsm doStartService

zxsuite help hsm doStartService
start a given service

Syntax:
   zxsuite hsm doStartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help hsm doStopAllOperations

zxsuite help hsm doStopAllOperations
Stops all running operations and empties the operations queue

Syntax:
   zxsuite hsm doStopAllOperations 

Usage example:

zxsuite powerstore doStopAllOperations
Stops all running and queued operations

zxsuite help hsm doStopOperation

zxsuite help hsm doStopOperation
Stop a single running operation

Syntax:
   zxsuite hsm doStopOperation {operation_uuid} 

PARAMETER LIST

NAME                 TYPE    
operation_uuid(M)    Uiid    

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

Usage example:

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

zxsuite help hsm doStopService

zxsuite help hsm doStopService
stop a given service

Syntax:
   zxsuite hsm doStopService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help hsm doUpdateVolume

zxsuite help hsm doUpdateVolume
Update a specific volume on the server

Syntax:
   zxsuite hsm doUpdateVolume {current_volume_name} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                        TYPE       EXPECTED VALUES            DEFAULT
current_volume_name(M)      String                                
volume_type(O)              String     primary|secondary|index    inherited_value
volume_name(O)              String                                inherited_value
volume_path(O)              Path                                  inherited_value
current_volume(O)           Boolean    true|false                 false
volume_compressed(O)        String                                inherited_value
compression_threshold(O)    String                                inherited_value

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

Usage example:

zxsuite powerstore doupdatevolume oldName secondary volume_name "example volume" volume_path "/opt/zimbra/store_example/"
Sets name of volume oldName to "example volume", make it secondary, and set its path to /opt/zimbra/store_example/

zxsuite help hsm doVolumeToVolumeMove

zxsuite help hsm doVolumeToVolumeMove
Start the doMoveVolumeBlobs operation.

Syntax:
   zxsuite hsm doVolumeToVolumeMove {source_volume_name} {destination_volume_name} 

PARAMETER LIST

NAME                          TYPE      
source_volume_name(M)         String    
destination_volume_name(M)    String    

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

Usage example:

zxsuite powerstore doVolumeToVolumeMove sourceVolume destVolume
Moves the whole sourceVolume to destVolume

zxsuite help hsm getAllOperations

zxsuite help hsm getAllOperations
Displays all running and queued operations

Syntax:
   zxsuite hsm getAllOperations [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME          TYPE       EXPECTED VALUES    DEFAULT
verbose(O)    Boolean    true|false         false

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

Usage example:

zxsuite powerstore getAllOperations
Shows all running and queued operations

zxsuite help hsm getAllVolumes

zxsuite help hsm getAllVolumes
Prints all the volumes present in the server

Syntax:
   zxsuite hsm getAllVolumes 

Usage example:

zxsuite powerstore getAllVolumes
Shows info about all the volumes

zxsuite help hsm getHsmPolicy

zxsuite help hsm getHsmPolicy
Prints all the policies

Syntax:
   zxsuite hsm getHsmPolicy 

Usage example:

zxsuite powerstore getHSMPolicy
Prints all the policies

zxsuite help hsm getProperty

zxsuite help hsm getProperty
Get configuration properties

Syntax:
   zxsuite hsm getProperty [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                TYPE           EXPECTED VALUES    
verbose(O)          Boolean        true|false         
property_name(O)    String[,..]                       

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

zxsuite help hsm getServices

zxsuite help hsm getServices
show current status of all services for this module

Syntax:
   zxsuite hsm getServices 

Usage example:

zxsuite help hsm getVolumeStats

zxsuite help hsm getVolumeStats
Show space occupation, number of items and blobs contained in a volume

Syntax:
   zxsuite hsm getVolumeStats {volume_name} [attr1 value1 [attr2 value2...]]

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

Usage example:

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

zxsuite powerstore getVolumeStats volumeName
Shows stats for the volume with name equal to volumeName

zxsuite help hsm monitor

zxsuite help hsm monitor
Monitor a running operation

Syntax:
   zxsuite hsm monitor {operation_uuid} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                 TYPE      
operation_uuid(M)    Uiid      
operation_host(O)    String    

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

zxsuite help hsm setHSMPolicy

zxsuite help hsm setHSMPolicy
Set the default HSM policy

Syntax:
   zxsuite hsm setHSMPolicy {hsm_policy} 

PARAMETER LIST

NAME             TYPE      
hsm_policy(M)    String    

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

Usage example:

zxsuite powerstore +sethsmpolicy "message, document:before:-2month"
Sets the new default HSM policy

zxsuite help hsm setProperty

zxsuite help hsm setProperty
Set configuration property

Syntax:
   zxsuite hsm setProperty {property_name} {property_value} 

PARAMETER LIST

NAME                 TYPE      
property_name(M)     String    
property_value(M)    String    

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

zxsuite help hsm testS3Connection

zxsuite help hsm testS3Connection
Test the connection to an S3 bucket.

Syntax:
   zxsuite hsm testS3Connection {s3BucketConfigurationUuid} 

PARAMETER LIST

NAME                            TYPE      
s3BucketConfigurationUuid(M)    String    

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

zxsuite help admin

zxsuite help admin

Commands regarding Admin module

  doAddDelegationSettings  - Adds a delegation privilege for a user on a domain
                             zxsuite admin doAddDelegationSettings {account} {domain} [attr1 value1 [attr2 value2...]]

  doEditDelegationSettings - Edits the delegation privileges for a user on a domain
                             zxsuite admin doEditDelegationSettings {account} {domain} [attr1 value1 [attr2 value2...]]

  doExportQuotaHistory     - Export multiple monthly quota usage information both in text and json form
                             zxsuite admin doExportQuotaHistory {users|domains} {json|csv} {file_path} [attr1 value1 [attr2 value2...]]

  doMigrateAdmin           - update the configuration of rights
                             zxsuite admin doMigrateAdmin [attr1 value1 [attr2 value2...]]

  doMonthlyReport          - Generate a report of admin activity in the specified month
                             zxsuite admin doMonthlyReport [attr1 value1 [attr2 value2...]]

  doRemoveDelegationSettings - Removes a delegation privilege for a user on a domain
                             zxsuite admin doRemoveDelegationSettings {account} {domain} 

  doRepairAdmin            - Repair Admin delegation and domain setting
                             zxsuite admin doRepairAdmin 

  doRestartService         - restart a given service
                             zxsuite admin doRestartService {service_name} 

  doSetZimletRights        - Fixes the administrative zimlet rights for all delegated admins.
                             zxsuite admin doSetZimletRights 

  doShowAdminActivity      - Shows all recorded admin activity
                             zxsuite admin doShowAdminActivity [attr1 value1 [attr2 value2...]]

  doStartService           - start a given service
                             zxsuite admin doStartService {service_name} 

  doStopAllOperations      - Stops all running operations and empties the operations queue
                             zxsuite admin doStopAllOperations 

  doStopOperation          - Stop a single running operation
                             zxsuite admin doStopOperation {operation_uuid} 

  doStopService            - stop a given service
                             zxsuite admin doStopService {service_name} 

  getAllOperations         - Displays all running and queued operations
                             zxsuite admin getAllOperations [attr1 value1 [attr2 value2...]]

  getDelegationSettings    - Shows delegated admins with their domains of competency, the viewMail attribute and the admin-assignable quota
                             zxsuite admin getDelegationSettings [attr1 value1 [attr2 value2...]]

  getDomainSettings        - Shows all domains' name, account number limit, and max account quota
                             zxsuite admin getDomainSettings 

  getMonthlyReport         - Shows a report of admin activity in the specified month
                             zxsuite admin getMonthlyReport [attr1 value1 [attr2 value2...]]

  getProperty              - Get configuration properties
                             zxsuite admin getProperty [attr1 value1 [attr2 value2...]]

  getServices              - show current status of all services for this module
                             zxsuite admin getServices 

  monitor                  - Monitor a running operation
                             zxsuite admin monitor {operation_uuid} [attr1 value1 [attr2 value2...]]

  resetDomainSettings      - Resets global account limit, account limit per cos, and domain account quota for the selected domain
                             zxsuite admin resetDomainSettings {domain} 

  setDomainSettings        - Sets domain max account quota and account limit
                             zxsuite admin setDomainSettings {domain} [attr1 value1 [attr2 value2...]]

  setProperty              - Set configuration property
                             zxsuite admin setProperty {property_name} {property_value} 

zxsuite help admin doAddDelegationSettings

zxsuite help admin doAddDelegationSettings
Adds a delegation privilege for a user on a domain

Syntax:
   zxsuite admin doAddDelegationSettings {account} {domain} [attr1 value1 [attr2 value2...]]

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 [email protected] 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.

zxsuite admin doAddDelegationSettings [email protected] example.com adminQuota 0
Adds John as delegated administrator of domain example.com, with the right to assign unlimited quotas to users.

zxsuite admin doAddDelegationSettings [email protected] 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 help admin doEditDelegationSettings

zxsuite help admin doEditDelegationSettings
Edits the delegation privileges for a user on a domain

Syntax:
   zxsuite admin doEditDelegationSettings {account} {domain} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME               TYPE       EXPECTED VALUES    
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 [email protected] 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.

zxsuite admin doEditDelegationSettings [email protected] example.com adminQuota 0
Edits John's delegation rights for domain example.com, with the right to assign unlimited quotas to users.

zxsuite admin doEditDelegationSettings [email protected] 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 help admin doExportQuotaHistory

zxsuite help admin doExportQuotaHistory
Export multiple monthly quota usage information both in text and json form

Syntax:
   zxsuite admin doExportQuotaHistory {users|domains} {json|csv} {file_path} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME               TYPE      EXPECTED VALUES                                                                                                                                                                                                                  
data_type(M)       String    users|domains                                                                                                                                                                                                                    
output(M)          String    json|csv                                                                                                                                                                                                                         
file_path(M)       String                                                                                                                                                                                                                                     
month(O)           String    99/9999                                                                                                                                                                                                                          
filterByName(O)    String    [email protected]|example.com                                                                                                                                                                                                    
fieldName(O)       String    totAccountsOnDomain|totUsedSpaceOnDomain|systemResourcesOnDomain|calendarResourcesOnDomain|totAccountsWithUnlimitedSpace|totAvailableSpaceOnDomain|totUsedSpaceOnDomainByUnlimitedUsers|maxAccountsOnDomain|spaceUsedAccounts    

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

zxsuite help admin doMigrateAdmin

zxsuite help admin doMigrateAdmin
update the configuration of rights

Syntax:
   zxsuite admin doMigrateAdmin [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME        TYPE       EXPECTED VALUES    DEFAULT
force(O)    Boolean    true|false         false

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

Usage example:

zxsuite admin doMigrateAdmin
zxsuite admin doMigrateAdmin force true

zxsuite help admin doMonthlyReport

zxsuite help admin doMonthlyReport
Generate a report of admin activity in the specified month

Syntax:
   zxsuite admin doMonthlyReport [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                TYPE       EXPECTED VALUES            DEFAULT
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

Usage example:

zxsuite admin doMonthlyReport
Generates the monthly report for the previous month and saves it in the currentAdmin log path

zxsuite admin doMonthlyReport month 07/2017
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.

zxsuite help admin doRemoveDelegationSettings

zxsuite help admin doRemoveDelegationSettings
Removes a delegation privilege for a user on a domain

Syntax:
   zxsuite admin doRemoveDelegationSettings {account} {domain} 

PARAMETER LIST

NAME          TYPE      
account(M)    String    
domain(M)     String    

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

Usage example:

zxsuite admin doRemoveDelegationSettings [email protected] example.com
John no longer administers domain example.com

zxsuite help admin doRepairAdmin

zxsuite help admin doRepairAdmin
Repair Admin delegation and domain setting

Syntax:
   zxsuite admin doRepairAdmin 

Usage example:

zxsuite admin doRepairAdmin

zxsuite help admin doRestartService

zxsuite help admin doRestartService
restart a given service

Syntax:
   zxsuite admin doRestartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help admin doSetZimletRights

zxsuite help admin doSetZimletRights
Fixes the administrative zimlet rights for all delegated admins.

Syntax:
   zxsuite admin doSetZimletRights 

Usage example:

zxsuite help admin doShowAdminActivity

zxsuite help admin doShowAdminActivity
Shows all recorded admin activity

Syntax:
   zxsuite admin doShowAdminActivity [attr1 value1 [attr2 value2...]]

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

Usage example:

zxsuite admin doShowAdminActivity admin [email protected] 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.

zxsuite admin doShowAdminActivity admin [email protected] 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 help admin doStartService

zxsuite help admin doStartService
start a given service

Syntax:
   zxsuite admin doStartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help admin doStopAllOperations

xsuite help admin doStopAllOperations
Stops all running operations and empties the operations queue

Syntax:
   zxsuite admin doStopAllOperations 

Usage example:

zxsuite admin doStopAllOperations
Stops all running operations

zxsuite help admin doStopOperation

zxsuite help admin doStopOperation
Stop a single running operation

Syntax:
   zxsuite admin doStopOperation {operation_uuid} 

PARAMETER LIST

NAME                 TYPE    
operation_uuid(M)    Uiid    

(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 help admin doStopService

zxsuite help admin doStopService
stop a given service

Syntax:
   zxsuite admin doStopService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help admin getAllOperations

zxsuite help admin getAllOperations
Displays all running and queued operations

Syntax:
   zxsuite admin getAllOperations [attr1 value1 [attr2 value2...]]

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 help admin getDelegationSettings

zxsuite help admin getDelegationSettings
Shows delegated admins with their domains of competency, the viewMail attribute and the admin-assignable quota

Syntax:
   zxsuite admin getDelegationSettings [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME         TYPE      
domain(O)    String    

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

zxsuite help admin getDomainSettings

zxsuite help admin getDomainSettings
Syntax:
   zxsuite admin getDomainSettings 

Usage example:

zxsuite help admin getMonthlyReport

zxsuite help admin getMonthlyReport
Shows a report of admin activity in the specified month

Syntax:
   zxsuite admin getMonthlyReport [attr1 value1 [attr2 value2...]]

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

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 Admin log path, this command will fail.

zxsuite help admin getProperty

zxsuite help admin getProperty
Get configuration properties

Syntax:
   zxsuite admin getProperty [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                TYPE           EXPECTED VALUES    
verbose(O)          Boolean        true|false         
property_name(O)    String[,..]                       

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

zxsuite help admin getServices

zxsuite help admin getServices
show current status of all services for this module

Syntax:
   zxsuite admin getServices 

Usage example:

zxsuite help admin monitor

zxsuite help admin monitor
Monitor a running operation

Syntax:
   zxsuite admin monitor {operation_uuid} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                 TYPE      
operation_uuid(M)    Uiid      
operation_host(O)    String    

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

zxsuite help admin resetDomainSettings

zxsuite help admin resetDomainSettings
Resets global account limit, account limit per cos, and domain account quota for the selected domain

Syntax:
   zxsuite admin resetDomainSettings {domain} 

PARAMETER LIST

NAME         TYPE      
domain(M)    String    

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

zxsuite help admin setDomainSettings

zxsuite help admin setDomainSettings
Sets domain max account quota and account limit

Syntax:
   zxsuite admin setDomainSettings {domain} [attr1 value1 [attr2 value2...]]

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

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

zxsuite admin setDomainSettings example.com add_cos_limits cos1:30

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

zxsuite help admin setProperty

zxsuite help admin setProperty
Set configuration property

Syntax:
   zxsuite admin setProperty {property_name} {property_value} 

PARAMETER LIST

NAME                 TYPE      
property_name(M)     String    
property_value(M)    String    

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

zxsuite help config

zxsuite help config

Commands regarding Network Modules NG Config

  account                  - account config
                             zxsuite config account {set|get|empty} {accountName} [attr1 value1 [attr2 value2...]]

  distributionList         - distributionList config
                             zxsuite config distributionList {set|get|empty} {distributionListName} [attr1 value1 [attr2 value2...]]

  cos                      - cos config
                             zxsuite config cos {set|get|empty} {cosName} [attr1 value1 [attr2 value2...]]

  domain                   - domain config
                             zxsuite config domain {set|get|empty} {domainName} [attr1 value1 [attr2 value2...]]

  server                   - server config
                             zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]

  global                   - global config
                             zxsuite config global {set|get|empty} [attr1 value1 [attr2 value2...]]

  info                     - get attributes info
                             zxsuite config info [attr1 value1 [attr2 value2...]]

  status                   - Get Config component status
                             zxsuite config status 

  clean                    - remove expired attributes
                             zxsuite config clean 

  doStartService           - start a given service
                             zxsuite config doStartService {service_name} 

  doStopService            - stop a given service
                             zxsuite config doStopService {service_name} 

  getServices              - show current status of all services for this module
                             zxsuite config getServices 

  doRestartService         - restart a given service
                             zxsuite config doRestartService {service_name} 

zxsuite help config account

zxsuite help config account
account config

Syntax:
   zxsuite config account {set|get|empty} {accountName} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME              TYPE               EXPECTED VALUES    
command(M)        String             set|get|empty      
accountName(M)    Account Name/ID                       
attribute(O)      String                                
value(O)          String                                

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

Usage example:

zxsuite config account get accountName attribute debranded
zxsuite config account set accountName attribute debranded value true
zxsuite config account empty accountName attribute debranded

zxsuite help config distributionList

zxsuite help config distributionList
distributionList config

Syntax:
   zxsuite config distributionList {set|get|empty} {distributionListName} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME                       TYPE      EXPECTED VALUES    
command(M)                 String    set|get|empty      
distributionListName(M)    String                       
attribute(O)               String                       
value(O)                   String                       

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

Usage example:

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

zxsuite help config cos

zxsuite help config cos
cos config

Syntax:
   zxsuite config cos {set|get|empty} {cosName} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME            TYPE      EXPECTED VALUES    
command(M)      String    set|get|empty      
cosName(M)      String                       
attribute(O)    String                       
value(O)        String                       

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

Usage example:

zxsuite config cos get cosName attribute debranded
zxsuite config cos set cosName attribute debranded value true
zxsuite config cos empty cosName attribute debranded

zxsuite help config domain

zxsuite help config domain
domain config

Syntax:
   zxsuite config domain {set|get|empty} {domainName} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME             TYPE           EXPECTED VALUES    
command(M)       String         set|get|empty      
domainName(M)    Domain Name                       
attribute(O)     String                            
value(O)         String                            

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

Usage example:

zxsuite config domain get domainName attribute debranded
zxsuite config domain set domainName attribute debranded value true
zxsuite config domain empty domainName attribute debranded

zxsuite help config server

zxsuite help config server
server config

Syntax:
   zxsuite config server {set|get|empty} {serverName} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME             TYPE      EXPECTED VALUES    
command(M)       String    set|get|empty      
serverName(M)    String                       
attribute(O)     String                       
value(O)         String                       

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

Usage example:

zxsuite config server get serverName attribute debranded
zxsuite config server set serverName attribute debranded value true
zxsuite config server empty serverName attribute debranded

zxsuite help config global

zxsuite help config global
global config

Syntax:
   zxsuite config global {set|get|empty} [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME            TYPE      EXPECTED VALUES    
command(M)      String    set|get|empty      
attribute(O)    String                       
value(O)        String                       

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

Usage example:

zxsuite config global get attribute debranded
zxsuite config global set attribute debranded value true
zxsuite config global empty attribute debranded

zxsuite help config info

zxsuite help config info
get attributes info

Syntax:
   zxsuite config info [attr1 value1 [attr2 value2...]]

PARAMETER LIST

NAME            TYPE      
attribute(O)    String    

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

zxsuite help config status

zxsuite help config status
Get Config component status

Syntax:
   zxsuite config status 

Usage example:

zxsuite help config clean

zxsuite help config clean
remove expired attributes

Syntax:
   zxsuite config clean 

Usage example:

zxsuite help config doStartService

zxsuite help config doStartService
start a given service

Syntax:
   zxsuite config doStartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help config doStopService

zxsuite help config doStopService
stop a given service

Syntax:
   zxsuite config doStopService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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

zxsuite help config getServices

zxsuite help config getServices
show current status of all services for this module

Syntax:
   zxsuite config getServices 

Usage example:

zxsuite help config doRestartService

zxsuite help config doRestartService
restart a given service

Syntax:
   zxsuite config doRestartService {service_name} 

PARAMETER LIST

NAME               TYPE      
service_name(M)    String    

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