ZCS Administrator's Guide, Network Edition 5.0 (Rev 5.0.19 September 2009)
Table of Contents Previous Next Index


Zimbra Archiving and Discovery : Installing Archiving Package as an Update to ZCS

Installing Archiving Package as an Update to ZCS
The Zimbra-archiving package can be installed and configured on an existing single-server deployment or on a multi-server deployment as an upgrade to ZCS, and archiving is enabled on each MTA in your ZCS deployment.
If the mailbox server and the MTA server reside on the same node, you configure and enable archiving as a single upgrade process. If your mailbox and MTA servers are on separate nodes, the zimbra-archive package is installed first on at least one mailbox server and then the archiving component is enabled on each MTA in the deployment.
Installing zimbra-archiving in a Single-Server Environment
In this upgrade process, it is assumed that the LDAP, MTA, mailstore and archiving servers are on the same node. To install archiving in a single-server deployment, you have to:
Follow these steps to install and enable archiving on a single-server:
1.
Refer to the Single-server Quick Start guide to open an SSH connection to the ZCS server. Log on to the server as root and run the ./install.sh command to begin the upgrade process.
2.
Accept the license agreement. The server then checks for existing packages and asks if you wish to upgrade. Type Yes to run the upgrade.
3.
Type Yes for zimbra-archiving when presented with the packages to be installed.
The upgrade process begins and the archiving package is installed. At this point the Discovery feature in installed and can be used.
4.
To enable archiving, switch user to zimbra and enable archiving on the MTA server.
a.
zmprov ms <zmhostname> +zimbraServiceEnabled archiving
b.
zmcontrol stop
zmcontrol start
Installing zimbra-archiving in a Multi-Server Environment
The following upgrade scenario assumes that the LDAP server, MTA server(s), and mailstore server(s) have ZCS installed correctly. You are now adding a new server that will be dedicated as a archiving server to this environment.
When you add archiving and discovery to an existing ZCS multi-server environment as a dedicated archiving server, you install the zimbra-archiving package and the zimbra-store package on the dedicated server, and you enable archiving on each MTA server in your deployment.
Before beginning the install process, note down the following information. You need this when you install the archiving server. Run the zmlocalconfig -s command to find the information.
LDAP Admin Password ____________
LDAP Hostname _____________
LDAP Port _____________
Refer to the Multiple-Server Installation chapter in the Multi-Server Install Guide for detailed steps on installing the packages.
1.
Open an SSH connection to the mailbox server that is being configured for archiving. Log on to the server as root and unpack the Zimbra software. Run the ./install.sh command to begin the install process.
2.
Type y and press Enter to install the following packages:
The zimbra-core package is installed by default.
 
    zimbra-store
    zimbra-archiving
3.
Type y and press Enter to modify the system.
4.
The Main menu displays the default entries for the Zimbra component you are installing. To expand the menu, type x and press Enter.
5.
Select the Common Configuration menu and configure the LDAP Hostname, LDAP password, and LDAP port.
6.
Select the zimbra-store menu and configure the Admin password and the License file location.
Complete the installation process following the steps under Installing Zimbra Mailbox Server. At this point the Discovery feature is installed and can be used.
Enable archiving on each MTA
After the archiving package has been installed on the archiving server, you must enable archiving on each MTA server in the deployment. Complete the following on each MTA server. This is run as zimbra.
1.
zmprov ms <zmhostname> zimbraServiceInstalled archiving +zimbraServiceEnabled archiving
2.
zmcontrol stop
zmcontrol start
Repeat for MTA server.
Creating Dedicated Archive COS in a Multi-Server Environment
In a multi server deployment with a dedicated archive server, you create a dedicated archive COS for the server. This COS is set up on the archive server as a dedicated host. The server is removed from the COS server pool so that the archive server is not randomly assigned to new accounts.
You can create the COS from the administration console or from the CLI. Attributes can be configured in the COS to set mailbox features, quotas, and password, turn off spam and virus checks and to hide the archive accounts from GAL. In addition to setting these attributes, you remove the archive server from the COS server pool.
Note: These steps to remove the server from the server pool are not done in a single-server deployment. Creating a dedicated archiving COS is a good idea as this makes it easy to create archive mailboxes that are configured the same.
Using the Administration Console
Create a new dedicated COS configured correctly for your archive accounts. To remove the server from the server pool, in the Server Pool tab deselect the archive server.
Using CLI
To obtaining the zimbra-store server ID of the archive server and the server pool, zimbraMailHostPool ID.
1.
zmprov gs -e <archivestoreservername> zimbraID
The archive store server ID is returned.
 
zmprov gs -e local host.com zimbraID
2.
zmprov gc default zimbraMailHostPool
In this example, the default COS lists three servers, including the archive server.
 
zimbraMailHostPool: 6515ef25-2d56-4cd7-951c-c922g23d6e8e d6b9a0 266e-46ac-a1a5-7391d4763616 d6b9a0 266e-25ca-a1a5-7451d4951616
3.
zmprov mc <cos> zimbraMailHostPool <archiveserver ID>
 
zmprov mc default zimbraMailHostPool 6515ef25-2d56-4cd7-951c-c922g23d6e8e
Repeat this process to remove the archive store server ID from the zimbraMailHostPool in all existing COS
4.
Now create an COS for the archive server. Set the zimbraMailHostPool on a single Zimbra server to only be the archive server ID.
zmprov cc <archivingCOSName> zimbraMailHostPool <archive server ID>
 
