Zimbra NG Modules/First Steps with the Zimbra NG Modules




First Steps with the Zimbra NG Modules

This guides contains all information needed in order to switch to the new Zimbra Network NG modules from their legacy counterparts after upgrading to Zimbra 8.8.

It's strongly suggested to take a look at the specific introductory page of each module before switching, to learn and understand the differences between each NG module and its Legacy counterpart:

  • Zimbra NG Backup: Features a cutting-edge, real-time engine that backs up every single item and event on your Zimbra server with split-second precision. Avoids data loss by using atomic and ever-consistent algorithms, while still saving disk space thanks to an intelligent de-duplication and compression system.
  • Zimbra NG Admin: Global Admin can grant Delegated Admin rights to users on your server using a simplified administrator user interface. With minimal effort, you can grant user management tasks, such as setting quotas, user limits and modifying COS variables for your domain(s).
  • Zimbra NG HSM: Manage multiple volumes and HSM policies through the Zimbra Collaboration NG HSM Module. With an integrated user interface into your Zimbra Administration Console, the HSM Module gives you the tools to organize and manage your storage effectively.
  • Zimbra NG Mobile: With the advance integration, now your users can sync their primary and shared folders to their mobile devices while administrators have an advanced interface to manage policies and devices.

Switching to Backup NG

Switching to the new Backup NG is a simple process that will initialize the new backup system on a dedicated path. Until the initialization is completed, the old backup engine will be active. Old backup files will not be removed and the old backup and restore tools are still available via the usual CLI commands.

Backup Path Limitations

In order to hold Backup NG data, a storage must comply to the following:

  • The storage must have a mountpoint on the system.
  • The "zimbra" user must of course have r/w permission on the path.
  • The data must be stored on a case-sensitive filesystem.

Other than this, there are no hard limitations.

Backup NG Initialization

Before initializing the Backup NG module, make sure you have enough space on the storage you wish to store the backup in. The average size of the backup is 50-70% of the nominal total quota of all mailboxes.

To initialize the Backup NG module:

  • Access the Zimbra Administration Console.
  • Enter the "Network Modules NG" section on the left menu.
  • Enter the "Backup" section.
  • Set the "Backup Path" to whatever directory you wish to store your backup into.
  • Click on the "Initialize" button

Usage Guide

A complete user guide for the Backup NG Module is available in the "Backup NG (NG)" section of the Administrator's Guide for your Zimbra version.


Switching to Mobile NG

Switching to the new Mobile NG is a simple process that will activate the new mobile handlers, deactivate the old ones and switch the synchronization control over to Mobile NG from the legacy Zimbra Mobile. Until the initialization is completed, the old mobile engine will be active.

NOTE: Mobile NG is not currently compatible with two factor authentication or S/MIME. For those who need these two features, please use the legacy mobile sync service at this time.

What happens after the switch

After switching to Mobile NG, all existing syncstates will be invalidated, and all connected devices will automatically re-synchronize all of their data through the new engine.

WARNING: Since the switch will force all connected devices to re-synchonise all of their data, make sure to alert your users beforehand to make sure that they have wifi coverage or enough traffic on their mobile data plans.

Furthermore, the switch might lead to an abrupt increase in the number of connections to the server, and consequently its load, due to the resynchronisation of all devices.

The switch is completely transparent to end users, and no user interaction should be prompted or required, but being the Exchange ActiveSync protocol mostly client-driven different behaviours might be experienced, such as:

  • Device not synchronising until user's action (e.g. opening the email client).
  • Device requiring a restart.
  • Device not synchronising until the user re-enter its username and password in the account's settings.

Albeit sporadic, such behaviours and the load impact on the system should be taken into account when planning to switch to Mobile NG.

Mobile NG Initialization

To initialize the Mobile NG module:

  1. Enter the "Network Modules NG" section on the left menu.
  2. Enter the "General" section -> By default, “Mobile” module will be in Stopped state.
  3. Click on "Start" button infront of Mobile module.
  4. Error message will be shown and admin is asked to set zimbraNetworkMobileNGEnabled attribute to TRUE from CLI.
  5. Set zimbraNetworkMobileNGEnabled attribute to TRUE on the server using below command:
    zmprov ms <server> zimbraNetworkMobileNGEnabled TRUE
  6. Then, start NG Mobile service using Admin Console UI by visiting "Network Modules NG" -> “General” -> click on Start button in front of Mobile module.


Usage Guide

A complete user guide for the Mobile NG Module is available in the "Mobile NG" section of the Zimbra Administrator's Guide for your Zimbra version.


Switching to HSM NG

The HSM NG module will become active as soon as the upgrade to Zimbra 8.8 is completed, and does not require any interaction.

Any old HSM policy, volume and volume configuration will be maintained.

Usage Guide

A complete user guide for the HSM NG Module is available in the "HSM NG" section of the Zimbra Administrator's Guide for your Zimbra version.


Switching to Admin NG

Switching to the new Admin NG module is a simple process that will migrate any relevant ACL information to the module’s own configuration manager, clearing existing ACLs and ACEs from the system.

Admin NG is significantly different than the old Delegated Administration engine. Please carefully read the product's documentation thoroughly and only migrate to Admin NG if its feature set meets your needs.

Admin Migration is a ONE WAY ONLY process

Switching to Admin NG will remove all existing ACLs and ACEs from the server. This new module is extremely different from its legacy counterpart, so after the migration will not be able to recreate the very same admin roles and settings

This is a one way only process.

Once Admin NG is initialized it's not possible to go back to the old engine, so if you have customized or complex ACLs/ACEs carefully consider whether or not to switch.

Admin NG Initialization

Initialize Admin NG on Zimbra 8.7.6 to 8.8.4

  • Access the Zimbra Administration Console.
  • Enter the "Network Modules NG" section on the left menu.
  • Enter the "Admin" section.
  • Click on the "Migrate" button.

Enable and initialize Admin NG on Zimbra 8.8.5+

Admin NG is disabled by default in Zimbra 8.8.5+ and its GUI is not available out-of-the-box, so it's necessary to enable the module beforehand running

zmprov mcf zimbraNetworkAdminNGEnabled TRUE

as the "zimbra" user.

After enabling the Admin NG module, it can be initialized following this steps:

  • Perform a mailbox restart, i.e
     zmmailboxdctl restart 
  • Access the Zimbra Administration Console.
  • Enter the "Network Modules NG" section on the left menu.
  • Enter the "Admin" section.
  • Click on the "Migrate" button.

Usage Guide

A complete user guide for the Admin NG Module is available in the "Admin NG" section of the Zimbra Administrator's Guide for your Zimbra version.


Zimbra NG Modules

zimbra-logo-color.png

Latest Version: 8.8

Zimbra NG Modules Resources

Here you can find useful resources for your Zimbra NG Modules



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search