Accessing and Managing Utility Services
Accessing and Managing Utility Services
Utility Services
Release 6.3
03-603628
Issue 3
May 2013
© 2013 Avaya Inc. Avaya grants you a license within the scope of the license types
described below, with the exception of Heritage Nortel Software, for
All Rights Reserved. which the scope of the license is detailed below. Where the order
documentation does not expressly identify a license type, the
Notice applicable license will be a Designated System License. The applicable
number of licenses and units of capacity for which the license is granted
While reasonable efforts have been made to ensure that the will be one (1), unless a different number of licenses or units of capacity
information in this document is complete and accurate at the time of is specified in the documentation or other materials available to you.
printing, Avaya assumes no liability for any errors. Avaya reserves the “Designated Processor” means a single stand-alone computing device.
right to make changes and corrections to the information in this “Server” means a Designated Processor that hosts a software
document without the obligation to notify any person or organization of application to be accessed by multiple users.
such changes.
License types
Documentation disclaimer
“Documentation” means information published by Avaya in varying • Designated System(s) License (DS). End User may install and
mediums which may include product information, operating instructions use each copy of the Software only on a number of Designated
and performance specifications that Avaya generally makes available Processors up to the number indicated in the order. Avaya may
to users of its products. Documentation does not include marketing require the Designated Processor(s) to be identified in the order
materials. Avaya shall not be responsible for any modifications, by type, serial number, feature key, location or other specific
additions, or deletions to the original published version of designation, or to be provided by End User to Avaya through
documentation unless such modifications, additions, or deletions were electronic means established by Avaya specifically for this
performed by Avaya. End User agrees to indemnify and hold harmless purpose.
Avaya, Avaya's agents, servants and employees against all claims,
lawsuits, demands and judgments arising out of, or in connection with, • Concurrent User License (CU). End User may install and use
subsequent modifications, additions or deletions to this documentation, the Software on multiple Designated Processors or one or more
to the extent made by End User. Servers, so long as only the licensed number of Units are
accessing and using the Software at any given time. A “Unit”
Link disclaimer means the unit on which Avaya, at its sole discretion, bases the
pricing of its licenses and can be, without limitation, an agent,
Avaya is not responsible for the contents or reliability of any linked port or user, an e-mail or voice mail account in the name of a
websites referenced within this site or documentation provided by person or corporate function (e.g., webmaster or helpdesk), or
Avaya. Avaya is not responsible for the accuracy of any information, a directory entry in the administrative database utilized by the
statement or content provided on these sites and does not necessarily Software that permits one user to interface with the Software.
endorse the products, services, or information described or offered Units may be linked to a specific, identified Server.
within them. Avaya does not guarantee that these links will work all the
time and has no control over the availability of the linked pages. • Database License (DL). End User may install and use each copy
of the Software on one Server or on multiple Servers provided
Warranty that each of the Servers on which the Software is installed
communicates with no more than a single instance of the same
Avaya provides a limited warranty on its hardware and Software database.
(“Product(s)”). Refer to your sales agreement to establish the terms of
the limited warranty. In addition, Avaya’s standard warranty language, • CPU License (CP). End User may install and use each copy of
as well as information regarding support for this Product while under the Software on a number of Servers up to the number indicated
warranty is available to Avaya customers and other parties through the in the order provided that the performance capacity of the
Avaya Support website: http://support.avaya.com. Please note that if Server(s) does not exceed the performance capacity specified
you acquired the Product(s) from an authorized Avaya reseller outside for the Software. End User may not re-install or operate the
of the United States and Canada, the warranty is provided to you by Software on Server(s) with a larger performance capacity
said Avaya reseller and not by Avaya. “Software” means computer without Avaya’s prior consent and payment of an upgrade fee.
programs in object code, provided by Avaya or an Avaya Channel
• Named User License (NU). You may: (i) install and use the
Partner, whether as stand-alone products or pre-installed on hardware
Software on a single Designated Processor or Server per
products, and any upgrades, updates, bug fixes, or modified versions.
authorized Named User (defined below); or (ii) install and use
Licenses the Software on a Server so long as only authorized Named
Users access and use the Software. “Named User”, means a
THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYA user or device that has been expressly authorized by Avaya to
WEBSITE, HTTP://SUPPORT.AVAYA.COM/LICENSEINFO ARE access and use the Software. At Avaya’s sole discretion, a
APPLICABLE TO ANYONE WHO DOWNLOADS, USES AND/OR “Named User” may be, without limitation, designated by name,
INSTALLS AVAYA SOFTWARE, PURCHASED FROM AVAYA INC., corporate function (e.g., webmaster or helpdesk), an e-mail or
ANY AVAYA AFFILIATE, OR AN AUTHORIZED AVAYA RESELLER voice mail account in the name of a person or corporate function,
(AS APPLICABLE) UNDER A COMMERCIAL AGREEMENT WITH or a directory entry in the administrative database utilized by the
AVAYA OR AN AUTHORIZED AVAYA RESELLER. UNLESS Software that permits one user to interface with the Software.
OTHERWISE AGREED TO BY AVAYA IN WRITING, AVAYA DOES
NOT EXTEND THIS LICENSE IF THE SOFTWARE WAS OBTAINED • Shrinkwrap License (SR). You may install and use the Software
FROM ANYONE OTHER THAN AVAYA, AN AVAYA AFFILIATE OR in accordance with the terms and conditions of the applicable
AN AVAYA AUTHORIZED RESELLER; AVAYA RESERVES THE license agreements, such as “shrinkwrap” or “clickthrough”
RIGHT TO TAKE LEGAL ACTION AGAINST YOU AND ANYONE license accompanying or applicable to the Software
ELSE USING OR SELLING THE SOFTWARE WITHOUT A LICENSE. (“Shrinkwrap License”).
BY INSTALLING, DOWNLOADING OR USING THE SOFTWARE, OR Heritage Nortel Software
AUTHORIZING OTHERS TO DO SO, YOU, ON BEHALF OF
YOURSELF AND THE ENTITY FOR WHOM YOU ARE INSTALLING, “Heritage Nortel Software” means the software that was acquired by
DOWNLOADING OR USING THE SOFTWARE (HEREINAFTER Avaya as part of its purchase of the Nortel Enterprise Solutions
REFERRED TO INTERCHANGEABLY AS “YOU” AND “END USER”), Business in December 2009. The Heritage Nortel Software currently
AGREE TO THESE TERMS AND CONDITIONS AND CREATE A available for license from Avaya is the software contained within the list
BINDING CONTRACT BETWEEN YOU AND AVAYA INC. OR THE of Heritage Nortel Products located at http://support.avaya.com/
APPLICABLE AVAYA AFFILIATE (“AVAYA”). LicenseInfo under the link “Heritage Nortel Products”. For Heritage
Nortel Software, Avaya grants Customer a license to use Heritage
Except where expressly stated otherwise, no use should be made of Contact Avaya Support
materials on this site, the Documentation, Software, or hardware
provided by Avaya. All content on this site, the documentation and the See the Avaya Support website: http://support.avaya.com for product
Product provided by Avaya including the selection, arrangement and notices and articles, or to report a problem with your Avaya product.
design of the content is owned either by Avaya or its licensors and is For a list of support telephone numbers and contact addresses, go to
protected by copyright and other intellectual property laws including the the Avaya Support website: http://support.avaya.com, scroll to the
sui generis rights relating to the protection of databases. You may not bottom of the page, and select Contact Avaya Support.
modify, copy, reproduce, republish, upload, post, transmit or distribute
in any way any content, in whole or in part, including any code and
software unless expressly authorized by Avaya. Unauthorized
reproduction, transmission, dissemination, storage, and or use without
the express written consent of Avaya can be a criminal, as well as a
civil offense under the applicable law.
Virtualization
Each virtual appliance has its own ordering code. Note that each
instance of a virtual appliance must be ordered separately. If the end-
user customer or Business Partner wants to install two of the same type
of virtual appliances, then two virtual appliances of that type must be
ordered.
Trademarks
The trademarks, logos and service marks (“Marks”) displayed in this
site, the documentation(s) and product(s) provided by Avaya are the
registered or unregistered Marks of Avaya, its affiliates, or other third
parties. Users are not permitted to use such Marks without prior written
consent from Avaya or such third party which may own the Mark.
Nothing contained in this site, the documentation and product(s) should
be construed as granting, by implication, estoppel, or otherwise, any
license or right in and to the Marks without the express written
permission of Avaya or the applicable third party.
Chapter 1: Introduction...................................................................................................... 7
Purpose..................................................................................................................................................... 7
Intended audience.................................................................................................................................... 7
Document changes since last issue.......................................................................................................... 8
Related Resources.................................................................................................................................... 8
Documentation................................................................................................................................. 8
Avaya Mentor videos........................................................................................................................ 9
Support...................................................................................................................................................... 9
Warranty.................................................................................................................................................... 9
Chapter 2: Utility Services overview................................................................................. 11
Accessing Utility Services applications..................................................................................................... 12
Chapter 3: Utility Admin..................................................................................................... 15
Common.................................................................................................................................................... 15
Viewing the legal notice.................................................................................................................... 15
Software Version.............................................................................................................................. 15
Miscellaneous........................................................................................................................................... 16
Ping Host.......................................................................................................................................... 16
IPv6 Ping Host.................................................................................................................................. 16
Upload files....................................................................................................................................... 17
Utility Services Backup and Restore................................................................................................ 17
Customer Banner Control................................................................................................................. 18
Firewall Rules............................................................................................................................................ 19
Firewall IPv4..................................................................................................................................... 19
Firewall IPv6..................................................................................................................................... 19
Viewing firewall rules........................................................................................................................ 19
IP Phone Tools.......................................................................................................................................... 20
ADVD Settings Editor....................................................................................................................... 20
IP Phone Settings Editor.................................................................................................................. 24
IP phone backup and restore........................................................................................................... 29
IP Phone Custom File Upload.......................................................................................................... 30
IP phone firmware manager...................................................................................................................... 31
Configure CM Login......................................................................................................................... 31
Display stations................................................................................................................................ 32
Display firmwareDisplay server firmware......................................................................................... 34
Manage Phone Firmware................................................................................................................. 35
Schedule Phone File Download....................................................................................................... 36
DHCP Manager......................................................................................................................................... 38
DHCP............................................................................................................................................... 38
DHCP server status.......................................................................................................................... 38
Activate or deactivate DHCP............................................................................................................ 38
DHCP IP address pools................................................................................................................... 39
Show DHCP leases.......................................................................................................................... 41
DHCP server log.............................................................................................................................. 42
IPv6 DHCP Manager................................................................................................................................. 42
Purpose
This document provides procedures for managing the features that are part of Utility Services.
Features include IP phone settings, ADVD Settings, IP phone firmware management, log
viewer, CDR tools, and Enhanced System Directory.
Intended audience
The primary audience for this document is:
• Avaya field technicians
• Avaya partners
• Technical support personnel
• Solution Architects
• Implementation Engineers
• Support Personnel
• Technical support representatives
• Authorized Business Partners
Related Resources
Documentation
The following table lists the documents related to this product. Download the documents from
the Avaya Support website at http://support.avaya.com/.
• Enter a key word or key words in the Search Channel to search for a specific product
or topic.
• Scroll down Playlists, and click the name of a topic to see the available list of videos
posted on the site.
Support
Visit the Avaya Support website at http://support.avaya.com for the most up-to-date
documentation, product notices, and knowledge articles. You can also search for release
notes, downloads, and resolutions to issues. Use the online service request system to create
a service request. Chat with live agents to get answers to questions, or request an agent to
connect you to a support team if an issue requires additional expertise.
Warranty
Avaya provides a 90-day limited warranty on Communication Manager. To understand the
terms of the limited warranty, see the sales agreement or other applicable documentation. In
addition, the standard warranty of Avaya and the details regarding support for Communication
Manager in the warranty period is available on the Avaya Support website at http://
support.avaya.com/ under Help & Policies > Policies & Legal > Warranty & Product
Lifecycle. See also Help & Policies > Policies & Legal > License Terms.
Avaya Aura® Utility Services runs a number of utility applications that support or enhance the component
applications facilitating a complete single box solution.
With Utility Services Release 6.2 and later, you can connect the Utility Services applications and tools
with the duplex Communication Manager or Main Survivable Server template that is running on a separate
server. When deployed as a standalone template, the system supports Utility Services for the
Communication Manager Duplex deployment solution.
Note:
If you configured the stand-alone Utility Services template to connect to Communication Manager on
a Communication Manager template that includes Utility Services, do not configure Utility Services on
the Communication Manager template.
The following sections describe the Utility Services applications.
Utility Admin
Using Utility Admin, you can configure and gain access to the following Utility Services applications:
• Software Version: Displays the software versions of packages, operating system, IP telephone
Firmware, media module firmware, and gateway firmware that are installed and active on Utility
Services.
• Firewall Rules: Displays the IPv4 and IPv6 firewall rules of Utility Services.
• IP Phone file server: Supports the download of IP telephone firmware and settings files. The server
also supports backing up and restoring IP telephone user configuration, for example, speed dial
configurations.
• ADVD Settings Editor: Provides a Web-based tool for configuring the Avaya Desktop Video Device
(ADVD) settings file. The ADVD Settings Editor significantly simplifies the process of making changes
to the ADVD settings file and provides enhanced validation to avoid wrong configurations.
• IP Phone Settings Editor: Provides a Web-based tool for configuring the IP telephone settings file.
This significantly simplifies the process of making changes to the IP telephone settings file and
provides enhanced validation to avoid wrong configurations.
• IP Phone firmware management: Supports uploading new telephone firmware to the file server.
• DHCP server: Provides basic DHCP server capabilities for supporting IP telephones.
• IPv6 DHCP server: Provides IPv6 DHCP server capabilities for supporting IP telephones.
• IP Phone Push Server: Displays the content from the Push Server Database.
• Log viewer: Supports accessing the log files for all of the Utility Services applications.
• CDR Tools: Provides a Call Detail Records (CDR) collection capability that collects CDR records
from Communication Manager and imports the records into the Utility Services database. CDR tool
also provides some simple example reports to demonstrate how a system administrator can use the
CDR data in the database.
MyPhone Admin
Using MyPhone Admin you can gain access to the following configuration elements of MyPhone and IP
telephone operations:
• MyPhone Feature Buttons: You can enable or disable the features available to the users of
MyPhone.
• WML Links: The IP Phones can display a default Wireless Markup Language (WML) page. You can
use this option to configure the default WML page.
• System Message: You can configure the WML page. This element typically contains a block of text
which is relevant to every IP Phone user.
For more information about MyPhone Admin, see Avaya Communication Manager Express MyPhone
Administration Reference, 03-602578.
MyPhone
Using MyPhone you can configure the IP telephones through a Web interface. You can configure buttons,
language settings, EC500, Enhanced Call forwarding, and other features. With MyPhone, you can also
change the station security codes and other parameters through the Web interface.
For more information about MyPhone, see Avaya Communication Manager Express MyPhone Quick
Reference, 03-602253.
MyPhone User Guide
You can download a PDF file and an online HTML file to view the MyPhone documentation.
Common
Software Version
Use the Software Version page to view the software versions of packages, operating system,
IP Telephone Firmware, media module firmware, and gateway firmware that are installed and
active on Utility Services.
Miscellaneous
Ping Host
You can confirm network connectivity between the Utility Services and other IP hosts.
Pinging a host
Procedure
• Select the respective check box if you want the system to bypass normal
routing tables and send directly to a host while pinging.
4. Click Execute Ping6 to ping the required endpoint and check the connectivity.
Upload files
Use a web browser to upload a file to the Utility Server. You can upload either single file or a
zipped file. In both cases, the file is transferred from the web browser session to the /tmp
directory on Utility Server. Other applications can use this directory as a temporary store for
files.
Note:
Firmware backup setting affects both local and System Platform backups.
Name Description
Enable Customer Banner Enables the customer banner.
Disable Customer Banner Disables the customer banner.
Update Customer Banner Updates the customer banner.
Firewall Rules
Firewall IPv4
The Firewall IPv4 page displays the IPv4 firewall rules of Utility Services. Using the Firewall
IPv4 page, you cannot edit or configure the firewall rules.
Firewall IPv6
The Firewall IPv6 page displays the IPv6 Firewall rules of Utility Services. Using the Firewall
IPv6 page, you cannot edit or configure the firewall rules.
1. To view the IPv4 firewall rules, click Firewall Rules > Firewall (IPv4).
2. To view the IPv6 firewall rules, click Firewall Rules > Firewall (IPv6).
IP Phone Tools
Note:
Comment lines start with double pound keys (##). Active lines start with SET
command and contain options that are read by the ADVD. Lines within the file
that start with double pound keys (##). SET are inactive. Currently the settings
editor works only with values in uppercase. So, you must use uppercase for SET
and parameter names in the file.
Utility Services. SIP and H.323 videos use the same Axxxsettings.txt
file.
Note:
You can edit the URL address in the text box to download the file from a
different HTTP source. If you have a different file server in the network, then
enter the URL for Axxxsettings.txt on that server. The application
downloads the Axxxsettings.txt file for editing.
The application cannot save the file back on the remote server. You must
download the edited Axxxsettings.txt from the server on the Save
page, and then upload the file to the original server.
• To upload a Axxxsettings.txt file or
ADVDParameterDefinitions.xml file from a computer to the server,
select Upload ADVD settings or xml file and then click Browse.
The ADVDParameterDefinitions.xml contains help and entry
information for the editor. At present, Utility Services includes the latest version
of ADVDParameterDefinitions.xml file. This version will be available on
the Avaya Support site for later releases. The latest version of the
Axxxsettings.txt file is available on the Avaya Support site.
Note:
If the Axxxsettings file size is very large, the system takes approximately 5
to 10 seconds to load the file.
2. Click Proceed with selected values to edit the selected file.
The system displays the Axxxsettings.txt page with four columns: Activate,
Parameter, Value, and Add Edit Delete.
3. Perform one of the following steps as required:
• Performing basic ADVD settings editing on page 21
• Checking ADVD settings syntax on page 22
• Performing advanced ADVD settings editing on page 22
• To activate a setting or deactivate a setting in the file, click the check box in the
Activate column. The system displays the value within the file and ADVD uses
that value.
• To change a value of a setting, change the value in the text box.
Note:
You must save the changes every time by using the Commit button at the
bottom of the page.
• To edit an entire line, click <. The system reloads the page and displays the line
exactly as in the file. Edit the text as required, and click Save Line. You can also
edit the comment lines using the same procedure.
• To delete a line, select the line and click the minus (-) sign. If you accidentally
delete a line, you can reload the original settings file by clicking ADVD Settings
Editor from the left navigation menu.
1. After finish making the changes, click Save New Settings File.
2. On the Output Screen page, perform one of the following steps:
• To save the file in the Utility Services, click Save Axxxsettings.txt file to this
server.
• To download the file to your computer, click either the
Axxxsettings.txt(comments included in file) link or the
Axxxsettings.txt(no comments) link.
Name Description
Activate Contains a checkbox. Select the checkbox to
signify that the setting is active and ADVD
can read the setting. Clear the checkbox to
signify that the setting is inactive, displays as
commented out in the settings file and the
ADVD does not read the settings.
Parameter Displays comments and settings values.
Comments span both the columns, and you
can edit the comments using the edit line
button in the next column. The system
displays the ADVD settings name in the
parameter column and the current value in
the Value column.
Value Displays comments and settings values.
Comments span both the columns, and you
can edit the comments using the edit line
button in the next column. The system
Name Description
displays the ADVD settings name in the
parameter column and the current value in
the Value column
Add Displays the following buttons:
Edit Add: Adds a line or a comment.
Delete Edit: Edits an entire line or the comment
Reload lines.
Delete: Deletes a line.
Reload: Reloads the page validating any
changes.
Note:
Comment lines start with double pound keys (##). Active lines start with SET
command and contain options that are read by the IP phones. Lines within the
file that start with double pound keys (##) SET are inactive. Currently, settings
editor works only with values in uppercase. So, you must use uppercase for SET
and parameter names in the file.
Note:
You can edit the URL address in the text box to download the file from a
different HTTP source. If you have a different file server in the network, then
enter the URL for 46xxsettings.txt on that server. The application
downloads the 46xxsettings.txt file for editing.
The application cannot save the file back on the remote server. You must
download the edited 46xxsettings.txt from the server on the Save
page, and then upload the file back to the original server.
• To upload a 46xxsettings.txt file or
IpPhoneParameterDefinitions.xml file from a computer to the server,
select Upload IP phone settings or xml file and then click Browse.
The IpPhoneParameterDefinitions.xml contains help and entry
information for the editor. At present, Utility Services includes the latest version
of IpPhoneParameterDefinitions.xml file. This version will be available
on the Avaya Support site for the later releases. The latest version of the
46xxsettings.txt file is available on the Avaya support site.
Note:
If the 46xxsettings file size is very large, the system takes approximately 5
to 10 seconds to load the file.
2. To edit the selected file, click Proceed with selected values.
The system displays the 46xxsettings.txt page with four columns:
• Activate
• Parameter
• Value
• Add Edit Delete
See IP Phone Setting Editor field descriptions on page 28.
3. Perform one of the following steps as required:
• Performing basic IP Phone settings editing on page 26
• Checking IP Phone settings syntax on page 27
• Performing advanced IP Phone settings editing on page 27
Note:
You must save the changes every time by using the Commit button at the
bottom of the page.
Editor from the left navigation menu. Changes are not saved to the file until the
system displays the final page and you select a save option.
1. After finish making the changes, click Save New Settings File.
2. On the Output Screen page, perform one of the following steps:
• To save the file in the Utility Services, click Save 46xxsettings.txt file to this
server.
• To download the file to your computer, click either the
46xxsettings.txt(comments included in file) link or the 46xxsettings.txt(no
comments) link.
Name Description
Activate Contains a checkbox. Select the checkbox to
signify that the setting is active and IP
Phones can read the setting. Clear the
checkbox to signify that the setting is
inactive, displays as commented out in the
settings file and the IP Phones does not read
the settings.
Parameter Displays comments and settings values.
Comments span both the columns, and you
can edit the comments using the edit line
button in the next column. The system
displays the IP phone settings name in the
parameter column and the current value in
the Value column.
Value Displays comments and settings values.
Comments span both the columns and you
can edit the comments using the edit line
button in the next column. The system
displays the IP phone settings name in the
parameter column and the current value in
the Value column.
Name Description
Add Displays the following buttons:
Edit Add: Adds a line or a comment.
Delete Edit: Edits an entire line or the comment
Reload lines.
Delete: Deletes a line.
Reload: Reloads the page validating any
changes.
Note:
The SIP Phones store their configuration information on the SIP Enablement Server. The
System Platform master backup also backs up this data.
1. In the navigation pane, select IP Phone Tools > IP Phone Backup and
Restore .
2. Click Create Backup to create a new zip file of the IP Phone backup files. After
creating the backup file, the system provides a link to download the newly created
zip file.
1. In the left navigation pane, click IP Phone Tools > IP Phone Backup and
Restore.
2. To locate an existing ZIP file of the IP Phone backup files, click Browse.
Name Description
Create Backup Creates a new ZIP file of the IP Phone
backup files. After creating the backup file,
the system provides you a link to download
the newly created ZIP file.
Upload Backup Uploads a backup ZIP file to the Utility
Server's repository of IP Phone backup
files.
Note:
You cannot reset IP stations that are not logged in or are logged in with unnamed
registrations using this application.
Configure CM Login
The Configure CM Login page contains the login for Communication Manager. Using the
Configure CM Login page, you can configure the login that Utility Services will use to
communicate with Communication Manager.
Important:
The user name and password that you enter must already be configured in
Communication Manager.
Name Description
CM Address Enter the Communication Manager IP
Address.
User Name Enter the user name.
Important:
The user name and password must be
configured in Communication Manager.
The user name must be bash shell
privileged or non Access Secure Gateway
(non ASG). If you enter the dadmin user
name, which does not have the bash shell
privileges, and click the Test
Connection button, the system displays
the Connection to Call Server
failed!.
Password Enter the password.
Name Description
Save Callserver Settings Saves any changes made to the settings on
the CM Login page.
Test Connection Checks the connections and logins.
Display stations
This page displays the IP stations registered with Communication Manager and configured
using the Communication Manager login.
Note:
The telephone information might take some time to display the first time that you
perform this procedure. Results for larger systems will take more time to display
than results for smaller systems. Subsequent displays take less time.
Name Description
Extension The extension number on Communication
Manager.
Type The station type as set on the station form.
Connected Type The actual type of station that is connected.
Model The type of IP phone that is connected.
Network Region The IP network region the phone is in.
IP address The IP address as seen on Communication
Manager of the IP endpoint.
Firmware Version The current version of firmware on the IP
endpoint.
Firmware on the Utility Server The firmware version stored locally on the
Utility Services.
Name Description
Update Table Forces the IP Phone Firmware Manager
application to log in to Communication
Manager and update the Phone Firmware
Manager database with the station
information.
Refresh Page Refreshes the current Web page with the
current information in the Phone Firmware
Manager database.
Managing firmware
About this task
Use this procedure to view, unpack, activate, deactivate, or remove endpoint firmware from
Utility Services.
Procedure
Name Description
View Displays the information of the selected firmware package.
Unpack Unpacks each package of phone firmware separately extract files from
the ZIP archive.
Activate Activates the selected firmware package and makes firmware available
to the Utility Server.
Deactivate Deactivates the selected firmware package and remove firmware from
the web server.
Remove Deletes the extracted files as well as the ZIP archive.
Name Description
Select Phones The list of IP phones from which you select
one or more IP Phone to reset based on the
phone type and firmware.
Select Start Time The time when the reset operation starts.
You can choose to reset a phone
Name Description
immediately, or you can set a date and time
to reset later.
Select Stop Time The time when the system stops the reset or
reboot operation. You can specify the date
and time for the reset operation.
Select whether a phone may be updated An option to enable the system to reset the
while being active phones that are currently active on a call.
You can set the option to No or Yes.
Select whether a phone running the latest An option to enable the system to reset only
firmware should be reset those phones that do not run the same
version of firmware as on Utility Services. Set
this option to Yes if you made changes to the
46xxsettings.txt file that the phones
use.
Enter the minimum delay between The number of seconds the system waits
handling of phones between resetting of phones to prevent the
file server being overloaded.
Enter the maximum number of error The number of times the system retries to
retries per phone reset a phone in the event the system fails to
upgrade the phone to the firmware on Utility
Services. The number of retries is limited by
the stop time specified in the Select Stop
Time field.
Enter the minimum delay between error The number of seconds the system waits
retries before trying to reset the same phone
again.
Select when error retries are re- The option to schedule the number of
scheduled attempts for resetting a phone when there is
an error in resetting at the end of the
scheduled period or during the scheduled
period.
Name Description
Schedule Phone Firmware Update Schedules the IP Phone Firmware update
according to the settings in the Phone
Firmware Manager - Schedule Control
page.
DHCP Manager
DHCP
Dynamic Host Configuration Protocol (DHCP) is a method for endpoints to automatically obtain
IP addresses. Any client configured to use DHCP can obtain an IP address from the server
automatically allowing easier management of IP endpoints and efficient use of IP addresses.
The Utility Services DHCP uses the Linux DHCPD. Advanced users familiar with Linux DHCPD
can edit the dhcpd.conf directly and the application supports this. Any entry that is not displayed
on the Web-based DHCP editor is stored in the file.
Name Description
Activate DHCP Server Activates the DHCP server.
On the DHCP Service Control page, you can
see RUNNING to indicate the active state.
Deactivate DHCP Server Deactivates DHCP server.
Load last working DHCPD conf file Loads the DHCPD file containing your
settings that you used to run the DHCP
Server last time.
Note:
In case you are unsure of a value to enter, click the blue question mark to see a
description of what should be entered in the field
5. Click Commit Changes and restart DHCPD.
Name Description
Range Start The start of the range of IP addresses that
you can use in DHCP.
Range End The end of the range of IP addresses that
you can use in DHCP.
Range Size The total number of IP addresses available
in the range for DHCP.
IP addresses in use The total number of IP addresses that are
currently in use within the range of IP
addresses.
Percentage in use The percentage for the number of IP
addresses in use within the range of IP
addresses.
Binding State The current status of an IP address. The
available options are Active and Free.
Active: An endpoint is currently using the IP
address.
Free: An endpoint has returned the IP
address to the pool.
Name Description
MAC Address The IP addresses for a particular computer
or laptop. This address is used for physical
identification of a particular Ethernet code.
Name Description
Activate DHCP Activates the DHCP server. On the IPv6 DHCP Service Control page,
Server you can see RUNNING to indicate the active state.
Deactivate Deactivates IPv6 DHCP server.
DHCP Server
Load last Loads the DHCPD file containing your settings that you used to run the
working DHCPD DHCP Server last time.
conf file
Name Description
DHCP v6 Start Enter the valid IPv6 address without prefix.
Address
DHCP v6 Stop Enter the valid IPv6 address without prefix.
Address
DHCP v6 Prefix Enter the prefix address that is identical to the start and stop
Address addresses.
Name Description
Range Start The start of the range of IPv6 addresses that you can use in DHCP.
Range End The end of the range of IPv6 addresses that you can use in DHCP
Range Size The total number of IPv6 addresses available in the range for DHCP.
IP addresses in The total number of IPv6 addresses that are currently in use within the
use range of IP addresses.
Percentage in The percentage of the number of IPv6 addresses in use within the range
use of IP addresses.
Binding State The current status of an IPv6 address. The available options are Active
and Free.
Active: An endpoint is currently using the IPv6 address.
Free: An endpoint has returned the IPv6 address to the pool
Name Description
MAC Address IPv6 addresses of a particular computer or laptop. This address is used
for physical identification of a particular Ethernet code.
Gateway Firmware
Button Description
Refresh Page Refreshes the IP telephone Push Server - Display Push Database
page.
Re-Subscribe Marks all registration entries as expired. The button also requests that
Extensions each device reregisters. On successful reregistration, the system
updates and validates the records.
Purge Database Deletes all expired records.
File server
You can view and download the file server log files, that is, the access and error log files for
HTTP, HTTPS, and Watchdog files, and the history log files. The system maintains the secure
and nonsecure access logs separately and also provides separate log files for monitoring and
recording of errors. You can filter the File Server logs to only display access entries made by
Avaya IP Phones. The Watchdog file is unique to the Utility Services. The Watchdog tests the
file server on a regular basis and restarts the server if the file detects any problem.
You can use the File Server option to view the current status of the file server and check
whether the server restarts automatically when rebooted. You can conduct a configuration file
test and restart the file server. You can also change the level of logging for the file server
independently for insecure (HTTP) and secure (HTTPS) access. You must restart the file
server to make the changes to the log levels effective.
Note:
Error logs do not support filtering.
Messages
Use the View Linux Messages Log Files page to view and download the Linux Messages log
files.
You can:
• view the log files, such as Messages Server Access Log and View Archive Log Files.
• zip the archived log files, download, and save the log files on your local drive.
• download the historic data to diagnose the system.
System Database
The Utility Services uses a local database to store and retrieve data for a variety of applications.
These applications include the Call Detail Recording system, the MyPhone System
Administrator, and other diagnostic tools. You can use the System Database option to view
and download the log files for the system database.
MyPhone
With the MyPhone application, you can change the station security code and station buttons.
The application includes an administrator interface to control the buttons that users can select,
phone WML page, and LDAP directory control. You can use the MyPhone option to view and
download all the log files relevant to the MyPhone Server. The MyPhone server includes
MyPhone, the MyPhone Administrator log files, and the raw output from Tomcat - catalina.out.
You must use the catalina.out file only for diagnostic analysis, as this file contains entries
which are unrelated to the MyPhone application.
Note:
Avaya recommends that you keep the MyPhone option turned off so that users cannot
modify the settings on the phone, for example, the security code.
TFTP server
You can view and download the TFTP server access log files. You can also view the archive
log files.
Application Control
File server
The Control Web Server page displays the current status of the File Server and also provides
information on whether the server will automatically restart after a reboot. You can conduct a
configuration file test and request a restart of the File Server. You can change the level of
logging for the File Server independently for Insecure (HTTP) and Secure (HTTPS) access.
You must restart the file server to make the changes to the log levels effective.
Note:
You cannot change the operation of the File Server when a server reboots or stop the File
Server when a server reboots.
Note:
The system can take up to five minutes to activate the request to restart the File
Server.
4. Perform one of the following steps as appropriate:
• Choose the required option from the drop-down menu, and click Set Logging
Level for Insecure Access (HTTP).
• Choose the required option from the drop-down menu, and click Set Logging
Level for Secure Access (HTTPS).
Name Description
FIle Server Configuration Test Starts a configuration file test.
Restart File Server Restarts the file server.
Set Logging Levels for Insecure Access Sets logging level for the file server for HTTP,
(HTTP) or changes the existing log level settings
based on your selection.
Set Logging Levels for Secure Access Sets logging level for the file server for
(HTTPS) HTTPS, or changes the existing log level
settings based on your selection.
Name Description
CM Username Enter the Communication Manager user
name.
CM Password Enter the password.
The Control Phone Firmware Manager (PFM) Server page displays the current
status of the PFM server.
2. To start or stop the PFM Server, click Start the PFM Server or Stop the PFM
Server.
3. To enable or disable autostart of the PFM Server after a reboot, click Enable
Autostart of the PFM Server or Disable Autostart of the PFM Server.
Name Description
Start the PFM Server Starts the PFM server.
Stop the PFM Server Stops the PFM server.
Enable Autostart of the PFM Server Enables auto start of the PFM server after a
reboot.
Disable Autostart of the PFM Server Disables auto start of the PFM server after a
reboot.
System Database
You can use the System Database option to view the current status of the system database
and check whether the server restarts automatically on a reboot. You can also start or stop
the server immediately or configure the operation of the system database after a reboot.
Name Description
Start System Database Starts the system database server.
Stop System Database Stops the system database server.
Enable Autostart of System Database Enables auto start of the system database
server after a reboot.
Disable Autostart of System Database Disables auto start of the system database
server after a reboot.
MyPhone
You can use the MyPhone option to view the current status of the MyPhone Server and check
whether the server restarts automatically on a reboot. You can also start or stop the server
immediately or configure the MyPhone operation after a reboot.
Name Description
Start MyPhone Server Starts the MyPhone Server.
Stop MyPhone Server Stops the MyPhone Server.
Name Description
Enable Autostart of the MyPhone Server Enables auto start of the MyPhone Server
after a reboot.
Disable Autostart of the MyPhone Server Disables auto start of the MyPhone Server
after a reboot.
TFTP server
You can view the current status of the TFTP server and whether the server will automatically
restart or reboot. You can start or stop the server to configure the operation of the server after
a reboot.
Name Description
Start the TFTP Server Starts the TFTP server.
Stop the TFTP Server Stops the TFTP server.
Enable Autostart of the TFTP Server Enables auto start of the TFTP server after a
reboot.
Disable Autostart of the TFTP Server Disables auto start of the TFTP server after
a reboot.
CDR reports
You can use the CDR Reports option to view the CDR Reports currently available. The system
collects the CDR records from Communication Manager and imports the records to the Utility
Services database.
CDR backups
The CDR Export daemon ensures that the active CDR database contains only 12 months of
data. Once per month, the system deletes any data that is older than 12 months. However,
before deleting the data, the system stores the data in a Comma Separated Values (CSV) file.
You can use the CDR Backups option to download the data and store the data remotely or
import the data to another database. To provide ease of import, the system stores database
headings as the first line in the CSV file.
Note:
The system automatically deletes the files that are older than 12 months. At any given time,
you can gain access to a maximum of 12 months of online data and 12 months of previous
offline data in Utility Services.
CDR archive
The CDR Compress daemon compresses the raw CDR files collected from Communication
Manager as ZIP files, and stores the files in a directory named by month or year. You can use
the CDR Archive option to download these compressed zip files.
CDR e-mails
By using the Control CDR E-Mails page, you can configure and control the operation of each
of the three regular e-mail daemons: daily, weekly, and monthly. You can enable or disable
each daemon separately. You can configure each daemon to generate up to three separate
reports and send the reports to a configurable list of recipients.
Name Description
E-Mail Daemon Enable or disable e-mail daemon for each of
the three regular daemons: daily, weekly,
and monthly.
Name Description
Longest Calls Generate a report for the longest calls you
have made over a period of time.
Most Active Generate a report for the most active
extensions that you have called.
Most Dialed Generate a report of the most dialed
numbers when you make calls.
Distribution List Send the reports to a list of recipients by e-
mail. You can separate each e-mail address
in the distribution list with a semicolon.
Name Description
Update CDR E-Mailer Configuration Saves and updates the CDR e-mail settings
based on the settings on the Control CDR E-
Mails page.
Using the Directory application, you can search an LDAP database using browsers that are compatible
with your 46xx and 96xx telephones. You can use the Web pages to configure the Directory application
to connect to an LDAP database and to customize the user search experience. Directory application
supports 250 instances of the Directory configuration and provides multi-language support for each of
these instances. For a more detailed description of the Directory application feature and the required
configuration, see Directory Application Job Aid on the Avaya Support website at https://
support.avaya.com.
Set the HTTP (or HTTPS) to point to the Utility Server through DHCP or in the
46xxsettings.txt file.
Utility Server includes a 46xxsettings.txt file. The WMLHOME parameter is
automatically set up to point to a landing page that includes three WML applications:
Directory Application, User entered URL, and Message Application.
General Settings
Use this screen to administer general settings and LDAP connection settings for the Directory
application.
General Administration
Directory number
Select any number between one and 250 and the system configures Directory application for
the particular directory number. The system configures and applies the particular directory
number to the General Settings page, the Translation Language page, and the External
Numbers page.
Application title
Enter an application title that the search screen of the telephone browsers can display.
HTTP
Select Enable to enable HTTP traffic. If you enable HTTP, the Directory application can accept
traffic from WML Browsers using the HTTP protocol.
Warning:
When you enable the Directory application on the HTTP port or unsecured port 80, you allow
any browser to gain access to the Directory application without authentication or encryption
mechanisms. Unauthorized users can gain access to directory information that is stored on
your LDAP server using the Directory interface.
HTTPS
Select Enable to enable HTTPS traffic. If you enable HTTPS, the Directory application can
accept traffic from WML Browsers using the HTTPS protocol.
Select a language file
Select a language file from the drop-down menu where you can write your translation.
Select language for your translation
Select a language for your translation from the drop-down menu to write to the language file
you selected in the previous step.
LDAP Administration
Host Name
Enter the hostname or IP address of the LDAP server. The Directory application connects to
this server for searching.
Port
Enter a port number. The default LDAP port is 389. If the LDAP server is using a different port,
enter the port number.
Note:
Ensure that this port is enabled in the firewall. You should open the port only for outbound
traffic.
Base DN (Search Root)
Specify an LDAP distinguished name from where the Directory application can begin
searching.
Base DN (External Search Root)
Specify an LDAP Base Distinguished Name where the external numbers are stored. With the
Manage External Numbers screen, you can use this root to list, add, or delete entries in the
external directory. This distinguished name must be under the Search Root to enable the
Directory application to include external names in its search. For example, if the Search Root
is o=avaya.com, then the External Search Root can be ou=external numbers, o=avaya.com.
Max number of hits
Enter the maximum number of results that must be returned for a particular search. The default
value is 96.
Note:
A higher number can degrade the system performance. The system stops the search
operation when the search reaches the maximum number.
User ID
Specify a User ID to connect to the LDAP server. If you do not provide a User ID, the Directory
application uses an anonymous LDAP connection. To ensure that you can modify the LDAP
database using the Manage External Numbers screen, you must give write access to the
specified user for the database.
Password
Specify a password for the User ID you specified for the LDAP server.
Search Time
Enter the maximum number of seconds the search can take before returning the results. The
system stops the search operation when the search exceeds the time. The default value is 10
seconds.
Secure Connection (TLS support)
Select On or Off. The Directory application can connect to an LDAP server on TCP or TLS. If
you select TLS as the connection type, requires additional configuration is required. For more
details, see the TLS Configuration topic.
Test Connection
Click Test Connection to ensure that the Directory application can connect to the LDAP server
using the connection parameters you specified in Secure Connection (TLS support) section.
Note:
A valid LDAP attribute name can be an alphabetic character, a number, and the minus (-)
and colon (;) symbols. But the attribute name must begin with an alphabetic character.
Associated Label
Enter the label for each search attribute that is activated. This label supports Unicode and is
displayed on the telephone search screen.
Minimum Search String
Enter the minimum number of characters with values between one and nine required for user
entered Search strings. The directory application denies a search with a search string
containing less than the minimum number of characters required.
Note:
A valid LDAP attribute name can be an alphabetic character, a number, and the minus (-)
and colon (;) symbols. But the attribute name must begin with an alphabetic character.
Associated Label
Enter the label that the system displays before the actual value on the detail screen.
Note:
A valid LDAP attribute name can be an alphabetic character, a number, or the symbols -
and ;. But the attribute name must begin with an alphabetic character.
Filter Text
Enter the label which would be used in the ldap search filter for the associated filter attribute.
Translation Language
Use the Translation Language screen for the translation language you selected in the General
Administration screen for the selected Directory Number. The system has 11 predefined
translation languages. When you select a language, the system writes the language translation
to the file and the system displays the details in the translation column. If you select a language
other than the 11 predefined languages, the system displays English text mapping English
translations. In either of these scenarios, you can edit the English text in the translation
mapping column.
The following list includes the 11 predefined language translations:
• Brazilian-Portuguese
• English
• French
• German
• Italian
• Japanese
• Korean
• Lat-Spanish
• Russian
• Simplified Chinese
• Traditional Chinese
Using the translation language settings, the user can edit the translation string in the right
column of each English string.
External Numbers
You can use this screen to view entries under the External Number search root in the LDAP
database based on your specification in the General Settings screen. You can also add new
external numbers and edit or delete existing external numbers.
Note:
To ensure that you can modify the LDAP database using the Manage External Numbers
screen, you must give write access to the specified user for the database.
Note:
The Native Name and Phone Number fields are mandatory.
9. To add the external number to the LDAP database and go back to the External
Numbers screen, click Save.
10. To view your changes, click Refresh.
Note:
You can edit only one entry at a time. You cannot modify the details in the Native
Name field.
5. To save your changes to the LDAP database and go back to the External
Numbers screen, click Save.
6. To view your changes, click Refresh.
To gain access to the Postgres database, use Utility Services. To gain access to the Postgres databases,
use the administrator credentials. You gain read-only access.
The Utility Services database contains the Call Detail Records (CDR) as the database CDR and the Push
Registration Database as PUSH. You can access the CDR and the Push Registration Database from an
external application as standard Postgres database. To access the database, use the base IP Address
of Utility Services on port 5432.
The database schemas are as follows:
Call Detail Record
TABLE raw
(
pbxid varchar(25) NOT NULL DEFAULT 'PBX'::bpchar,
cdrdate date NOT NULL DEFAULT '2005-01-01'::date,
cdrtime time NOT NULL DEFAULT '00:00:00'::time without time zone,
duration int4 NOT NULL,
acctcode varchar(15),
attdconsole varchar(4),
authcode varchar(13),
bandwidth varchar(2),
bcc char(1),
callingnum varchar(15) NOT NULL,
calltype char(1),
clgnum varchar(15),
clgpty varchar(2),
codedial varchar(4),
codeused varchar(4),
condcode char(1),
contacturi varchar(20),
countryfrom varchar(3),
countryto varchar(3),
dialednum varchar(23),
enddate date,
endtime time,
featflag char(1),
frl char(1),
fromuri varchar(20),
incrtid varchar(3),
intrkcode varchar(4),
ins varchar(5),
internalcodec varchar(2),
isdncc varchar(11),
isdnccppm varchar(11),
ixccode varchar(4),
locationfrom varchar(3),
locationto varchar(3),
mauui char(1),
nodenum char(2),
outcrtid char(3),
ppm varchar(5),
requesturi varchar(20),
resflag char(1),
secdur varchar(5),
seqnum varchar(10),
startdate date,
starttime time,
timezonefrom varchar(6),
timezoneto varchar(6),
touri varchar(20),
tscct varchar(4),
tscflag char(1),
trunkcode varchar(2),
ucid varchar(20),
vdn varchar(3),
CONSTRAINT raw_pk PRIMARY KEY (pbxid, cdrdate, cdrtime, duration, callingnum)
)
Push
TABLE subscription
(
macaddr varchar(25) NOT NULL DEFAULT 'UNKNOWN'::bpchar,
extn varchar(12) NOT NULL DEFAULT '0'::bpchar,
ipaddr varchar(15) NOT NULL DEFAULT '0'::bpchar,
setid varchar(10) NOT NULL DEFAULT 'UNKNOWN'::bpchar,
lastupdate date DEFAULT '2011-07-27'::date,
extnvalid bool DEFAULT true,
CONSTRAINT subscription_pk PRIMARY KEY (extn)
)
Configuring MyPhone
You can configure the MyPhone application using the MyPhoneAdmin application on Utility
Services. These applications have their own help files that Utility Services has provided in both HTML and
PDF formats. You can access the MyPhoneAdmin application by performing the following steps:
1. Browse to the IP address of Utility Services.
2. From the Utilities menu, select MyPhone Admin option.
3. Log in using the default administrative account.
Use the MyPhone AES, CM, and SES Access to gain access to Communication Manager to be
administered. The default account is called MyPhone and installation that use Post-Install wizards
configures this account automatically with minimal require permissions. Use the test connection option
to verify connectivity prior to saving this configuration.
Configuring the Phone Firmware Manager
The Phone Firmware Manager (PFM) requires access to Communication Manager to perform status
enquiries and schedule firmware upgrades. This account can be any user account that has SAT access
and can also be the same as the account used for MyPhone. You can gain access to Phone Firmware
Manager using from the Configure CM Login option of the IP Phone Firmware Manager menu of the
Utility Services Administration pages. Using this option you can configure: IP address of Communication
Manager, user account, and user password. Use the test connection option to verify connectivity prior
to saving this configuration.
Important elements of the 46xxsettings.txt file
Post-Install Wizard configures the 46xxsettings.txt file when the template is first installed, but you can edit
or replace the file after installation. You can configure several elements to link up to Utility Services for
various features. While configuring the following elements, you must replace <IP> with the Utility Services
IP address:
• IP Phone Backup and Restore: By default, Utility Services can act as an IP Phone Backup and
Restore server. You can configure either HTTP or HTTPS and the subdirectory “PhoneBackup” is
important. Utility Services only allows Avaya IP Phones to read and write to this directory. You can
configure the element typing the following command in the configuration file: SET BRURI http://
<IP>/PhoneBackup or https://<IP>/PhoneBackup.
• PUSH: By default, Utility Services can act as both a Push Registration server and as a Trusted Push
server. You can configure the element by performing the following steps in the configuration file:
a. Type the SET TPSLIST <IP> command.
b. Type the SET SUBSCRIBELIST http://<IP>/push/subscribe.php command.
• WML Home Page: By default, Utility Services provides a default WML Home Page. You can
configure the element typing the following command in the configuration file: SET WMLHOME
http://<IP>/landing.wml.
• ESD Landing Pages: By default, Utility Services provides access to the Enterprise System Directory
application. However, you must add the following command at the end of the configuration file to
gain access to the full configuration: GET ESD_Landing.txt.
1. Create a new user of the CDR_User type on Communication Manager and administer the new
username and password on Utility Services in step 3. The CDR_User type has the required
privilege to gain access to the CDR data.
2. Configure the CDR format to ensure that the correct data elements are passed to Utility
Services. Refer to the following figures.
Note:
By default, the CDR Daemons are disabled and you must enable CDR Daemons as required.
CDR Collector must be stopped and started for any changes in configuration to be applied.
If the Communication Manager details are updated prior to enabling the CDR daemon, then
the CDR Collector must only be started for the changes to be effective.
B D
back up and restore ....................................................29
deleting an external number from LDAP database .... 67
Detail Screen .............................................................. 65
C
DHCP ......................................................................... 38
Call Detail Record ...................................................... 49 activate .................................................................38
G M
General Administration ............................................... 62 managing ADVD settings ........................................... 20
General Settings .........................................................62 managing IP phone settings ....................................... 25
MyPhone ......................................................... 11, 51, 56
MyPhone Server ................................................... 51, 56
I
MyPhone server log files ............................................ 51
IP Phone .....................................................................29 MyPhoneAdmin .......................................................... 51
backup ................................................................. 29
restore .................................................................. 29 P
IP phone back up and restore .................................... 30
IP Phone file server .................................................... 11 ping .............................................................................16
IP Phone firmware management ................................ 11 IP host .................................................................. 16
IP phone firmware manager ....................................... 31 TCP host .............................................................. 16
IP Phone Setting Editor field descriptions .................. 28 pinging a host ............................................................. 16
U Warranty .......................................................................9
Watchdog file ..............................................................48
Upload files .................................................................17 Watchdog test ............................................................ 48