Now when you create an archive account and use the archive COS, the account is automatically created on the archive server.
Administering the archive server
The amavisd-new server process controls account archiving as well as antivirus and antispam processes. The zmarchivectl command can be used to start, stop, restart or obtain the status of the amavisd-new server process that controls account archiving. Caution should be taken when starting or stopping the archiving process as it is a shared server process between archiving, antivirus, and antispam processes. Performing actions on any of them affect any of the other services that may be enabled in your deployment.
If you want to disable archiving and not antivirus, or antispam services, disable the respective service either through the CLI or through the administration console.
To disable archiving using CLI, type
zmprov ms <zmhostname> -zimbraServiceEnabled archiving
Archiving Attribute
Four attributes are related to the archive feature. Two that configure a mailbox and two template attributes to construct the archive account names.
Attributes configured on users’ account
To set up archiving for a mailbox two attributes are configured on the primary user’s mailbox. One attributed enables archiving and the second shows where messages are being archived.
amavisArchiveQuarantineTo — The current archives address. If this is unset, archiving is not enabled.
zimbraArchiveAccount — Any previous and current archive addresses that this mailbox was archived to.
Archive Account Name Templates
In order to construct archive account names, Zimbra supports two attributes that establish the archive naming conventions. These attributes are used to create and manage archive accounts naming scheme. You can set up these attributes either by COS or by account. For COS, these attributes can be changed using zmprov mc. For accounts, use zmprov ma.
zimbraArchiveAccountDateTemplate. This attribute sets the date format used in the name template. The default is yyyyMMdd. Adding the date to the account name makes it easier to roll off older data from the system to backups.
zimbraArchiveAccountNameTemplate. This attribute sets up how the archive mailbox name is created. The default value is ${user}-${date}@${domain}.archive. The archive account address would be like this example: user-20070510@example.com.archive. If you change the default value, you must use syntax that creates a valid email address. We recommend that you add .archive to all archive accounts to create archive mailboxes in a non-routable domain to prevent spoofing of the archives.
Creating Archive Mailboxes
Archive mailboxes are created using the CLI, zmarchiveconfig. The following archiving scenarios enable archiving for an account:
Note: Archive accounts you create are counted against the number of accounts you can create based on your Zimbra license. Archive mailboxes are listed in the administration console along with the live accounts. Archive forwarding does not count against the Zimbra license.
Create an archive mailbox and assign a COS
1.
2.
Type zmarchiveconfig enable <account@example.com> archive-cos <cosname>
Archive accounts are created based on the Zimbra Archive name templates.
The attribute zimbraIsSystemResource is added to the archive account and set to TRUE.
Create an archive mailbox with no COS or password
If the archive account is not assigned a COS, the following settings are set by default.
To create an account:
1.
2.
Type zmarchiveconfig enable user@example.com.
Enable archive forwarding to a third-party archiving server
If the archive account is not maintained within ZCS, you do not need to set a password, COS or other attributes as no archive account is created in ZCS.
1.
2.
Type zmarchiveconfig enable <account@example.com> archive-address account-archive@offsiteserver.com archive-create false.
Searching Across Mailboxes
When the archiving and discovery feature is installed, you can search across mailboxes using the discovery tool either from the administration console or through the command line interface.
Note: You do not need to have any archive mailboxes configured to search across mailboxes, the package just needs to be installed.
Cross Mailbox Search from the Administration Console
The discovery tool, Search Mail, is added to Tools on the administration console Navigation pane when the archiving package is added. When you click Search Mail, a search wizard opens, allowing you to configure the following information:
Target mailbox and folders. One target mailbox and folder is created automatically. You can use this mailbox for all your search results and create new folders for each search, or you can create a new target mailbox for each separate search.
Note: A target mailbox is like any other mailbox and can have any features or preferences that are defined by the COS or by account. Target mailboxes are listed in the administration console Accounts list. You may want to give the target mailboxes account names that identifies them as target mailboxes for cross-mailbox searches and configure a COS specific for target mailboxes to be able to manage access. For example: CMS_user1.example.com. CMS is a prefix that means cross mailbox search. With this practice, all target mailboxes are listed together
The Maximum number of messages field can be used to limit the number of messages that are returned from the search. If this field is blank or 0, all messages that meet the search criteria are returned.
You can select to automatically notify interested parties when the search is complete. The email notification includes the search task ID and status on the subject line and you can specify the type of to include in the message, such as the number of messages found, the list of addresses resulting from the search and the search query used.
Select which mailboxes to search: all archive mailboxes, all live mailboxes or selected mailboxes. When you check Select accounts to search, you select which account addresses to search.
Create the search query. You can search outgoing and incoming email by date, from, to, cc, subject, keywords, and attachments. Advanced Search can be used to quickly create a query to search by name, dates and time ranges, distribution list, aliases. For a list of the search grammar that can be used see the Zimbra Wiki, Search Tips article.
When searching archive messages, you can search by the envelope address using the envfrom and envto query language extensions.
As the search is being run, the Search Mailbox Content pane lists the search and the status. You can click Refresh to update this page.
You should delete the search task when it is completed as it occupies server memory. Note: When the server is restarted the searches listed in the Search Mailbox Content pane are deleted.
When you use the discovery feature in the administration console, the tool makes copies of messages in the target mailbox you create. The messages occupy server space, increasing the size of your server. You may want to delete these messages from the target mailbox when they are no longer needed.
Search using the Command Line Interface
Use the CLI command, zmarchivesearch to run the cross mailbox search from the command line.
For more information about zmarchivesearch, refer Appendix A, Command-Line Utilities.

Zimbra Archiving and Discovery : Installing Archiving Package as an Update to ZCS

Table of Contents Previous Next Index
ZCS Administrator's Guide, Network Edition 5.0 (Rev 5.0.19 September 2009)
Copyright © 2009 Zimbra Inc.