This chapter discusses Zextras Backup, the Zextras Suite component in charge of backing up all data. The chapter is organised into many sections: first, an overview of the most typical task is provided, followed by links to more technical literature.
Following that, the architecture of Zextras Backup is defined, which includes crucial ideas to understand ahead of time; the concepts will be explored in the rest of the chapter.
Finally, the choices for periodically storing and checking the backed-up data are offered. The relevant Command Line Reference is included with each section.
Backup Common Tasks using Zextras
This section offers guidance for the most typical tasks encountered by users, as well as access to technical information.
How to Use Zextras Backup
After you’ve done configuring your servers, you’ll need to take a few more steps to configure the Backup module and have all of your data automatically backed up.
Install a storage device at the desired place. Throughout this part, we will use the default location /opt/zimbra/backup/zextras; remember to change it with the path you choose.
Once the backup route has been defined, it must be initialised, which may be done using the admin panel or the command line. In the first scenario, in the upper right corner of Fig. 6, click the Initialise NOW! button. From the command line, initialization is accomplished by simply running SmartScan for the first time: backup using zxsuite begin SmartScan
Zextras Backup Architecture
- a message sent through email
- a person or a group of people
- a file folder
- a scheduled appointment
- a task
- a Google Drive file
- an account (together with its settings)
- a list of recipients
- a website
- a type of service (COS)
- Server setup, or the configuration of each server
- Zextras product parameters at the global level
- Any software modifications (Postfix, Jetty, etc…)
- after an email has been read, deleted, or moved to a folder
- a change in a contact’s name, address, or employment
- the removal or addition of a file from a folder
- a change in the status of an object (for example, an account)
Real-Time Scan and SmartScan
When Should Scan Operations Be Disabled?
- You have a high volume of transactions every day (or frequently interact with Drive documents) and observe a heavy burden on the server’s resources. You can temporarily disable the Real Time Scan in this scenario.
- You begin a migration: In this scenario, it is recommended that you halt the SmartScan since it will generate a large number of I/O operations on disc and may even cause the server to crash. It would, in fact, consider every migrated or restored object as if it were a new one.
- You receive and send a large number of emails each day. In this situation, you should always have the Real period Scan enabled, because otherwise, all transactions would be backed up solely by the SmartScan, which may be unable to finish in a reasonable period due to the resources required for I/O operations.
- map_[server_ID] are so-called map files that indicate if the Backup was imported from an external backup and include the server’s unique ID in the filename.
- accounts is a directory containing information for all accounts defined in the Mailbox. There are particularly significant files and folders to be found there:
- account_info is a file that contains all of the account’s metadata, such as the password, signature, and preferences.
- account_stat is a file that contains different statistics about the account, such as the ID of the most recently saved material by SmartScan.
- backupstat is a file that stores general backup statistics, such as the timestamp of the first run.
- drive_items is a directory that contains up to 256 subfolders (named with two hexadecimal lowercase letters) that hold Drive items based on the last two letters of their UUID.
- items is a directory with up to 100 subfolders (the names of which are made up of two digits, and in which things are placed according to their ID’s last two digits).
- servers is a directory that stores daily archives of the server setup and customizations, Zextras configuration, and chat, up to the configured server retention duration.
- items is a directory that may hold up to 4096 extra folders and is named with two hexadecimal (uppercase and lowercase) characters. Items in the Mailbox will be saved in the directory with the last two characters of their ID as the name.
- id_mapper.log is a user object ID mapping file that contains a link between the original and restored objects. It may be found in /backup/zextras/accounts/xxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/id_mapper.log. This file is only present in the event of an external restoration.
Configuring the Backup Path
- Via GUI: under “Backup Path” in the “Backup” section of the Zextras Administration Zimlet.
- Change the ZxBackup_DestPath config key using the zxsuite config server command.
Policy on Retention
- The data retention policy only applies to single items and is set to 30 days by default.
- Account retention policy applies to the accounts and is set to 30 days by default.
Check for Coherence
How Does Zextras Backup Work?
- The zimbra user should be able to read and write to it.
- Make use of a case-sensitive filesystem.
The Structure of an Item
Team Database Backup
What exactly is the SmartScan?
What is the procedure?
When is a SmartScan performed?
- When you launch the Zextras Backup module.
- If the Administration Zimlet’s Scan Operation Scheduling is activated, this will happen every day.
- When the Real Time Scanner is re-enabled via the Administration Zimlet after having been deactivated earlier
What is the procedure?
- Emptied Folder – when the Empty Folder button in the right-click context menu is used.
What exactly is the Backup Purge?
Backup Limitations and Special Cases
- The newest state available should NOT be used to restore an active account on a new account. Assume that a person deletes all of his emails by accident, or that the emails in an account are lost for whatever cause (for example, a server failure). The user requests their return and approaches the administrator. If the admin restores the account’s status to the most recent accessible state, the new account will include the most recent available state, which is an empty account, because the email was previously erased in the most recent state.
- As a result, in order to successfully recover the account, it must be restored at a period in time before the emails were deleted.
- If the email client is configured to download email messages and delete them immediately from the server while utilising the POP3/POP3S protocol, these messages may not be included in the backup. If the Zextras Powerstore component is installed, this does not occur.
- When an email is sent directly over an SMTP connection (e.g., using a multifunctional device or connecting to the STMP server through telnet), it is not included in the backup.
- When sending email using an IMAP/SMTP client, the IMAP client must be set to store the send email in a remote folder (through the IMAP STORE command) after the send operation; otherwise, the email may not be included in the backup.
Troubleshooting LDAP Backup
Root credentials are missing.
External storage backup
How External Storage Backup Works
- backup zxsuite doSmartScan
- backup zxsuite doAccountScan
- BackupServerCustomizations in zxsuite
- backup zxsuite doBackupLDAP
- backup doBackupCluster zxsuite