Skip to main content
Back to top
Ctrl
+
K
25.9.0
Introduction
Upgrade to Carbonio 25.9.0
Using Ansible
Manual From Previous Version
Manual From Older Versions
OS Upgrade
Carbonio Changelogs
Older Changelogs
Release 25.6.0
Release 25.3.1
Release 25.3.0
Release 24.12.1
Release 24.12.0
Release 24.9.1
Release 24.9.0
Release 24.7.1
Carbonio Changelog - Release 24.7.0
Carbonio Changelog - Release 24.5.0
Carbonio Changelog - Release 24.3.0
Carbonio Changelog - Release 24.1.0
Carbonio Changelog - Release 23.12.0
Changelog 23.11.0
Changelog 23.10.0
Changelog 23.9.0
Changelog 23.7.0
Changelog 23.6.0
Changelog 23.5.0
Changelog 23.4.0
Changelog 23.3.0
Changelog 23.2.0
Architecture of Carbonio
Components Description and Installation
Mesh & Directory
Database
Mesh
Proxy
MTA AV/AS
Mailstore & Provisioning
Files
Docs & Editor
Preview
Tasks
Chats
Video Server & Video Recording
Monitoring
Event Streaming
Directory Replica
Introducing
systemd
as New Carbonio Init System
Carbonio
Systemd
Targets
Systemd
Usage Guide For Administrators
Install
Requirements
Preliminaries
Installation Scenarios
Prepare the Ansible Environment
Install Carbonio Using Ansible
Scenario Single-Server
Single-Server Installation with Ansible
Single-Server Manual Installation
Extend Manual Installation: Collaboration Node
Extend Manual Installation: Video Server Node
Scenario Essential
Ansible Playbook
Manual Components Installation
Scenario Full Small
Ansible Playbook
Manual Components Installation
Scenario Full Standard
Ansible Playbook
Manual Components Installation
Scenario Redundant
Ansible Playbook
Manual Components Installation
Scenario Redundant with User Mail Replica
Carbonio Preliminaries and Installation
User Mail Replica Installation
Check User Mail Replica Services Status
Post-Install
Activate license
Centralised Logging Configuration
Enable SSH Keys Automatic Login
Access to the Web Interface
Migration to Carbonio
From Zextras Suite Compatible Platform
From Zextras Suite Compatible Platform - Provisioning Only
From Generic E-mail Systems Based on Compatible AD or OpenLDAP
From Generic E-mail Systems
Admin by Graphical Interface
Carbonio Admin Panel Overview
White-label
Domains
Create New Domain
Authentication Methods
Create Accounts
Global
Manage
Details
Class of Services (COS)
MTA
Storage
Subscriptions
Privacy
Backup
Legal Hold
Notifications
Operations
Administrative Roles Explained
Admin by Command Line
Carbonio CLI Overview
Administration Tasks
E-mail Aliases Management
Setting Features from CLI
Renew a Let’s Encrypt Certificate
Configuring Domain Disclaimer
Analytics Management
Change the Private IP address
Change the Carbonio Hostname
Remove a Node From Carbonio Infrastructure
S3 Benchmark
Setting System Locale
Domain Parameters to Publish Carbonio Webmail
Advanced Administration Tasks
Authentication
Carbonio Admin
Carbonio Auth
Carbonio Core
Carbonio Docs and Files
Carbonio Backup
Architecture
Common Tasks
Legal Hold
Restore Strategies
Advanced Techniques
Carbonio Mobile
Carbonio Storage
Carbonio User Mail Replica
Customisations
Working with Carbonio Mesh
Managing Agents
Common Operations
Carbonio Mesh Credentials
Managing the Leader Node
Set up Multiple Carbonio Mesh Servers
Carbonio Mesh Administration Interface
Rejoin Carbonio Mesh Cluster
Security
Infrastructure Domain SSL certificate
Chats Advanced
Antivirus & Antispam Management
Monitoring Carbonio
Log Files
MTA Component
Prometheus
Carbonio Monitoring Automation With Carbonio Mesh
Ports And Paths Useful For Monitoring
Troubleshooting Carbonio
Upgrade
Directory Server
Database Component
Connection with the Database
Upgrade to PostgreSQL 16
Pgpool Removal
Authentication
Proxy Component
Backups
Chats
Migration
Services Status
Generic Issues
How to report an issue
API
Working With the Carbonio Files API
Glossary
About the Documentation
Changelog 2025-09
Changelog 2025-07
Changelog 2025-06
Changelog 2025-05
Changelog 2025-04
Changelog 2025-03
Changelog 2025-02
Changelog 2025-01
Changelog 2024-12
Changelog 2024-11
Changelog 2024-10
Command Line Reference
Carbonio Admin
deleteUsageData
getUsageData
initDomainForDelegation
Carbonio Auth
credential add
credential delete
credential list
credential update
getServices
policy list domain
policy list global
policy set Cli domain
policy set Cli global
policy set Dav domain
policy set Dav global
policy set DesktopApp domain
policy set DesktopApp domain
policy set EAS domain
policy set EAS global
policy set Imap domain
policy set Imap global
policy set MobileApp domain
policy set MobileApp global
policy set Pop3 domain
policy set Pop3 global
policy set Smtp domain
policy set Smtp global
policy set WebAdminUI domain
policy set WebAdminUI global
policy set WebUI domain
policy set WebUI global
policy set ZmWebUI domain
policy set ZmWebUI global
auth policy trustedDevice getExpiration domain
auth policy trustedDevice getExpiration global
policy trustedDevice setExpiration domain
policy trustedDevice setExpiration global
saml delete
saml generate
saml get
saml import
saml update
saml validate
token invalidate
token list
totp delete
totp generate
totp list
trustedDevice delete
trustedDevice list
Carbonio Backup
check-ldap-dump
doAccountScan
doBackupCluster
doBackupLDAP
doBackupServerCustomizations
doCheckShares
doCoherencyCheck
doExport
doExternalRestore
doFixShares
doItemRestore
doItemSearch
doPurge
doRestartService
doRestoreBlobs
doRestoreOnNewAccount
doSmartScan
doStartService
doStopAllOperations
doStopOperation
doStopService
doUndelete
getAccountInfo
getAllOperations
getAvailableAccounts
getAvailableDomains
getBackupInfo
getItem
getMap
getServerConfig
getServices
legalHold get
legalHold set
legalHold unset
migrateBackupVolume Alibaba
migrateBackupVolume Ceph
migrateBackupVolume Cloudian
migrateBackupVolume CustomS3
migrateBackupVolume Default
migrateBackupVolume EMC
migrateBackupVolume Local
migrateBackupVolume S3
migrateBackupVolume Scality
monitor
retrieveMetadataFromArchive Local
S3retrieveMetadataFromArchive S3
scheduler coherencyCheck get global
scheduler coherencyCheck get server
scheduler coherencyCheck set global
scheduler coherencyCheck set server
scheduler purge get global
scheduler purge get server
scheduler purge set global
scheduler purge set server
scheduler SmartScan get global
scheduler SmartScan get server
scheduler SmartScan set global
scheduler SmartScan set server
setBackupVolume Alibaba
setBackupVolume Ceph
setBackupVolume Cloudian
setBackupVolume CustomS3
setBackupVolume Default
setBackupVolume EMC
setBackupVolume Local
setBackupVolume MinIO
setBackupVolume S3
setBackupVolume Scality
updateBackupVolume S3
Carbonio Config
account
clean
cos
distributionList
domain
doRestartService
doStartService
doStopService
dump account
dump cos
dump domain
dump global
dump server
get account
get cos
get domain
get global
get server
getServices
global
info
server
set account
set cos
set domain
set global
set server
status
unset account
unset cos
unset domain
unset global
unset server
Carbonio Core
activate-license
getAccountStats
getAllOperations
getAllServicesStatus
getLicenseInfo
getNotification
getOperationLog
getServices
getUnfinishedOperationLog
getVersion
listBuckets
store-license
testS3Connection
unloadMailbox
doCreateBucket Alibaba
doCreateBucket Ceph
doCreateBucket Cloudian
doCreateBucket CustomS3
doCreateBucket EMC
doCreateBucket MinIO
doCreateBucket S3
doCreateBucket ScalityS3
metrics interval
metrics percentiles
metrics remove
metrics set graphite
metrics status
Carbonio Mobile
ABQ allow
ABQ block
ABQ delete
ABQ deleteRule
ABQ import
ABQ list
ABQ listRules
ABQ setNotificationInterval
ABQ set
ABQ setRule
addressBook add domain
addressBook add global
addressBook list domain
addressBook list global
mobile addressBook remove domain
addressBook remove global
dbMigrate
deleteABQMessage domain
deleteABQMessage global
disableFolderSync
doAddAccountLogger
doAddEASFilter
doDeleteEASFilter
doMoveEASFilter
doPurgeMobileState
doRemoveDevice
doRemoveLogger
doResetAccount
doResetDevice
doRestartService
doResumeDeviceSync
doSimulateSync
doStartService
doStopService
doSuspendDeviceSync
doWipeDevice
duplicateABQMessage domain
duplicateABQMessage global
getABQMessage domain
getABQMessage global
getAccountLoggers
getAllDevices
getAllEASFilters
getDeviceInfo
getDeviceList
getProvisioning
getServices
initABQMessage
setABQMessage domain
setABQMessage global
setProvisioning
setSharedFolderSync
Carbonio Powerstore
doCheckBlobs
doCreateVolume Alibaba
doCreateVolume Centralized
doCreateVolume Ceph
doCreateVolume Cloudian
doCreateVolume CustomS3
doCreateVolume EMC
doCreateVolume FileBlob
doCreateVolume OpenIO
doCreateVolume S3
doCreateVolume ScalityS3
doCreateVolume Swift
doDeduplicate
doDeleteVolume
doMoveBlobs
doPurgeMailboxes
doRemoveHsmPolicy
doRemoveOrphanedBlobs
doRestartService
doStartService
doStopAllOperations
doStopOperation
doStopService
doUpdateVolume Alibaba
doUpdateVolume Ceph
doUpdateVolume Cloudian
doUpdateVolume CustomS3
doUpdateVolume EMC
doUpdateVolume FileBlob
doUpdateVolume OpenIO
doUpdateVolume S3
doUpdateVolume ScalityS3
doUpdateVolume Swift
doVolumeToVolumeMove
getAllOperations
getAllVolumes
getHsmPolicy
getServices
getVolumeStats
Indexing content-extraction-tool add
Indexing content-extraction-tool list
Indexing content-extraction-tool remove
mailboxMove
monitor
runBulkDelete
+setHsmPolicy
setHSMPolicy
Carbonio HA
DEPRECATED
doRestartService
doStartService
doStopService
getAccountStatus
getServices
monitor
pauseReplicas
promoteAccounts
removeAccountDestination
restartReplicas
setAccountDestination
test
Carbonio MailReplica
doRestartService
doStartService
doStopService
getAccountStatus
getServices
monitor
pauseReplicas
promoteAccounts
removeAccountDestination
restartReplicas
setAccountDestination
test
Index
Back to Documentation Hub
Repository
Open issue
getServices
getServices
#
carbonio
MailReplica
getServices
Usage example
carbonio
MailReplica
getServices
