LEGAL NOTICE
While the information in this document is believed to be accurate and reliable, except as otherwise expressly agreed
to in writing NORTEL PROVIDES THIS DOCUMENT AS IS WITHOUT WARRANTY OR CONDITION OF ANY
KIND, EITHER EXPRESS OR IMPLIED. The information and/or products described in this document are subject
to change without notice.
Sourced in Canada
Nortel, the Nortel Logo, the Globemark, SL-1, Meridian 1, and Succession are trademarks of Nortel Networks.
All other trademarks are the property of their respective owners.
Contents
New in this release7
Other changes7
How to Get Help9
Getting Help from the Nortel Web site9
Getting Help over the telephone from a Nortel Solutions Center9
Getting Help from a specialist using an Express Routing Code10
Getting Help through a Nortel distributor or reseller10
Introduction to this guide11
Subject11
Intended audience11
Acronyms11
Related publications13
Overview15
Introduction15
Supported SIP proxy servers 20
3
Revision history7
SIP overview15
IP Phone 1140E with SIP Firmware 15
Related documentation 16
Installation overview 17
Before installation21
Introduction 21
Preinstallation 21
Configure the provisioning server25
How provisioning works25
Download the SIP Firmware to the provisioning server 26
Create the SIP provisioning file on the provisioning server 26
Create the device configuration file on the provisioning server 31
Device configuration commands 34
Create the Dialing Plan file on the provisioning server 50
Dialing function description 52
Downloadable WAV files56
SIP Firmware Release 1.1 for IP Phone 1140E Administration
For a detailed history of past releases of this document, see "Revision
history" (page 7).
Revision history
May 2008
Standard 02.05. This document is up-issued to reflect changes in technical
content.
February 2008
Standard 02.04. This document is up-issued to include editing changes.
November 2007
Standard 02.03. This document is up-issued to reflect changes in the
technical information in response to change requests. A note was added
stating that NAT_SIGNALLING is required for networks that use STUN
or SIP_PING for NAT traversal. The commands FORCE_OCT_END
and OCT_END were changed to FORCE_OCT_ENDDIAL and
DISABLE_OCT_ENDDIAL respectively.
7
October 2007
Standard 02.02. This document is up-issued to ensure that the value of
802.1P_MEDIA parameter in the QoS and ToS commands must be set to
-1 to be able to have a voice path.
July 2007
Standard 02.01. This document is up-issued to support SIP Firmware for IP
Phone 1140E Maintenance Release 1.1.
March 2007
Standard 01.02. This document is up-issued to incorporate an addition to
the Maintenance and Troubleshooting section.
January 2007
Standard 01.01. This is a new document created to support the IP Phone
1140E with SIP Firmware.
SIP Firmware Release 1.1 for IP Phone 1140E Administration
This section explains how to get help for Nortel products and services.
Getting Help from the Nortel Web site
The best way to technical support for Nortel products is from the Nortel
Technical support Web site:
ww.nortel.com/support
w
This site provides quick access to software, documentation, bulletins, and
tools to address issues with Nortel products. More specifically, the site
enables you to:
•
download software, documentation, and product bulletins
•
search the Technical Support Web site and the Nortel Knowledge Base
for answers to technical issues
•sign up for automatic notification of new software and documentation
for Nortel equipment
9
•
open and manage technical support cases
Getting Help over the telephone from a Nortel Solutions Center
If you do not find the information you require on the Nortel Technical Support
Web site, and have a Nortel support contract, you can also get help over the
telephone from a Nortel Solutions Center.
In North America, call 1-800-4Nortel (1-800-466-7835).
Outside North America, go to the following Web site to obtain the telephone
number for your region:
ww.nortel.com/callus
w
SIP Firmware Release 1.1 for IP Phone 1140E Administration
Getting Help from a specialist using an Express Routing Code
To access some Nortel Technical Solutions Centers, you can use an
Express Routing Code (ERC) to quickly route your call to a specialist in your
Nortel product or service. To locate the ERC for your product or service, go
ww.nortel.com/erc
to w
Getting Help through a Nortel distributor or reseller
If you purchased a service contract for your Nortel product from a distributor
or reseller, contact the technical support staff for that distributor or reseller.
SIP Firmware Release 1.1 for IP Phone 1140E Administration
SIP Firmware Release 1.1 for IP Phone 1140E Administration
(NN43113-300) describes how to install, configure, and provision the IP
Phone 1140E for use on a SIP network.
Intended audience
This administration guide is intended for system administrators of the
Nortel IP Phone 1140E with a basic understanding of SIP. This guide is not
intended for end users of the IP Phone 1140E. Many of the tasks outlined in
the guide influence the function of the IP Phone 1140E on the network and
require an understanding of telephony and Internet Protocol (IP) networking.
Acronyms
This guide uses the following acronyms:
Table 1
Acronyms used
11
AAAAuthentication, Authorization, and Accounting
ALGApplication Layer Gateway
DHCPDynamic Host Configuration Protocol
DNSDomain Name System
DRegexDigit Regular Expression
DSCPDifferentiated Services Code Point
EAPExtensible Authentication Protocol
EREExtended Regular Expressions
FQDNFully Qualified Domain Name
FTPFile Transfer Protocol
GARPGratuitous Address Resolution Protocol
GUIGraphical User Interface
HTTPHyper Text Transfer Protocol
SIP Firmware Release 1.1 for IP Phone 1140E Administration
IETFInternet Engineering Task Force
ISDNIntegrated Services Digital Network
IMInstant Message
IPInternet Protocol
IPCMInternet Protocol Client Manager
ITU-TTelecommunications Standardization sector of the International
Telecommunications Union
LANLocal Area Network
MACMedia Access Control
MADNMultiple Appearance Directory Number
MASMedia Application Server
NATNetwork Address Translator
NetConfigConfiguration screens available after an IP Phone resets
NDUNetwork Diagnostic Utility
PDTProblem Determination Tool
PECProduct Engineering Code
POEPower Over Ethernet
POSIXPortable Operating System Interface
PRACKProvisional Acknowledgement
PSTNPublic Switched Telephone Network
PVQMonProactive Voice Quality Monitoring
QoSQuality of Service
RADIUSRemote Authentication Dial In User Service
RTCPReal-time Control Protocol
RTCP XRRTP Control Protocol Extended Reports
RTPReal-time Transfer Protocol
SCASingle Call Arrangement
SDPSession Description Protocol
SIMPLESIP for Instant Messaging and Presence Leveraging Extensions
SIPSession Initiation Protocol
SMTPSimple Mail Transfer Protocol
STUNSimple Traversal of UDP through NAT devices
TFTPTrivial File Transport Protocol
TPSTerminal Proxy Server
TTLTime-to-live
SIP Firmware Release 1.1 for IP Phone 1140E Administration
UDPUser Datagram Protocol
UFTPUNIStim File Transfer Protocol
UNIStimUnified Network IP Stimulus Protocol
VoIPVoice over IP
VLAN IDVirtual Local Area Network Identification
VLAN IPVirtual Local Area Network Internet Protocol
VQMonVoice Quality Monitoring
Related publications
Other publications related to the SIP Firmware Release 1.1 for IP Phone
1140E Administration are:
•
SIP Firmware Release 1.1 for IP Phone 1140E Quick Reference Card
(NN43113-102)
•
SIP Firmware Release 1.1 for IP Phone 1140E User Guide
(NN43113-101)
Related publications 13
•
Nortel IP Phone 1100 Series product bulletins on w
port.
ww.nortel.com/sup-
SIP Firmware Release 1.1 for IP Phone 1140E Administration
This chapter describes the hardware and firmware features of the Nortel IP
Phone 1140E and provides a brief overview of Session Initiation Protocol
(SIP).
SIP overview
Session Initiation Protocol (SIP) is a signaling protocol used for establishing
multimedia sessions in an Internet Protocol (IP) network.
SIP is a text-based protocol similar to HTTP and SMTP. With the introduction
of SIP to IP Phones, telephony integrates easily with other Internet services.
SIP allows the convergence of voice and multimedia.
IP Phone 1140E with SIP Firmware
The IP Phone 1140E connects to an IP network using an Ethernet
connection. All voice and signaling information is converted into IP packets
and sent across the network.
15
The IP Phone 1140E can be ordered with UNIStim Firmware installed or
with SIP Firmware installed. UNIStim Firmware and SIP Firmware use the
same hardware, but the model number of an IP Phone 1140E with UNIStim
Firmware is different from the model number of an IP Phone 1140E with
SIP Firmware.
If you have an IP Phone 1140E with UNIStim Firmware, you can convert the
firmware to SIP Firmware. The most recent version of SIP Firmware can be
obtained from Nortel and installed on the IP Phone 1140E.
This guide explains how to:
•
configure the provisioning server and the DHCP server. Note: The
provisioning server is where the firmware and the configuration files for
the IP Phone 1140E reside. This is not the IP Client Manager (IPCM) of
the call server.
•
convert an IP Phone 1140E with UNIStim Firmware to an IP Phone
1140E with SIP Firmware
SIP Firmware Release 1.1 for IP Phone 1140E Administration
provision the Device Settings parameters on the IP Phone 1140E with
SIP Firmware
Note: Converting the firmware on an IP Phone 1140E from UNIStim
Firmware to SIP Firmware overwrites the UNIStim Firmware. The IP Phone
1140E cannot operate in both modes simultaneously. A switch from UNIStim
to SIP Firmware or SIP to UNIStim Firmware requires a firmware reload.
The following figure shows the main components of the IP Phone 1140E
with SIP Firmware.
Figure 1
IP Phone 1140E with SIP Firmware
Related documentation
The SIP Firmware Release 1.1 for IP Phone 1140E User Guide
(NN43113-101) tells the end user how to use the IP Phone 1140E, including
how to:
•
use the Context-sensitive soft keys and Navigation key cluster
•
enter text
•
use the address book
•
access and use the call inbox and call outbox
•
configure and use instant messaging
•
receive, identify, answer, redirect, decline, or ignore an incoming call
•
operate hold, three-way calling, call transfer, and call park
•
use other features such as speed dial, call forward, do not disturb, and
setting up conference calls
SIP Firmware Release 1.1 for IP Phone 1140E Administration
configure Bluetooth headset operation (IP Phone 1140E only)
Note: All features are not available with all call servers.
The IP Phone 1140E Getting Started Card included in the box with the IP
Phone 1140E also contains useful information and explains how to:
•
connect the AC power adapter
•
control the volume when answering a call
•
make a call using the handset
•
make a call with the headset or using handsfree
•
use hold and mute
•
set the contrast
•
set the language
Installation overview
To install the IP Phone 1140E with SIP Firmware, three basic steps are
required.
Introduction 17
Procedure 1
Installation overview
StepAction
1
Configure the provisioning server and, optionally, the DHCP server.
The function of the provisioning server is to provide configuration
options to every IP Phone 1140E throughout the network. TheDHCP
server can be configured to provide basic network-configuration data
or a more comprehensive set of network-configuration data for the
IP Phone 1140E with SIP Firmware.
2
3
Load SIP Firmware on the IP Phone 1140E.
Configure the initial network-configuration parameters on the IP
Phone 1140E with SIP Firmware.
—End—
SIP Firmware Release 1.1 for IP Phone 1140E Administration
SIP Firmware Release 1.1 for IP Phone 1140E Administration
NN43113-300 02.05 Standard
27 May 2008
22 Before installation
Footstand kit, CharcoalNTYS11AA70
Telephone number label and lens kitNTYS12AA
2.3 m (7 ft) CAT5 Ethernet cableNTYS13AA
The IP Phone 1140E can be powered either by Power Over Ethernet
(POE) or powered through an external power supply. Order the
external power supply separately.
Table 3
1100 series phones separably orderable parts
Item
Power adapter contents include:
Global power supply (optional)N0023000
AC cord package includes one of the following:
1.8 m (5.9 ft), 10 amp, IEC320-C13 North
America
3 m (9.9 ft), 125 VAC 13 amp, NA power cord,
NEMA North America, Middle East, Taiwan,
Philippines, Thailand, and Japan
2.4 m (8 ft), 240 VAC 10 amp, ANZ power cord
AS-3, Australia, New Zealand
250 VAC, Option 11C Standard European power
cord, Other EMEA, Kenya, Korea, Thailand,
Indonesia, Vietnam, India, Pakistan
3 m (9.9 ft) 125 VAC, Option 11C Swiss power
cord Switzerland
240 VAC, Option 11C UK power cord Hong
Kong, Ireland, United Kingdom, Singapore,
Malaysia, Bangladesh, Brunei, Sri Lanka
3 m (9.9 ft), 125 VAC, Option 11C Denmark
power cord Denmark
Order number
NTYS14AA
NTTK14AB
NTTK15AA
NTTK16AB
NTTK17AB
NTTK18AB
NTTK22AB
4
SIP Firmware Release 1.1 for IP Phone 1140E Administration
TheIP Phone 1140E must be plugged into a10/100-BaseT
Ethernet jack. Severe damage occurs if this IP Phone
1140E is plugged into an ISDN connection.
Ensure that the location meets the network requirements:
•
a DNS server and a DHCP server with DHCP relay agents
installed, configured, and running. It is possible to run the IP
NN43113-300 02.05 Standard
27 May 2008
Preinstallation 23
Phone 1140E without these servers in MCS 5100 Release
3.5, but Nortel recommends using these servers to aid in the
deployment and configuration of the IP Phone 1140E with SIP
Firmware. Using DHCP and DNS servers with CS 2000 network
is recommended but not mandatory.
•
An Ethernet connection to a network with an appropriate SIP
proxy server.
•
One of the following file servers used as a Provisioning server:
— TFTP server
— FTP server
— HTTP server
Only a TFTP server can be used for an initial UNIStim-to-SIP
Firmware conversion. An IP Phone 1140E with SIP Firmware
can operate with a TFTP, FTP, or HTTP file server.
—End—
SIP Firmware Release 1.1 for IP Phone 1140E Administration
If you have UNIStim Firmware on your IP Phone 1140E, the firmware must be
converted from UNIStim to SIP before you proceed with the following instructions.
See the chapter "Upgrade and convert the IP Phone 1140E firmware" (page
67) for instructions on how to convert the firmware on an IP Phone 1140E from
UNIStim to SIP.
If the IP Phone 1140E is installed with SIP Firmware, further SIP Firmware
upgrades can be done with a TFTP, an FTP, or an HTTP server.
How provisioning works
Provisioning is performed without interaction with the call server. The IP
Phone 1140E with SIP Firmware connects directly with the provisioning
server in order to retrieve firmware files and configuration files. In this case,
the provisioning server is not to be confused with the IP Client manager on
the call server. The methods of provisioning are:
25
•
Automatic provisioning at power-up: After the IP Phone 1140E powers
up or is reset, it checks the provisioning server for the latest files.
•
Provisioning through user interaction: The end user can manually check
for updates by pressing the Services Context-sensitive soft key and
selecting SystemSystem . In the menu select Check for Updates.
•
Automatic provisioning at a preconfigured time: The IP Phone 1140E
with SIP Firmware checks for updates every 24 hours, at a time specified
by a parameter in the device configuration file.
The following steps are taken when provisioning updates occur. The IP
Phone 1140E with SIP Firmware:
1. connects to the provisioning server
2. retrievesthe provisioning file (1140eSIP.cfg) from the provisioning server
3. reads and acts upon the content of the provisioning file and decides
whether any other file is needed, based on a set of rules. If files need to
be downloaded to the IP Phone 1140E, a new file transfer session starts
SIP Firmware Release 1.1 for IP Phone 1140E Administration
for each file to be downloaded. The provisioning file (1140eSIP.cfg)
can contain commands that prompt for confirmation before a file is
downloaded.
Download the SIP Firmware to the provisioning server
To download the SIP Firmware, follow the steps in the next procedure.
Procedure 3
Downloading SIP Firmware for IP Phone 1140E from the Nortel Web site
StepAction
1
2
Go to w
Log on to the Nortel Web site with a valid Nortel User ID and
ww.nortel.com/support.
Password.
The Technical Support page appears.
3
4
5
Enter IP Phone 1140E in the Knowledge and Solution Engine box.
Select Software in the All types scroll down menu.
Press the gray arrow at the end of the Knowledge and Solution
Engine box to obtain the Search Results.
6
From the Search Results, select the appropriate version of the SIP
Firmware for the IP Phone 1140E, for example, SIP IP Phone 1140E
Release 0625C1HD26.bin.
7
Place the selected firmware on the provisioning server.
—End—
Create the SIP provisioning file on the provisioning server
The provisioning file is downloaded from the provisioning server to the
IP Phone 1140E every time the IP Phone 1140E checks for updates.
The provisioning file is a clear text file that has the naming convention
1140eSIP.cfg. The following is an example of a provisioning file:
SIP Firmware Release 1.1 for IP Phone 1140E Administration
[DEVICE_CONFIG]Device configuration file
[LANGUAGE]Downloadable language files (more than one can be specified in
each section)
[FW]Firmware image
[DIALING_PLAN]Dialing plan
[TONES]Downloadable tones (.wav files)
Provisioning is performed using the commands in the 1140eSIP.cfg
configuration file. The configuration file can have multiple sections.
Note: The maximum length of a line item in the configuration file is 80
characters. If a line item with more than 80 characters is encountered
when parsing the configuration file, the remaining portion of the file
following that line item will be ignored.
’#’ is used to indicate a comment. Anything preceeding a ’#’ is a
comment.
Each section in the configuration file defines rules for different file types. A
section starts with a [SECTION NAME] to specify rules for each file type.
For example: [FW].
A section is a mandatory field. Parsing of download rules for each file
type starts with finding this key word. Currently, the following sections are
supported by the IP Phone 1140E with SIP Firmware:
•
[FW] section for the firmware load download
•
[DEVICE_CONFIG] section for the device configuration
•
[DIALING_PLAN] section for the dialing plan files
•
[LANGUAGE] section for the language prompts files
•
[TONES] section for the downloadable tone files
Firmware [FW] image files originate from Nortel only and are authenticated
during firmware download. If the FW authentication fails, the IP Phone
1140E displays an error message and continues operation with the existing
FW image.
Device configuration files are used to set various parameters in the IP
Phone 1140E.
Dialing plan files are used for configuring dialing patterns and the format of
originated URIs in the SIP message.
Note: Some call servers do not yet support SIP URI dialing.
SIP Firmware Release 1.1 for IP Phone 1140E Administration
Create the SIP provisioning file on the provisioning server29
Language files are simple text files containing all text prompts used by the
IP Phone 1140E. Language files are used for the localization of the IP
Phone 1140E without firmware upgrade. Each language file has a header
that contains a firmware load version with which this file is associated.
Language files are signed by Nortel and are authenticated by the firmware
for security reasons.
Tones files are standard in the Telecommunications Standardization sector
of the International Telecommunications Union (ITU-T). The set supports
custom tone files. The tone files must be WAV files with the following
specification: A-law or u-law (8.0 kHz, 8-bit, mono or 16.0 kHz, 16 bit mono).
The WAV files can be created and downloaded to the IP Phone 1140E.
These files are not authenticated by the IP Phone 1140E.
Mandatory keywords in the Provisioning file are:
•
VERSION [xxxxxx], where xxxxxx is a six- to ten-digit number
representing the version of the file on the server. The version of the
module is specified in this field. The command is used for version
comparison in AUTO mode. VERSION is mandatory for all sections.
In the FW section, the firmware version of the load located on the
provisioning server must be entered in this field. For all other sections,
VERSION is just a counter that can be incremented if it is necessary
to download a new file version.
CAUTION
The version number is stored permanently on the IP Phone
1140E until a higher version number is downloaded or until the
version number is deleted using the Srvcs, System, EraseUser Data menu selection on the IP Phone 1140E. This
prevents a new file from being downloaded if a lower version
number is used in the Provisioning File.
•
DOWNLOAD_MODE [AUTO | FORCED] defines whether the version
is checked. This command is optional. If this command is not present,
AUTO mode is used as the default.
— AUTO - This mode compares the version of the module from the
VERSION field and the version of the module version stored in the
FLASH memory of the IP Phone 1140E. The file download is initiated
only if the version specified is higher than the current version stored
in the IP Phone 1140E. If the version is not applicable, as in the case
of language files, the date of the file must be used for the decision.
SIP Firmware Release 1.1 for IP Phone 1140E Administration
— FORCED - This mode forces the firmware download process.
FORCED can be used for firmware downgrade procedures.
Note: In FORCED or AUTO DOWNLOAD_MODE, the version
number is overwritten with each firmware download.
•
FILENAME [filename] specifies the file name to be downloaded for
this section. For the language and tone section, the use of multiple
filenames is allowed.
Optional keywords in the Provisioning file are:
•
PROMPT [YES | NO] is used to indicate if the IP Phone 1140E should
prompt the user for an update before the operation is performed. This
command is optional with the default set to NO.
CAUTION
The version number stored in the FLASH is permanent
until a higher number is downloaded from the Provisioning
file or you selectSrvcs, System, Erase User Data on the
IP Phone 1140E.
— YES - enables the prompt
— NO - disables the prompt
•
PROTOCOL [TFTP | FTP | HTTP] defines the protocol used to download
the file. The IP Phone 1140E with SIP Firmware supports TFTP, FTP
and HTTP protocols for file download. This command is optional. If it is
not present, the default protocol TFTP is used.
If using FTP or HTTP, SRV_USER_NAME and SRV_USER_PASS are
also key words. These commands specify the credential used to login
to the file server for file download. If not present, the protocol default
credential is used (no credential for TFTP and HTTP and anonymous
with no password for FTP).
•
SERVER_IP [address] allows the IP Phone 1140E to connect to the
specified IP address or name of the server for which the file can be
downloaded. If the address is not specified, the SERVER_IP that is used
is the same SERVER_IP that is used to download the provisioning file.
•DELETE_FILES [YES | NO], if present, erases the language and tone
files stored in the IP Phone 1140E before new files are downloaded.
Otherwise, new files with different names are added without erasing
existing files. This command is optional. Note that there is a hard limit
of 5 language files and 5 tone files that can be stored in the IP Phone
SIP Firmware Release 1.1 for IP Phone 1140E Administration