5000 v5 AdminGuide
5000 v5 AdminGuide
Guide
Part Number
550.8125
For additional information and/or technical assistance in North America, certified technicians may contact:
Mitel Networks Corporation
Technical Support Department (USA)
7300 West Boston Street
Chandler, AZ 85226-3224
1-888-777-EASY (3279)
For information on how to contact Mitel Technical Support outside of North America, please refer to your
Channel Support Agreement.
If you have any questions or comments regarding this manual or other technical documentation, contact the
Technical Publications Department (USA) at:
[email protected]
All other trademarks mentioned in this document are the property of their respective owners, including Mitel Networks
Corporation. All rights reserved.
Limited Warranty
Mitel warrants that its products will, if delivered to the end-user in undamaged condition, be free
from defects in material and workmanship under normal use and service for the period set forth
on the current warranty periods as published in the U.S. Price List from time to time and
substantially in conformance with the documentation (functional and operating specifications)
that Mitel publishes regarding same (end-user reference and operating manuals and guides
relating to the program). Mitel does not, however, warrant that the functions contained in the
software program will satisfy Dealer's particular purpose and/or requirements or that the
operation of the program will be uninterrupted or error free.
Mitel shall incur no liability under this warranty and this warranty is voidable by Mitel (a) if the
product is used other than under normal use, with certified repair and maintenance service and
under proper environmental conditions, (b) if the product is subject to abuse, misuse, neglect,
flooding, lightning, power surges, third-party error or omission, acts of God, damage, or
accident, (c) if the product is modified or altered (unless expressly authorized in writing by
Mitel), (d) if the product is installed or used in combination or in assembly with products not
supplied or authorized by Mitel and/or which are not compatible with or are of inferior quality,
design, or performance to Mitel or Mitel supplied products so as to cause a diminution or
degradation in functionality, (e) if there is a failure to follow specific restrictions in operating
instructions or (f) if payment for product has not been timely made.
The sole obligation of Mitel and the exclusive remedy and recourse of Dealer under this
warranty, or any other legal obligation, with respect to product, including hardware, firmware,
and software media, is for Mitel, at its election, to either repair and/or replace the allegedly
defective or missing product(s) or component(s) and return (prepaid) same (if necessary), or
grant a reimbursement credit with respect to the product or component in the amount of the
sales price to the Dealer. With regard to a software program design defect, however, to the
extent it prevents the program from providing functionality and/or operating as intended by Mitel,
is service affecting, and prevents beneficial use of the product, Mitel does undertake to use its
best efforts to devise a suitable corrective solution to the problem within a reasonable period of
time; should said action, however, not substantially resolve the problem, then Mitel reserves the
right to substitute a new release (“stream”) of software as soon as it is generally made available
by Mitel. The above, with regard to a software design defect, likewise, constitutes the sole
obligation of Mitel and exclusive remedy of Dealer hereunder.
The responsibility of Mitel to honor the express limited warranty stated above also shall be
predicated on receiving timely written notice of the alleged defect(s) with as much specificity as
is known within thirty (30) calendar days of the malfunction or by the expiration of the warranty
period (plus thirty [30] calendar days), whichever occurs first. Mitel shall further have the right to
inspect and test the product to determine, in its reasonable discretion, if the alleged malfunction
is actually due to defects in material or workmanship. Unless waived by Mitel, Dealer agrees to
return (prepaid) the allegedly defective product or component to Mitel for inspection and/or
testing, and, if appropriate, for repair and/or replacement.
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page vii
Network Security Statement
NOTICE
The above express Limited Warranty is in lieu of all other warranties, express or implied,
from Mitel Networks Corporation, or Inter-Tel, Inc., and there are no other warranties which
extend beyond the face of this warranty. All other warranties whatsoever, including the
implied warranty of merchantability and the implied warranty of fitness for a particular pur-
pose relating to use or performance of the product, including its parts, are hereby excluded
and disclaimed.
In no event shall Mitel Networks Corporation, under any circumstances, be liable for nor
shall a purchaser (directly or indirectly) be entitled to any special, consequential, incidental,
indirect, punitive, or exemplary damages as a result of the sale or lease of product including
but not limited to failure to timely deliver the product or failure of product to achieve certain
functionality, or arising out of the use or inability to use the product, in whole or in part and
including but not limited to loss of profit, loss of use, damage to business or damage to
business relations even if notified of the possibility of such damages. Mitel shall not be lia-
ble for personal injury or property damage unless caused solely by Mitel’s negligence.
Page viii Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Contents
Contents
Overview 1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
User Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Connection Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Network Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Title Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Information Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Navigation Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Content Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
System Connection Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
System Monitoring Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Menu Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Tooltips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Warning Message Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Installing the Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Launching the Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Importing Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Adding Connections Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Exiting without Adding or Importing Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Enabling an On-Demand Remote Connection from a phone . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Upgrading from Older Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Programming the Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Index 33
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page ix
Chapter 1: Overview
Overview
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
User Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Connection Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
System Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
DB Programming Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Network Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 1
Chapter 1: Overview
Introduction
Introduction
System Administration & Diagnostics is a new personal computer (PC)-based application that
provides a single interface to access all of the administration and system monitoring tools
available on the Mitel 5000 Communications Platform (CP). Using this application, you can
easily configure and upgrade the system, monitor active calls, view resource usage,
troubleshoot issues, and so forth.
Mitel 5000 CP Database (DB) Programming is installed as part of the System Administration &
Diagnostics application along with other supporting system management tools and utilities. After
installing the System Administration & Diagnostics application, you can launch any of the
following:
DB Programming
Administrative Web Session (AWS)
Secure Shell (SSH) Connection (PuTTY)
Database Converter
MOH (Music-on-Hold) Converter
Test and Repair
Upload Utility
After establishing a connection to a 5000 CP node, System Administration & Diagnostics
queries call, resource/device, system, and system status data from the node. It then uses a
variety of content controls to display this information in a well-organized manner that allows you
to easily read and understand the data. The application automatically receives updates
periodically, but also allows you to refresh data on demand.
The system monitoring portion of System Administration & Diagnostics can be very
useful for occasional monitoring of system usage and troubleshooting. As with any
tool that monitors system activity, this monitoring may have a slight impact on
system performance. The impact is directly related to the size of the system (number
NOTE of devices), as well as the number of concurrent active System Administration &
Diagnostics sessions connected to the system. If there is a noticeable difference in
system performance after upgrading to v4.0 or later and/or when multiple System
Administration & Diagnostics sessions are connected to a system, contact Technical
Support.
Throughout the following chapters of this manual, change (revision) bars like the one next to
this paragraph have been placed in the margins to indicate significant changes or additions
since the previous publication of this manual (Issue 1.0, June 2010).
Page 2 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 1: Overview
About this Guide
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 3
Chapter 1: Overview
User Types
User Types
The System Administration & Diagnostics application supports two user types. The System
Administration & Diagnostics UI is customized for each user type so only the most appropriate
data is presented:
System Administrator (default): Intended to be used by end users and field technicians.
Mitel Support: Intended to be used by technical support personnel. Supports all of the
features and options for the System Administrator user type and provides additional
system monitoring information in the following areas:
o System Monitoring option
o Current Calls information
o IPDRM Resource Usage information
o Application information
o System Command information
Reporting User: Intended to be used by “business-level” users who are not system
administrators. When the Reporting User type is selected, the main UI is simplified to
show just the Reporting tab. In addition, the System management tools button and the
System Monitoring section are hidden.
The user type does not correlate to the log-in account types in DB Programming.
The log-in account is determined based on the System Account settings in DB
NOTE
Programming. The user type is determined based on the settings in System
Administration & Diagnostics.
Connection Types
When the System Administration & Diagnostics application is connected to a 5000 CP, that
connection is defined as a system connection (or sometimes referred to as a node).
System Connections
Each system connection can have one onsite connection and one offsite connection and
supports the following connection types:
Onsite: Connects to the 5000 CP using an IP connection.
Offsite: Connects to the 5000 CP using various methods:
o Modem: Connects to the 5000 CP using an onboard modem.
o Network: Connects to the 5000 CP using an external (NATed) IP connection.
o Remote Configuration: (Reserved for controlled introduction.) If authorized, you can
use the Remote Configuration feature to access the 5000 CP using a Virtual Private
Network (VPN) connection. Refer to the Mitel 5000 Features and Programming Guide,
part number 580.8006 for details.
Multiple on-site connections are allowed for running system monitoring. Multiple off-site
connections, however, are not allowed due to the contention of the Modem/Remote
Configuration connection.
Page 4 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 1: Overview
DB Programming Connections
DB Programming Connections
You can use a single instance of the System Administration & Diagnostics application to launch
or open multiple DB Programming sessions that can run simultaneously, similar to the capability
provided by the Session Manager in pre-v4.0 systems. When a system connection is
established, you can launch or open the following DB Programming sessions:
Online session: A session that is connected to the 5000 CP (a.k.a. “remote” session in
pre-v4.0 systems).
Offline session: A stand-alone session that is not connected to the 5000 CP (a.k.a.
“local” session in pre-v4.0 systems).
Compatibility
Although System Administration & Diagnostics is introduced as part of the 5000 CP v4.0 or later
release, this application can manage the system connections for all previous versions of the
5000 CP. When connected to a pre-v4.0 system, advanced system monitoring capabilities of
System Administration & Diagnostics are not available, however, the system connection
management, DB Programming connectivity, and utilities/tools are still available.
When system monitoring capabilities are not supported (on pre-v4.0 systems), the content
controls appear dimmed and are overlaid with the text “Unavailable.” To use as much
functionality as possible, refer to the Launching a pre-v4.0 DB Programming help topic in the
Mitel System Administration & Diagnostics Help. See page 30 for details about upgrading from
older software.
Connections to Axxess systems are not supported and are not impacted by the installation of
this application.
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 5
Chapter 1: Overview
Specifications
Specifications
The following section describes the hardware, software, and network requirements for the
System Administration & Diagnostics application.
Hardware Requirements
The following lists the hardware requirements for the System Administration & Diagnostics
application:
1.0 gigahertz (GHz) or higher Central Processing Unit (CPU)
1 gigabyte (GB) or higher Random-Access Memory (RAM)
1024x768 high-color 32-bit display
100 megabytes (MB) available hard disk space (not including the space needed for the
.NET Framework)
Software Requirements
The following lists the software requirements for the System Administration & Diagnostics
application:
Microsoft® Windows® XP (SP2/SP3), Window Vista® (SP1), or Windows 7
Microsoft .NET Framework version 4.0 (included in the installation program)
Network Requirements
The System Administration & Diagnostics application requires a Network (or Modem)
connection to connect to the 5000 CP. Each instance of the System Administration &
Diagnostics application can gather data for one node.
Licensing
The System Administration & Diagnostics application does not require a license.
Page 6 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 2: Understanding the Interface
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 7
Chapter 2: Understanding the Interface
Introduction
Introduction
The System Administration & Diagnostics UI contains the following sections: Title bar,
Information bar, navigation area, content controls, System Connection and System Monitoring
sections, menu buttons, and expand/collapse button. Each section is described in the following
pages.
The System Administration & Diagnostics UI operates in expanded and collapsed modes. The
System Monitoring section contains a button to toggle between expanded and collapsed mode
(see below):
Expanded Mode: This is the default mode and displays the full system monitoring capabilities.
Figure 1. System Administration & Diagnostics UI in Expanded Mode
51 61 71
11
21
31
41
81
1 – Title Bar (see page 9) 5 – System Connection Section (see page 15)
2 – Information Bar (see page 9) 6 – System Monitoring Section (see page 17)
3 – Navigation Area (see page 10) 7 – Menu Buttons (see page 18)
4 – Content Controls (see page 12) 8 – Expand/Collapse Button (see page 18)
Collapsed Mode: Displays almost all of the system monitoring capabilities, except for the
navigation area and content controls. The collapsed mode is used in situations where the
system monitoring features are not necessary, are not authorized, or are not available. For
example, if you simply want to use DB Programming, you may choose to use the collapsed
mode. When you decide to use the system monitoring features, click the Expand/Collapse
button to switch to the expanded mode.
Figure 2. System Administration & Diagnostics UI in Collapsed Mode
Page 8 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 2: Understanding the Interface
Navigation
Navigation
The following pages summarize the functionality of each section in the System Administration &
Diagnostics window.
Title Bar
The Title bar displays the official application product name and icons that allow you to minimize,
maximize, and exit the application. The Windows taskbar item for the application shows the
name of the active connection followed by the application name (for example, “Node 1 - Mitel
System Administration & Diagnostics”).
Information Bar
Figure 3 shows an example of the Information bar.
Figure 3. Information Bar
Status System
Indicator Connection Header Buttons
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 9
Chapter 2: Understanding the Interface
Navigation Area
Navigation Area
The navigation area contains tabs which separate the system monitoring information into
different categories. The content of each tab is comprised of a collection of content controls.
Figure 4 shows an example of the navigation tabs.
Figure 4. Navigation Tabs
Each of the navigation tabs consist of multiple content controls. These content controls can be
expanded or collapsed. You can drag the content controls around on the tab to arrange and
reorder them. The content controls are arranged horizontally on the tab. If a control does not fit
on the current row, it wraps to the next row. See page 12 for an example of the content control.
Table 1 shows brief tab descriptions and available content controls for each tab. See
appropriate pages for details. For details about tabs and contents, refer to the Mitel System
Administration & Diagnostics Help.
Page 10 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 2: Understanding the Interface
Navigation Area
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 11
Chapter 2: Understanding the Interface
Content Controls
Content Controls
Each navigation tab is made up of a collection of content controls. The content controls provide
the diagnostic information in an easy to understand, self-contained format.
Figure 5 shows an example of the IP Resource Usage content control.
Figure 5. Content Control
Expanded Mode
Title
Header
Content
Collapsed Mode
Page 12 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 2: Understanding the Interface
Content Controls
Header: Some content controls display important high-level information that could not be
displayed in the Title area. The Header area appears even when the content control is
collapsed.
Content: Displays the main diagnostic information for the content control. This area is
hidden when the content control is collapsed.
Some content controls also provide the following features:
Gripper: Depending on the type of data in the content control, some content controls allow
you to customize the height or width of the control. These controls have a gripper in the
bottom-right corner as shown in Figure 6.
Figure 6. A Content Control with a Gripper
Gripper
Data Grid Filtering: You can filter columns in the data grids. Columns that can be filtered
are indicated with a filter ( ) icon.
To filter a column:
a. Click (Filter column) in a column.
This puts the column into filter mode and displays a text box as shown below.
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 13
Chapter 2: Understanding the Interface
Content Controls
b. Type characters you want to filter in the text box. As you type characters, possible
matches are filtered in the column.
To cancel filtering:
Click (Clear filter). The column is taken out of filter mode.
Page 14 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 2: Understanding the Interface
System Connection Section
The System Connection section has the following drop-down lists that contain buttons and
options for programing system connections:
System Connection
System Management Tools
System Connection
The System Connection drop-down list displays a list of the programmed system connections.
You can edit or delete connections individually, or manage and view the backups for a
connection. The box also includes menus for adding a new system and managing system
connections.
The buttons that are provided in the list are:
(Launch DB Programming): Launches DB Programming for the connection.
(Open in new window): Opens the System Administration & Diagnostics application in
new window.
System Connection Network Groups
With v5.0 or later, the System Connections drop-down list displays system connections by
network group. When a system connection is part of a network group, it is displayed within the
network group section. The network group list can be expanded or collapsed.
All ungrouped system connections are displayed below the grouped connections in a section
titled “Not Networked.” If none of the system connections are in network groups, the drop-down
list does not display any network groups. Figure 8 on page 16 shows an example of system
connection network groups.
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 15
Chapter 2: Understanding the Interface
System Management Tools
Network Groups
Ungrouped Network
Using the System Connections drop-down list, you can add/remove connections from a network
group. You can also bring up the Manage network groups window. For details, refer to the Mitel
System Administration & Diagnostics Help.
Page 16 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 2: Understanding the Interface
System Monitoring Section
Buttons
Table 3 shows buttons for managing diagnostic updates.
Alarm Counts
The alarm counts area contains high-level system information. This includes the number of
critical, major, and minor alarms.
This area also displays the overall system status. Statuses include Unknown, Good, Moderate,
and Fair. For the Moderate and Fair statuses, an information icon is displayed next to the status
with a tooltip that provides more information.
To view the filtered list of alarms:
Click one of the counts. This opens a new window that shows the filtered list of alarms.
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 17
Chapter 2: Understanding the Interface
Menu Buttons
Menu Buttons
Table 2 lists the available menu buttons (see in Figure 2 on page 8) and their brief
descriptions. For detailed information, see the appropriate pages.
Expand/Collapse Button
You can expand or collapse the lower content area using the expand/collapse button. The
expanded or collapsed state of the window as well as the window location and expanded size
are saved when you close the application and restored when you launch the application. See
Figure 2 on page 8 for an example of the collapsed System Administration & Diagnostics
window.
To collapse or expand the System Administration & Diagnostics window:
Click .
Page 18 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 2: Understanding the Interface
Tooltips
Tooltips
If applicable, a tooltip appears to further explain descriptions or status of the selected field or
menu. Fields where tooltips are available are described throughout the guide.
To view the information in a tooltip:
Move the pointer over the area where you want to view the tooltip information. If a tooltip
is available, a screen similar to the one below appears.
Figure 10. Tooltip
A warning message box may contain any of the following connection issues:
Test Onsite/Offsite Connections
Activate Connections
Delete Connections
Disconnect Connections
Save Connections
Close Application
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 19
Chapter 3: Installing and Launching the Application
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 21
Chapter 3: Installing and Launching the Application
Introduction
Introduction
This chapter provides information for installing and configuring the System Administration &
Diagnostics application.
Page 22 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 3: Installing and Launching the Application
Installing the Application
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 23
Chapter 3: Installing and Launching the Application
Launching the Application
NOTE You must have local administrative rights to launch the application.
Page 24 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 3: Installing and Launching the Application
Importing Connections
Importing Connections
This section explains how to import connections.
To import connections:
1. If you have connections saved in a file, exported either from System Administration &
Diagnostics or from previous use of Session Manager used for pre-v4.0 systems, select
Import connections. The Import File Selection dialog box appears.
2. Click Browse.
3. Select the source file, and then click OK.
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 25
Chapter 3: Installing and Launching the Application
Adding Connections Manually
2. In the Connection name field in the Connection tab, enter the name of the connection.
This name will be used:
in the list on the main window,
for DB Programming session name, and
in the task name for Scheduled Backups.
The name must be unique and can have up to 28 characters. The following characters
are not allowed: , . / ? : " | \ { } * < >. It is blank by default.
3. In the Onsite IP address/Hostname field, type the IP address/hostname of the 5000 CP
node that you are using when you are onsite (inside the LAN). It is blank by default.
4. Program the Offsite Connection section.
a. In the Offsite Connection field, select the method that you are using to connect
when you are offsite (outside the LAN). The options are I don’t connect offsite
(default), Modem, Network, and Remote Configuration.
b. If you are using the offsite connection, do one of the following:
o For a Modem connection: Type the number to dial to reach the 5000 CP
modem (up to 128 of any characters).
o For a Network connection: Type the IP address/hostname of a 5000 CP
node when the connection is offsite.
o For a Remote Configuration connection: This option appears only if the
Remote Configuration feature is installed on the computer. To enable an on-
demand remote connection, you must establish the connection in both
System Administration & Diagnostics and a system phone. For complete
information about Remote Configuration, refer to the Mitel 5000 CP Features
and Programming Guide, part number 580.8006.
Type the following information:
– Proxy server IP address/hostname: Type the IP address or hostname of
the Proxy Server. It must match the IP address or hostname programmed
in DB Programming for the node. Because the IP address can change,
Mitel recommends that you use the hostname. For example, if the server
is moved to a new location, the IP address may change, but it will still be
assigned to the original hostname.
– Proxy server IP port: Type the IP port used for connecting to the Proxy
Server. The valid range is 1-65535; the default value is 1194. This field
appears only when the Show IP ports option is enabled in the Advanced
tab in the Options menu.
– License key ID: Type the 5000 CP node license key ID, which identifies
the system (up to 14 digits or characters). To find the license ID key, dial
347 on any phone on the 5000 CP in which you are connecting. See
Enabling an On-Demand Remote Connection from a phone on page 29.
– PIN: Type the PIN to be used when connecting to the 5000 node (up to 4
digits).
– Proxy server username: Type the username for logging into the Proxy
Server (supplied by Customer Care personnel.).
– Proxy server password: Type the password for logging into the Proxy
Server (supplied by Customer Care personnel).
System Administration & Diagnostics then registers with the Remote Proxy
Server. This may take a few minutes. A progress message displays while the
connection is established.
If you receive an error message indicating that the connection to the Remote
Proxy Server failed because a socket error occurred, contact a Customer
Care representative for assistance.
Page 26 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 3: Installing and Launching the Application
Adding Connections Manually
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 27
Chapter 3: Installing and Launching the Application
Exiting without Adding or Importing Connections
8. Program the IP Ports section (this field appears only when the Show IP ports option is
enabled in the Advanced Settings menu).
In the IP Ports field, type the following information:
o Web listening port: The port number that is used every time a connection is
made by System Administration & Diagnostics to a system (the connection is
verified via a Web request). It is also used to access the Web page and for
system monitoring on a v4.0 or later system.The range is 1-65535; the default
value is 443.
o Listening port: The port number that is used by some types of system
monitoring and for DB Programming. The range is 1-65535; the default value
is 44000.
o SSH server port: The port number that is used for SSH connections. The
range is 1-65535; the default value is 22.
9. Click Test onsite connection and Test offsite connection to test the connections. The
Test button is available only when valid programming is entered for the connection.
Refer to the Test Onsite/Offsite Connection Warnings and Operations help topic in the
Mitel System Administration & Diagnostics Help for details about a connection test.
10. Click Save connection to save the changes. This option is available only when valid
programming is entered for the connection. Clicking this option takes you back to the
System Connections window. Click the red X to close, then click on drop-down list to
select the newly programmed connection.
11. If you click Save connection without typing a username and password, a dialog box
appears prompting you to type the username and password.
a. Type the username and password, and then select Remember username and
password if you want the application to remember the account information. If you do
not select the check box, entered credentials are saved for the duration of the
session, such that you will not be re-prompted for the information until exiting from
the session and starting it up again, or starting up a new instance of System
Administration and Diagnostics.
b. Click Connect. If there are any invalid entries, an error message appears.
12. If there is an active connection that exists, the Activate Connection dialog box appears
prompting whether you want to activate the new connection. Click Activate or Do not
activate. If both onsite and offsite connections are programmed, click Active onsite or
Active offsite to pick the connection, or click Do not activate.
To exit from the connection programming without adding a connection:
1. Select Cancel. The Cancel Edit dialog box appears prompting whether you want to
discard the changes.
2. Click Yes to discard changes or No to return to the window.
Page 28 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 3: Installing and Launching the Application
Enabling an On-Demand Remote Connection from a phone
Disabling Remote Configuration from a system phone prevents remote users from
NOTE
accessing the system in which the phone is registered.
To enable Remote Configuration from a system phone, the remote technician must provide you
with the personal identification number (PIN) that is registered with the Remote Proxy Server.
The remote technician must also enter the 5000 CP license key ID, or Hardware Against
Software Piracy (HASP) key. If necessary, you can use any system phone to view the HASP
key and provide it to the remote technician, as described below.
To enable a Remote Configuration session:
1. On any system phone, dial 342. ENTER PIN appears.
2. Enter the PIN number (supplied by the remote technician), and then press #. REMOTE
CONFIG ENABLED appears.
To end a Remote Configuration session:
Dial 343. REMOTE CONFIG DISABLED appears.
To display the license key ID (HASP key):
Dial 347. HW SERIAL NUM <number> appears.
To reset the Remote Configuration session:
Dial 344.
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 29
Chapter 3: Installing and Launching the Application
Upgrading from Older Software
Page 30 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Chapter 3: Installing and Launching the Application
Programming the Application
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 31
Index
Index
A H
About this Guide 3 Hardware Requirements 6
Adding Connections Manually 25 Header 13
Alarm Counts 17
Application I
installing 22
launching 24
Importing Connections 25
programming 31
Information Bar 9
Application, installing and launching 21
Installing the Application 22
B Interface, understanding 7
Introduction 2, 8, 22
Buttons 17
L
C
Licensing 6
Compatibility 5
Connectioms, adding 25
M
Connection Types 4
Menu Buttons 18
Connections
adding 25 Mitel Support 4
exiting 28
importing 25
N
Content 13
Content Controls 12
Navigating 9
Navigation 9
D Navigation Area 10
Network Requirements 6
Data Grid Filtering 13
DB Programming Connections 5
O
E Older Software, upgrading 30
On-Demand Remote Connections, enabling 29
Enabling an On-Demand Remote Connection from a phone 29
Overview 1
Exiting without Adding or Importing Connections 28
Expand/Collapse Button 18
P
G Programming the Application 31
Getting Started 21
R
Gripper 13
Reporting User 4
Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011 Page 33
Index
S U
Software Requirements 6 Upgrading 30
Specifications 6 User Types 4
System Administrator 4 Mitel support 4
reporting user 4
System Connection 15
system administrator 4
System Connection Header 9
System Connection Network Groups 15 W
System Connection Section 15
System Connections 4
Warning Message Boxes 19
System Management Tools 16
System Monitoring Section 17
T
Title 12
Title Bar 9
Tooltips 19
Page 34 Mitel® System Administration & Diagnostics Guide – Issue 5.0, February 2011
Part No. 550.8125
Issue 5.0, February 2011
A661/9236A
Global Headquarters U.S. EMEA CALA Asia Pacific
Tel: +1(613) 592-2122 Tel: +1(480) 961-9000 Tel: +44(0)1291-430000 Tel: +1(613) 592-2122 Tel: +61(0) 2 9023 9500
Fax: +1(613) 592-4784 Fax: +1(480) 961-1370 Fax: +44(0)1291-430400 Fax: +1(613) 592-7825 Fax: +61(0) 2 9023 9501
For more information on our worldwide office locations, visit our website at www.mitel.com/offices
www.mitel.com
THIS DOCUMENT IS PROVIDED TO YOU FOR INFORMATIONAL PURPOSES ONLY. The information furnished in this document, believed by Mitel to be accurate as of the date
of its publication, is subject to change without notice. Mitel assumes no responsibility for any errors or omissions in this document and shall have no obligation to you as a
result of having made this document available to you or based upon the information it contains.
M MITEL (design) is a registered trademark of Mitel Networks Corporation. All other products and services are the registered trademarks of their respective holders.