Zextras Suite Services and Service Management
Services
Each Zextras Suite module is composed by multiple "services", each one providing a specific set of features.
All modules include at least the module
service, which governs the entire module: stopping the service will stop the module, and disabling the auto-start of this service will prevent the entire module to be loaded when the mailboxd service starts.
Service Management
Services can be controlled via the Zextras CLI using the following module commands:
-
getServices
- lists all services and shows their status -
doStartService [serviceName]
- starts the serviceName service -
doStopService [serviceName]
- stops the serviceName service -
doRestartService [serviceName]
- restarts the serviceName service
The getServices
command will show whether the module is running
and if it can be started or stopped, e.g.
zimbra@mail:~$ zxsuite backup getServices services module could_start false could_stop true running true backup-realtime could_start false could_stop true running true [...]
If a service cannot be started, the getServices
command will also display the reason:
zimbra@mail:~$ zxsuite mobile getServices [...] anti-dos could_not_start_because anti-dos disabled could_start false could_stop false running false
Backup Services
zimbra@mail:~$ zxsuite backup getServices services module could_start false could_stop true running true backup-realtime could_start false could_stop true running true purge-cron could_start false could_stop true running true smartscan-cron could_start false could_stop true running true drive-realtime could_start false could_stop true running true backup-attributes-listener could_start false could_stop true running true
Service | Description |
---|---|
|
the entire module |
|
handles the RealTime Scanner and its features |
|
handles the scheduling of the weekly Purge |
|
handles the scheduling of the daily SmartScan |
|
handles the realtime backup of Zextras Drive items |
|
handles instant configuration changes without service restarts |
Mobile Services
zimbra@mail:~$ zxsuite mobile getServices services module could_start false could_stop true running true activesync could_start false could_stop true running true autodiscover could_start false could_stop true running true abq could_start false could_stop true running true anti-dos could_not_start_because anti-dos disabled could_start false could_stop false running false
Service | Description |
---|---|
|
the entire module |
|
handles all Activesync features |
|
handles the Autodiscovery feature |
|
handles the ABQ feature |
|
handles the Mobile Anti DOS feature |
Powerstore Services
zimbra@mail:~$ zxsuite powerstore getServices services module could_start false could_stop true running true powerstore-log could_start false could_stop true running true store-manager-service could_start false could_stop true running true schedule-move-operation could_start false could_stop true running true indexer-manager could_start false could_stop true running true powerstore-attribute-listeners could_start false could_stop true running true
Service | Description |
---|---|
|
the entire module |
|
handles operation logging |
|
handles StoreManager override and third party storages |
|
handles the scheduling of the daily HSM move |
|
handles the internal indexer for mail attachments and files |
|
handles instant configuration changes without service restarts |
Admin Services
zimbra@mail:~$ zxsuite admin getServices services module could_start false could_stop true running true logging could_start false could_stop true running true report-cron could_start false could_stop true running true admin-attributes-listener could_start false could_stop true running true
Service | Description |
---|---|
|
the entire module |
|
handles Admin Logging (reports and auditing) |
|
handles the scheduling of Admin Report generation and distribution |
|
handles instant configuration changes without service restarts |
Team Services
zimbra@mail:~$ zxsuite team getServices services database could_start false could_stop true running true current-chat-services could_start false could_stop true running true module could_start false could_stop true running true team-cluster-status could_start false could_stop true running true team-api could_start false could_stop true running true team-websocket could_start false could_stop true running true team-firebase-notifications could_start false could_stop true running true team-meeting-manager could_start false could_stop true running true team-room-resolver could_start false could_stop true running true team-websocket-handler could_start false could_stop true running true team-http-handler could_start false could_stop true running true team-audit-logger could_start false could_stop true running true team-clustering could_start false could_stop true running true team-request-router could_start false could_stop true running true team-janus-pool could_start false could_stop true running true rooms-cleanup-service could_start false could_stop true running true
Service |
Description |
database |
handles the Team HSQL DB |
current-chat-services |
handles Team services |
module |
the entire module |
team-cluster-status |
keeps track of all available Team API versions in the cluster |
team-api |
handles all private APIs |
team-websocket |
handles websockets needed for all connections |
team-firebase-notifications |
handles mobile notifications |
team-meeting-manager |
handles Instant Meetings |
team-room-resolver |
handles the resolution of Spaces and Channels across servers |
team-websocket-handler |
handles websocket creation and management |
team-http-handler |
handles http/s requests |
team-audit-logger |
handles the Audit Logging feature |
team-clustering |
handles clustering between Team instances in the same infrastructure |
team-request-router |
handles the routing of requests across servers |
team-janus-pool |
Handles Videoserver pooling |
rooms-cleanup-service |
handles the cleanup of empty and unused Spaces, Channels and Groups |
Drive Services
[zimbra@mail ~]$ zxsuite drive getServices services module could_start false could_stop true running true drive-register-api-service could_start false could_stop true running true drive-websocket could_start false could_stop true running true drive-preview could_start false could_stop true running true drive-index could_start false could_stop true running true drive-purge-tombstones could_start false could_stop true running true drive-remove-nodes-marked-for-deletion could_start false could_stop true running true drive-account-cleaner could_start false could_stop true running true drive-request-service could_start false could_stop true running true
module |
the entire module |
drive-register-api-service |
handles private API registration |
drive-websocket |
handles all websockets needed by Drive |
drive-preview |
handles file preview generation |
drive-index |
handles file content indexing |
drive-purge-tombstones |
handles pruning of recently deleted files |
drive-remove-nodes-marked-for-deletion |
handles file deletion |
drive-account-cleaner |
cleans up the Drive HSQL database from accounts deleted from Zimbra |
drive-request-service |
handles private APIs |
Auth Services
[zimbra@mail ~]$ zxsuite auth getServices services module could_start false could_stop true running true auth-database could_start false could_stop true running true auth-database-updater could_start false could_stop true running true user-gateway could_start false could_stop true running true login-assets could_start false could_stop true running true authorization-service could_start false could_stop true running true authentication-service could_start false could_stop true running true key-manager could_start false could_stop true running true migrate-mobile-passwords could_start false could_stop true running true
module |
the module itself |
auth-database |
handles the Auth HSQL DB |
auth-database-updater |
handles database schema updates |
user-gateway |
inactive |
login-assets |
inactive |
authorization-service |
inactive |
authentication-service |
handles authentication features such as Mobile Passwords |
key-manager |
handles encryption keys and secrets |
migrate-mobile-passwords |
handles Mobile Password migrations from pre-Auth Zextras Suite versions |