The Zimbra Administration Console is a browser-based user interface for the central management of Zimbra servers and user accounts.
When you log in to the Administration Console, the tasks you are authorized to perform show up on the Navigation pane. These tasks depend on the rights assigned to your administrator role.
You can create two types of administrator accounts to manage {product-name}:
-
Global Administrators have full privileges to manage servers, global settings, domains, and accounts as well as create other administrators. One global administrator account gets created automatically during software installation. Create additional global administrator accounts anytime later. You can perform administration tasks from the Administration Console or the command line.
-
Delegated Administrators are granted customized administrator roles by the global administrator to manage different tasks from the Administration Console. See Delegated Administration for more details.
-
To launch the Administration Console in a typical installation, use the following URL pattern.
https://server.domain.com:7071/Parameter Description server.domain.com
The Zimbra server name or IP address.
7071
The default HTTP listen port.
-
At the login screen, enter the complete administrator address - e.g., [email protected] - and the password configured for it during server installation of {product-name}.
You can change the password - from either the Administration Console or the CLI - at any time.
From the Administration Console, use the Change Password screen to set the new password string, and to define the policy for user password modifications.
- Admin Console:
-
Home → Manage → Accounts
Double click select user account or from the Gear icon, select Change Password from the popup menu.
zmprov sp [email protected] passwordA different login and logout page can be configured either as a global setting or as a domain setting.
To specify a URL to redirect administrators to if their login fails authentication, or if their authentication has expired:
Global:
zmprov mcf zimbraAdminConsoleLoginURL <https://example.com>Domain:
zmprov md <domain> zimbraAdminConsoleLoginURL <https://example.com>To specify a URL to redirect administrators to, for logging out:
Global:
zmprov mcf zimbraAdminConsoleLogoutURL <https://example.com>Domain:
zmprov md <domain> zimbraAdminConsoleLogoutURL <https://example.com>Most {product-abbrev} tasks - such as creating accounts and Classes of Service, Server Status Monitoring, Domain management, Backup Scheduling, and Session management - can be managed from the Administration Console.
Other configuration and maintenance tasks require the use of the Zimbra CLI because you cannot perform them in the Administration Console. For example: starting and stopping services and managing the local server configuration.
At the Administration Console, if you need to view the attribute associated with a particular function, you can click on the text labels of the currently visible configuration page to open the information in a popup. Guide text is also provided from these popups, as demonstrated in the following illustration.
Click the field label to view the Attribute popup. |
|
With the attribute popup in view, click More to view guidetext about the field. |
|
The organization of the {product-name} Administration Console provides quick navigation to the configuration and monitoring tools and views associated with your login privileges. It also provides easy access to various types of Help and the on-screen guide text.
After logging in to the Administration Console, the Home page provides status information and options you can select to navigate to the configuration and viewing options described in this user guide.
<1> Go to Previous or Next page <2> Current Location/Path <3> Search <4> Screen Refresh <5> Current User and Logout Option <6> Help <7> Gear Icon <8> Status Pane <9> Viewing Pane <10> Navigation Pane
The displays and options in the navigation pane and viewing pane change according to your selections. Other portions of the UI — arrow buttons, search field, screen refresh, current location/path, current login, and Help — always remain in view.
The Gear Icon 
is displayed with some screens, to enable quick access to functions associated with the functions provided in the screens.
For more information about the Gear icon, see Using the Gear icon
The options provided in the Home navigation pane get categorized under the Home directory. Some of the options lead to configuration pages; others lead to pages containing reports, as associated with your selections.
The illustration at right is an expanded view of the options currently supported in the Navigation Pane.
The upper bar of the in-view page always displays your current position in the hierarchy, and you can use multiple options for dismissing the current view:
-
To return to a previous page or go to the next page, click the left or right arrows.
-
To return to a specific portion of the UI, select an option from the Home dropdown.
-
To go directly to a specific option, click through the hierarchy in the Navigation Pane.
The Navigation pane options are described in the following topics:
The Home screen is the default, login view, which provides the Home navigation pane and the Home page. This page provides a snapshot view of system status and a series of quick-access links for essential tasks.
<1> Go to Previous or Next page <2> Search <3> Screen Refresh <4> Current User and Logout Option <5> Help <6> System Status <7> Status Pane <8> Quick Start <9> Navigation Pane
| Topic | Description |
|---|---|
Summary |
Displays the version of {product-name} currently running and in view, and the detected number of servers, account, domains, and classes of service associated with this session. |
Maintenance |
Displays the most recent software backup performed. |
Runtime |
Displays the runtime statistics for Service, Active Session, and Queue Length. |
1 Get Started |
Displays the steps essential to getting started with your {product-name} operations, and provides quick links to the functions in this UI:
|
2 Set up Domain |
Displays the steps you use to establish the domain(s) to be managed by the Collaborator. Each step is a link to the function in this UI:
|
3 Add Accounts |
Displays the steps for adding accounts for management by the Collaborator. Each step is a link to the function in this UI:
|
The Monitor screen provides the Monitor navigation pane and the Monitor pages, which display various itemizations about servers monitored by the Collaborator.
<1> Go to Previous or Next page <2> Search <3> Screen Refresh <4> Current User and Logout Option <5> Help <6> Status Pane <7> Navigation Pane
The options provided in the Monitor pages provide various methods- dynamic charts, or tables-for viewing the individual or system-wide monitored servers and services listed in the following table.
|
Note
|
Adobe Flash Player must be activated to enable views of the dynamic charts. |
| Option | Description |
|---|---|
Server Status |
Server, Service, and Time details for each server monitored by the Collaborator. |
Advanced Statistics |
System-wide Information page for Advanced Statistics, which allows you to set up a new monitoring chart using parameters from the selection fields available from this page: Server, Group, Start, end, and Counters. From this Advanced Statistics page, you can also elect to perform the following operations:
|
Message Count |
System-wide Information page, for Message Counts, to examine charts depicting counts over the last 48, 30, 60, and 365 days. The information summarizes the number of recipients of messages using either SMTP or LMTP. The polling intervals for the counts are posted directly beneath each chart. |
Message Volume |
System-wide Information page, for Message Volume, to view charts depicting the number of recipients of messages using either SMTP or LMTP, and associated message sizes. These counts get summarized in periods over the last 48, 30, 60, and 365 days. The polling intervals for the counts are posted directly beneath each chart. |
Anti-Spam/Anti-Virus |
System-wide Information page, for Anti-Spam/Anti-Virus |
Activity |
Activity, depicting the number of unique messages processed by the AS/AC system over the last 48, 30, 60, and 365 days. The polling intervals for the counts are posted directly beneath each chart. |
Server Statistics |
Access to statistics for a selected Service Host. You can view information for a selected host, as follows:
For the selected Server, the Server Statistics navigation pane provides options to view Disk, Session, Mailbox Quota, Message Count, Message Volume, and Anti- Spam/Anti-Virus Activity. |
Mail Queues |
Tab pages from which to view counts of Deferred, Incoming, Active, Held, and Corrupt statistics for detected mail queues. Each tab page provides summary filtering information and Message details. |
The Manage screen provides the Manage navigation pane, and the Manage pages, which display the tables categorically provided as Accounts, Aliases, Distribution Lists, and Resources that are currently managed by Collaborator.
<1> Go to Previous or Next page <2> Search <3> Screen Refresh <4> Current User and Logout Option <5> Help <6> Gear Icon <7> Status Pane <8> Navigation Pane
| Option | Description |
|---|---|
Accounts (count) |
Table of accounts managed by the Collaborator. Actions you can perform:
|
Aliases (count) |
Table of Aliases managed by the Collaborator. Each alias is an email address that forwards all email to a specified account. Actions you can perform:
|
Distribution Lists (count) |
Table of Distribution Lists managed by the Collaborator. A Distribution List is a group of mail addresses contained in a list, with a mail address for the list. When you send a message to a distribution list, you are sending it implicitly to everyone whose address appears in the list. The To: address line displays the distribution list address. Actions you can perform:
|
Resources (count) |
Table of Resources managed by the Collaborator. A Resource is a location or a piece of equipment that supports scheduling for meetings. Actions you can perform:
|
The Configure screen provides the Configure navigation pane, and the Configure pages, which enable configurations for individual or global components.
<1> Go to Previous or Next page <2> Search <3> Screen Refresh <4> Help <5> Gear Icon <6> Status Pane <7> Configure Navigation Pane
| Option | Description |
|---|---|
Class of Service |
Displays the COSs managed from this AdministrationConsole.
|
Domains |
Displays the domains managed from this Administration Console.
|
Servers |
Displays the servers managed from this Administration Console.
|
Global Settings |
Provides access to tools you use to set various global parameters for your {product-name}. Gear Icon: Save, Download, Update License, Activate License, Manually Activate License |
Zimlets |
Displays the Zimlets managed from this Administration Console.
|
Admin Extensions |
Displays the Admin Extensions managed from this Administration Console.
|
Certificates |
Displays the Certificates managed from this Administration Console.
|
Rights |
Displays the various Rights applicable to this Administration Console.
|
Global ACL |
Displays the Global Access Control Lists managed from this Administration Console.
|
Global Settings define the default global values for servers, accounts, COS, and domains. These default values and parameters apply when no specific values and parameters for particular items are in their settings.
You configure the defaults for Global Settings during installation. You can change the settings at any time from Global Settings at the Administration Console.
| Option | Description |
|---|---|
General Information |
For more information, see General Information Configuration |
Attachments |
For more information, see Attachments Configuration. |
MTA |
For more information, see MTA Configuration. |
IMAP |
Enable IMAP service. Changes to these settings do not take effect until the server restarts. |
POP |
Enable POPS3 Service. Changes to these settings do not take effect until the server restarts. |
AS/AV |
Set anti-spam and anti-virus rules. Changes to the Spam-check settings do not take effect until the server restarts. |
Themes |
Changes to the theme settings require flushing of the server theme cache by using btn:[Flush Cache] on the toolbar in Server settings. For more information, see Color and Logo Management. |
Advanced |
|
Retention Policy |
Set up a retention and deletion time threshold for items in user folders. You can configure retention and deletion policies as a global setting, or configure COS-level policies instead of inheriting from the global settings. |
Proxy |
Set parameters for Web Proxy and Mail Proxy. There are also tools provided for setting Advanced Proxy parameters. |
S/MIME |
(Secure Multipurpose Internet Mail Extensions): Configure the LDAP settings on the S/MIME tab (if S/MIME feature is enabled). Users retrieve private keys from LDAP servers. |
ACL |
(Access Control List): Go to ACE (Access Control Entry) configuration for delegated administration rights granted on selected target(s), to add, edit, or delete an ACE. |
Backup/Restore |
Set parameters for backup-for standard or auto- grouped mode. For more information see Backup and Restore. |
HSM |
(hierarchical storage management): Configure the aging of messages before they move to the secondary volume. |
License |
|
The Tools and Migration screen provides the Tools and Migration navigation pane, for access to system software management and system backup/restore. Administrators can access and download specific wizards and tools from this page.
<1> Go to Previous or Next page <2> Search <3> Screen Refresh <4> Current User and Logout Option <5> Help <6> Status Pane <7> _Tools and Migration_ Navigation Pane
| Option | Description |
|---|---|
Downloads |
Access Zimbra utilities, which provides downloadable |
Software Updates |
Find out if your system needs a Zimbra Server update or not, and use this page to view polling and email contact information pertinent to software updates for your system. |
Account Migration |
View tabular details about account migrations, as detected by your system. This page lists total imports and the status of each. This page also provides the name(s) of the owners for each account migration listed. See also Migrating Accounts from a Zimbra Server. |
Client Upload |
Use this page to browse for the latest version of software to be uploaded to your system. After selecting the image, you can use btn:[Upload] on this page to complete the software upload. |
Backups |
Access a summary view of current free and total space (MB) based on the most recent system backup. You can also choose an administrator from this navigation pane to view their backup history. The history lists labels, start and end times, and success or failure for each backup occurrence. Each of these listings is associated with an identical displayed directory path to the backup target. The section Backup and Restore provides additional information. |
Use the Tools and Migration screen Downloads option to get the tools described in this section. Check Zimbra PST Migration to migrate Outlook PSTs to {product-name}.
{product-abbrev} Migration Wizard for Exchange/PST (32 bit) |
Get
|
||
{product-abbrev} Migration Wizard for Domino |
|
||
Legacy {product-abbrev} Migration Wizard for Exchange |
|
||
Zimbra Connector for Outlook MSI Customizer |
Present text file containing functions you can use to customize the standard ZCO MSI. The server name, port, and other variables particular to an organization can be customized. |
||
Zimbra Connector for Outlook Branding MSI |
Get the Windows Visual Basic Script Edition (VBScript Script File) to customize the standard ZCO MSI. Customization replaces all instances of the Zimbra product name and logo. |
Zimbra Connector for Outlook (32 bits) |
This application enables the user’s Outlook to synchronize calendar, contacts, and mail with the {product-abbrev} server. The Zimbra Connector for Microsoft Outlook (ZCO) allows users of Microsoft Outlook to connect to the {product-abbrev} server to access {product-abbrev} business features. Address books, Contacts, Calendars, Tasks, and mail are synced directly with the {product-abbrev} server. |
||
(Legacy) Microsoft Outlook PST Import Tool |
|
||
(Legacy) Migration Wizard for Microsoft Exchange |
|
||
General Migration Wizard |
This tool imports data within Microsoft Exchange servers and Outlook PST files to the Zimbra Server.
|
The Search screen displays the Search results from queries made in the Search field in the Administration Console header.
-
When you open this page without entering a search query, All Results is the default search, which displays accounts, domains, and distribution lists in the Content pane.
-
The auto-completion function allows you to enter a partial name, then select a searchable name from the displayed list of matched strings.
-
You can also use the Zimbra mailbox ID number to search for an account. However, to return a search from a mailbox ID, the complete ID string must be entered in the search.
<1> Go to Previous or Next page <2> Search Options <3> Search <4> Screen Refresh <5> Current User and Logout Option <6> Help <7> Gear Icon <8> Status Pane <9> Search Navigation Pane
| Option | Description |
|---|---|
All Result |
View the count and table of all search results. |
Accounts |
View the count and table resulting from a query for Accounts. |
Domains |
View the count and table resulting from a query for Domains. |
Distribution Lists |
View the count and table resulting from a query for Distribution Lists. |
Basic Attributes |
Search for a user by first name, last name, display name, or account ID number. You can search for administrators or delegated administrators only. |
Status |
Search for an account by status: Active, Closed, Locked, Logout, Pending, or Maintenance. |
Last Login Time |
Search for accounts by the last login time. You can specify a date range to search. |
External Email Address |
Search for an account with an external email address. |
COS |
Search for objects by COS or for objects that are not assigned a COS. |
Server |
Search for accounts on selected servers. |
Domains |
Search for accounts on selected domains. |
Saved Searches |
By default, this section includes predefined common search queries. You can also create and save your queries. After you enter the query syntax, click Save Search and provide a name for the search. The search is then added to this Saved Searches section. |
-
At the Search field, use search options from the drop-down selector to define the type of search, as either accounts, distribution lists, aliases, resources, domains, class of service, or all objects.
For accounts, you can search by display name, first/last name, the first part of an email address, alias, delivery address, or mailbox ID.
-
Type the search string into the Search field.
Partial entries are allowed as search criteria, but a search based on mailbox ID must include the complete ID string.
-
Click Search.
The Search page appears, containing results of the search based on your criteria.
-
View the total number of results at the Navigation pane, in Search> All Results.
The Help Center is a reference of resources available from the online help and documentation, which you can access with the links provided in the Help Center screen. Use this page, also, to access community forums and to view expert responses to the top migration questions.
<1> Go to Previous or Next page <2> Search <3> Screen Refresh <4> Current User and Logout Option <5> Help <6> Status Pane <7> Help Center Navigation Pane
The selection of a category from the Navigation pane typically results in a tabular display of all managed objects for the selected category. All tables display labeled columns in which to view information such as email addresses, display names, status, last logins, and descriptions (if configured).
Each row in a table enables actions you can perform if you require additional information or access to the configuration for the selected table entry.
| Action at Table Row | Result | |
|---|---|---|
Hold cursor |
Display ID details for the selection, similar to the example at right (invoked from an Accounts row). |
|
Right-click |
Access the popup menu for a selected table row. The popup menus from a typical table may differ from row to row, as demonstrated in the following examples. |
Accounts and Aliases: Dist Lists and Resources: 
|
Global administrators can create the message- or messages-of-the-day (MOTD) that administrators view when logging into the Administration Console.
The MOTD displays during administrative login at the top-left of the Administration Console, similar to the example below.
The message can be closed, replaced, or removed.
To remove a message from view, click btn:[Close] located alongside the message content.
Use the zimbraAdminConsoleLoginMessage attribute, with guidelines in this section, to create a single message of the day, or to create multiple messages to be displayed.
|
Note
|
When creating a message with your command entry, always place double-quote marks at the beginning and end of the message to be displayed. |
Creating a global message or domain-specific message.
zmprov md <domain> zimbraAdminConsoleLoginMessage "message to display"Creating a multiple-message display:
zmprov md <domain> +zimbraAdminConsoleLoginMessage "second message to display"Use the zimbraAdminConsoleLoginMessage attribute, with guidelines in this section, to delete a single message of the day, or to delete multiple messages.
|
Note
|
When removing a message with your command entry, use the following guidelines for individual and multiple deletions: |
-
Place a minus sign (-) before the attribute, and double quote marks at the beginning and end of an individual message-id for deletion.
-
Use single quote marks with the attribute to remove all messages.
Removing a specific message:
zmprov md <domain> -zimbraAdminConsoleLoginMessage "message to display"Removing all messages:
zmprov md <domain> zimbraAdminConsoleLoginMessage ''This section provides birds-eye views of the functions you can use when navigating the Administration Console, in the following topics:
The following illustration provides a high-level view of the Administration Console UI.
You can select options to perform on a selected entity from the navigation pane from the Gear icon or a topical popup menu.
The Gear icon is always located at the upper-right edge of the page view if pertinent to selectable items in the displayed page.
To view the available options, highlight a topic at the navigation pane or in the page view: In the popup, the options that do not apply to your selection are disabled — the remaining enabled options are valid with your selection. The following example demonstrates Gear options based on the selection of a navigation bar topic, versus a table row entry from within the same page view.
The following table provides a high-level view of the operations derived from the Gear icon, which varies for particular functions.
| Navigation Pane Topic | Selections | Options |
|---|---|---|
Home Monitor |
Server Statistics |
View |
Mail Queues |
Flush |
|
Manage |
Accounts |
New, New Administrator, Edit, Delete, Change Password, Invalidate Sessions, View Mail, Move Mailbox, View Rights, Configure Grants |
Aliases |
New, New Administrator, Edit, Delete, Move Alias, Invalidate Sessions, View Mail, Move Mailbox, View Rights, Configure Grants |
|
Distribution Lists |
New, New Administrator, Edit, Delete, View Mail, View Rights, Configure Grants |
|
Resources |
New, New Administrator, Edit, Delete, View Mail, View Rights, Configure Rights |
|
Configure |
Class of Service |
New, Delete, Edit, Duplicate |
Domains |
New, Delete, Edit, Configure GAL, Configure Authentication, View Accounts, Add a Domain Alias, Configure Grants |
|
Servers |
Edit, Flush Cache, Enable Proxy, Disable Proxy |
|
Global Settings |
Save, Download, Update License, Activate License, Manually Activate License |
|
Zimlets |
Deploy, Undeploy, Toggle Status |
|
Admin Extensions |
Deploy, Undeploy |
|
Certificates |
Install Certificate, View Certificate |
|
Voice/Chat Service |
New, Delete, Edit, Generate Session ID |
|
Rights |
View |
|
Global ACL |
Add, Delete, Edit |
|
Tools and Migration |
Account Migration |
Delete Task, Refresh, Migration Wizard |
Software Updates |
Save, Check Now |
|
Backups |
View, Backup, Restore, Configure, Refresh |
|
Search |
All Result |
Delete, Edit, Change Password, View Mail, Move Alias, Invalidate Sessions, Move Mailbox, Download |
Accounts |
||
Aliases |
||
Domains |
||
Distribution Lists |
The Administration Console logically groups a wide range of Configuration options into containers. Applicable configuration options inside these containers are listed in the High-level View of Administration Console UI
By default, all containers on a page are opened (expanded). You can opt to close (collapse) containers - which can free up additional space in a page view - by clicking on btn:[collapse/expand] located at the upper-left edge of the container.
