Avaya SIP Software 3.1 for 1100 Series Manuel d'utilisateur

SIP Software for Avaya 1100 Series IPDeskphones-AdministrationSIP 4.1NN43170-600, 03.12November 2012

E911_TERMINATE_ENABLEWhen enabled, the device configuration file command E911_TERMINATE_ENABLE allows acaller who placed an emergency 911 call to term

Configure the provisioning server100 SIP Software for Avaya 1100 Series IP Deskphones-Administration November 2012Comments? [email protected]

Chapter 7: Configure the DHCP ServerThe DHCP server requires special configuration in Full DHCP mode. The IP Deskphone with SIP Softwareobtains Devic

The unique DHCP configuration is required to allow the DHCP server to respond with a uniqueOption 66 parameter to the IP Deskphone with SIP Software.

Parameter requested by theIP DeskphoneDescription DHCP server optionDNS domain Implementation variesaccording to DHCP server.15Lease time Implementati

as part of each DHCPOFFER and DHCPACK message for the IP Deskphone to accept thesemessages as valid; 43, 128, 131, 144, 157, 188, 191, 205, 219, 223,

Chapter 8: Install the IP DeskphoneComplete instructions to install the IP Deskphone, including detailed figures and applicable warnings, aregiven in

tilt lever and continue to push the IP Deskphone towards the base until an audible click isheard. Ensure the IP Deskphone is securely locked in posi

Chapter 9: Upgrade and convert theIP Deskphone softwareThis chapter describes how to upgrade an IP Deskphone with UNIStim software to SIP Software.n

Modify the SIP provisioning fileUse the following procedure to modify the SIP provisioning file, which exists on the provisioningserver.Modifying the

Identify the current version of UNIStim softwareChecking the UNIStim software version on a new IP Deskphone1. After assembling the IP Deskphone and tu

May 2011 Standard 03.02. This document is up-issued to reflect changesin technical content for:•AUTOLOGIN_ID_KEY parameters• roaming profiles and netw

to scroll through the menu items. Press the Select key to select the highlightedmenu item.Table 8: Using the Navigation key cluster to navigate in the

1. UFTP download initiated by the server if the server supports this method ofupgrading UNIStim software. Refer to the appropriate documentation for y

This can be the provisioning server as defined in the chapter Configure theprovisioning server on page 27.5. Select the Apply&Reset context-sensit

The IP Deskphone downloads the software file. The display shows [FW]reading…If the download is successful, the display shows [FW] writing… and the blu

4. Press the red arrow at the end of the TheInSite Knowledge Base box to obtain theSearch Results.5. From the Search Results, select the appropriate v

Convert SIP Software to UNIStim SoftwareThe IP Deskphone can be ordered with UNIStim software installed or with SIP softwareinstalled. If you have an

where xxx is the UNIStim version number appropriate for the hardware release ofyour IP Deskphone, for example, 0625C23, and yyy.bin is the filename co

Chapter 10: Provisioning the IPDeskphonesThe IP Deskphones support the following provisioning modes:• Manual provisioning• Automatic provisioningManu

ConfigurationYou can store common provisioning parameters in a managed central server, such as a DHCP,TFTP, or HTTP server. You can configure the IP D

Configuring parameters manually for the IP DeskphoneProcedure1.Press Auto on the Configuration page to switch to the Auto Provisioning page.2. Perform

New in this release12 SIP Software for Avaya 1100 Series IP Deskphones-Administration November 2012Comments? [email protected]

3. To exit and save, press the Config key to return to the Device Settings page, thenpress Apply.Auto Provisioning parametersUse the keys in the follo

Voice Control pBits []Voice Media pBits []DSCP []Avaya Auto QoS []Enable PC Port []PC Port Speed []Data VLAN []Data Priority bits []PC-Port Untag all

Key DescriptionEnter Highlight on list item: open list In list: selecthighlighted item and close list Highlight oneditable item: start edit mode Highl

option and applies only to that option. If boththe prompt and the option havedependencies, they are cumulative betweenthe prompt and the option and is

Config option Options or input Description Note:Maximum of 2 DNS IPaddresses can beconfigured.DNS IP2 IP address DNS server 2 IPv4 and IPv6IP address.

Config option Options or input Description• DHCP—VLAN ID fromDHCP Auto VLAN• LLDP VLAN Name—VLANID from LLDP VLAN NameTLV• LLDP MED—VLAN IDfrom Networ

Config option Options or input DescriptionForce Half Forced half duplex.Enable Data 802.1Q Checked 802.1Q header and featuresused.Unchecked 802.1Q not

Config option Options or input Description• HTTP•HTTPSDevice ID ID used by provisioningserver to authenticate the IPDeskphone. Enter the UserID as the

Config option Options or input Description• AES_128_SHA1_80•AES_128_SHA1 32SIP UDP Port Integer Value from 1024 to 65535.SIP TCP Port Integer Value fr

Chapter 11: FeaturesThis section describes the features that are supported on the IP Deskphone.Voice Quality MonitoringFeature overviewProactive Voic

Chapter 2: Customer serviceVisit the Avaya Web site to access the complete range of services and support that Avaya provides. Goto http://www.avaya.c

Server set-upThe IP Deskphone with SIP Software works with Telchemy server software. The name of thesoftware is SQmediator and is available through Te

Metric DescriptionMIU Media Information Unit. MIU is a conceptfrom VQMon. An MIU can be any size downto a 10 millisecond (8 sample) block. An MIUmeans

MultiuserThe Multiuser feature allows multiple SIP user accounts to be in use on the IP Deskphone atthe same time. Multiple users, each with their own

ConfigurationDepending on server policy, the Multiuser feature can require you to configure thePROMPT_AUTHNAME_ENABLE value to YES in the device confi

is registered as the secondary account (not the primary account), the IP Deskphone uses theconfigurations of the primary account. The IP Deskphone kee

the IP Deskphone is switched off, the IP Deskphone automatically logs all users back onwhen you restart the IP Deskphone.• AUTOLOGIN_ENABLE USE_AUTOLO

If you restart the IP Deskphone after you logged off the primary account, the logon screenappears on the IP Deskphone. Logging on a new primary accoun

Line keysEach registered user is associated to a separate line key. Each line key displays the name ofthe registered account and some basic state info

• Missed incoming calls and new voice mail messages for the account are indicated withan icon. The icon supplements the NN missed calls message on the

The active call is affected by operations such as transfer or call parking. One exception is theNew Call action which uses the primary account by defa

Getting technical support from the Avaya Web siteThe easiest and most effective way to get technical support for Avaya products is from theAvaya Techn

Instant messagesYou can only receive or send instant messages from the primary account. Incoming messagesfor secondary accounts are rejected, are not

modifications do not take effect until you register the secondary account as the primaryaccount.Voice Mail settingsVoice Mail Settings is located in t

Important:The Speed Dial keys always use the primary account to determine the presence state of thetarget.The Instant Message keys always use the pri

Accessing the Address Books, by pressing the Directory hard key from the Idle screen, displaysthe address book of the primary account. If the primary

The following scenarios apply to DND.• If you select a single account that is in DND mode, the IP Deskphone displays a promptthat asks if you want to

After you press a single account Call Forward programmed key:• If the account is already forwarding calls to the programmed target, call forwarding is

After you press the all accounts Presence programmed key:• If all accounts are already set to the programmed presence state, all accounts are set toth

Account selectionThere are a number of scenarios where you are prompted to select an account (for example,logoff, per-account settings, programming ke

on one TN and register from the IP Deskphone to each configured key. This applies to systemsusing Meridian Communications Adapter (MCA) – Multiple App

• Telephones with a Privacy Override Allowed (POA) Class of Service can bridge into anestablished call on an SCA MADN. However, you cannot bridge into

Chapter 3: Introduction to this guideSubjectSIP Software for Avaya 1100 Series IP Deskphones — Administration, NN43170-600describes how to install, c

The MADN SCA feature for CS 1000 requires you to configurePROMPT_AUTHNAME_ENABLE to YES in the device configuration file. This prompts the enduser to

Vertical servicesVertical services are CS 2000 and CS 2100 features that can be activated or deactivated bydialing a defined code, for example, Privac

SlideshowScreensaver images that have been uploaded to the IP Deskphone can be displayed in aslideshow format.It is possible to display all of the scr

Animated screensaver for the Avaya 1165E IP DeskphoneSeveral images can be loaded and quickly displayed, one after the other on the Avaya 1165EIP Desk

The contents of the Speed Dial List can vary (context-sensitive) based on the current call stateof the IP Deskphone and the type of Speed Dial List en

Figure 21: Main feature key programming screen showing Speed Dial List provisioned on key 6A feature key provisioned for use as a Speed Dial List has

The following table describes the function of the context-sensitive soft keys for the Speed DialList screen.Table 17: Context-sensitive soft keys for

If the auto retrieve behavior is enabled on a Speed Dial key (programmed keys) or Speed DialList entry that is invoked, and a call is placed on hold t

Roaming profilesRoaming profiles enable the user to obtain the same settings when they are logged on tomultiple IP Deskphones for features such as Add

Address book fileThe Address book file represents each contact [contact] and each group [group] (name only).A contact provides attributes to specify n

DCP Device Certificate ProfileDET Distinguished Encoding RulesDHCP Dynamic Host Configuration ProtocolDN Distinguished NameDND Do Not Disturb featureD

• target – for cfwd, spdial, im keys. The SIP address to target when the key is pressed. Thisis a mandatory attribute for spdial and im. Omitting this

Roaming profile limitationsRoaming profiles have the following limitations:•Changes made on the IP Deskphone cannot be uploaded to the Call Server.• T

appears only for the primary user of the IP Deskphone. In a multiuser configuration, asecondary user logon does not cause the banner to appear, even i

Table 21: Outside actions on contentKey or action ResultInbox No action.Outbox No action.Directory (Address book) No action.Goodbye No action.Expand (

The banner text file is a separate file downloaded by provisioning. The banner text file isspecified much like the current dialing plan is specified (

The IP Deskphones support the following USB devices:•USB memory stick• USB headsetsFor corporate security purposes, you can disable the supported USB

Note:The parameters affect the configurations of all the IP Deskphones.Table 22: USB Port lock device configuration parametersCommands Parameters Rem

Figure 26: USB Devices information screen — USB Port disabledIf the USB Port is enabled, the USB Devices screen displays information on all USB device

USB lockAlthough the USB port allows the IP Deskphone to extend peripheral support without hardwarechanges, the customer is required to lock the USB p

Table 23: USB Locks screen optionsUSB Locks options DescriptionUSB Locks Override• Enables or disables the USB lockconfigurations from the deviceconfi

MAC Media Access ControlMADN Multiple Appearance Directory NumberMAS Media Application ServerMD5 Message Digest v5MLLP Multi-Level Precedence and Pre-

Important:Although a locked USB device is not functional, it still appears in the USB menu.The following table describes the function of the Context-

USB flash driveSIP Software supports a standard USB flash drive for the IP Deskphone.File system support is restricted to FAT file system with a long

Hotline service restrictionsBecause the Hotline Phone is a dedicated IP Deskphone used only for Hotline service, certainfeatures are restricted on the

Table 25: Hotline Service configuration parametersParameter name Description DefaultHOTLINE_ENABLE Indicates if Hotline Service isenabled or disabled.

endpoint performs the refresh. The session interval is the maximum amount of time that occursbetween session refresh requests in a dialog box before t

Parameter name Description Default valueSET_REQ_REFRESHER Indicates what refresher value isconfigured in the initial sessionrequest. Value 0 indicates

the location information based on the number and location databases. Characteristics ofemergency calls and limitations of emergency calls using the IP

The following is an example of an emergency flag in the dialing plan: 911|911# &&sip:[email protected] && t=1000|emergencyThis feature req

Configuration requirements for making an emergency call whenthere are no users logged on1.Configuring the SIP Proxy.• The IP Deskphone must have an em

• The proxy must be able to transmit mixed MIME-types (for successfultransferring of the location information).5. Configuring the proxy with emergency

SIP Session Initiation ProtocolSKS Special Key SequenceSMTP Simple Mail Transfer ProtocolSOAP Simple Object Access ProtocolSRTCP Secure Real-time Tran

If a device is behind a NAT, transport addresses obtained are not publicly routable, andtherefore, not useful in a number of multimedia applications.

Three-port switch and VLAN functionalitySystem overviewThe Full VLAN support feature can create telephone Voice-VLAN and PC Data-VLAN on thethree-port

Figure 30: Voice-VLAN and Data VLANTable 28: Port functions on the three-port switch when VLAN is enabledPorts Voice VLANenabledData VLAN enabled Both

Ports Voice VLANenabledData VLAN enabled Both Voice and Data VLANenabledReplacing the incomingframe tagged withVLAN other than Data-VLAN and forwardin

• When EAP-TLS is selected, the administrator is prompted to enter ID1.•When Disabled mode is selected, the existing IDs and Passwords are erased.Auth

802.1ab Link Layer Discovery Protocol (LLDP) provides the following functionality:•Periodic transmission of advertisements containing device informati

19. Inventory Software Revision20.Inventory Manufacturer Name21. Inventory Model NameReceive directionThe IP Deskphone expects to receive the followin

TLV FieldsIf you disable the PC Ethernet port, the advertised enabled capabilitiesconfigured to Telephone only.Port VLAN ID PVID = 0The IP Deskphone d

TLV FieldsBit 3 = 0 – PSE pair selection can not be controlledPSE power pair = 1Power Class = 3 for 1120E/1140E/1165E IP DeskphonesLink Aggregation Ag

TLV FieldsModel Name Contains a string, which specifies the IP Deskphone model, forexample, “IP Deskphone xxx”, where, xxx is one of the following val

Chapter 4: OverviewIntroductionThis chapter describes the hardware and software features of the Avaya 1100 Series IPDeskphones and provides a brief o

Answer-Mode Settings screenThe Answer-Mode Settings screen is used to pre-grant authorization to request an automaticanswer to potential callers or gr

The following screen appears.Figure 32: Allow-Mode Settings screenAllow Addresses screenThe Allow Addresses screen is used to pre-grant authorization

The user can add as many entries as the device configuration allows. If the Add soft key isdisabled, then the user has reached the maximum number or e

A "ring splash", or short ring tone, indicates to the user that the call was automaticallyanswered. The subject is "Auto-Answered"

server. For information on configuring the MLPP service, see Avaya Aura™ Application Server5300 Using the Provisioning Client (NN42040-112).To enable

The following is the order of call preemption:1.The lowest precedence call2. If there are multiple calls on the same precedence level, then the follow

. To answer any call except from Emergency 911, the user must go off-hook.MLPP tonesUnique tones are played when MLPP is enabled.Precedence Ringback T

Feature Interaction with MLPPDo Not Disturb Incoming call with a Routine precedence level isrejected when Do Not Disturb is enabled on the IPDeskphone

Parameter Description DefaultMLPP_PRECEDENCE_DOMAIN[x]The local precedence domain of theuser to be added to the INVITEmessage of outgoing calls.000000

Chapter 12: IP Deskphone restrictionsService package restrictionsA limited number of Call Servers support the service package. The service package is

© 2011 Avaya Inc.All Rights Reserved.NoticeWhile reasonable efforts have been made to ensure that theinformation in this document is complete and accu

Figure 1: Avaya 1165E IP Deskphone with SIP SoftwareSIP overviewSession Initiation Protocol (SIP) is a signaling protocol used for establishing multim

IP Deskphone restrictions200 SIP Software for Avaya 1100 Series IP Deskphones-Administration November 2012Comments? [email protected]

Chapter 13: SecurityThis section specifies the behavior of the following security features:•SIP over TLS• Connection persistence• SRTP• SFTP• SSHSIP

are tried periodically based on random, but increasing time periods, in order to give the serveradequate time to recover.SSH and secure file transferT

Parameter Description Default value BoundariesPassword The passwordthat must beentered whenconnecting tothe IPDeskphonethrough SSH,SFTP.None Non-null

How the IP Deskphone uses TLSTransport Level Security (TLS) is a protocol for establishing a secure connection between twoend-points. After a connecti

Certificate requirementsFor the IP Deskphone to validate that the server certificate provided by the TLS-enabled proxymatches the connected address, t

Parameter Purpose Default AllowedSIP_UDP_PORTSIP_TCP_PORTSIP_TLS_PORTConfigures thelocal SIP listeningports. After youchange thelistening portsparamet

Parameter Purpose Default AllowedSSH Configuration ofthe SSH serveron the IPDeskphone. Theparameter mustremain consistentwith the currentUNIStim desig

Parameter Purpose Default Allowedon the IPDeskphone.HASH_ALGORITHM Hash algorithm. SHA1 SHA1MD5MKI_ENABLE Use Master KeyIdentifier (MKI) ornot.NO YESN

Note:Note 1: The SFTP file read and write pattern entries must be strictly followed.The following are examples of valid and invalid formats of SRTP r

Related documentationThe Avaya 1100 Series IP Deskphones with SIP Software User Guides explains how to do thefollowing:• use the context-sensitive sof

Note:Disabling the local administration user interface drastically reduces the ability to view or editthe configuration of the IP Deskphone, and almo

Using the TLS to connect to the SIP proxyThe IP Deskphone can establish a connection with the proxy after the appropriateconfigurations are made for t

Configuration Result Idle Screen Security IconDisplayNo – if fall back to TCPoccursUDP + TCP + TLS Connection is establishedusing TCP or TLS, potentia

ConfigurationDescription Expected result Possible resultsUDP +TCP +TLSbefore attempting toreconnect.IPDeskphone: TCPonlyServer:UDP +TCP +TLSThe IP Des

ConfigurationDescription Expected result Possible resultsTCP +TLSDeskphone attempts toconnect using UDP. Ifattempts using TLS,TCP, and UDP fail, the I

When using UDP, an IP Deskphone behind a firewall must periodically send a request to theserver to maintain an open pinhole in the firewall so that th

ParameternameDescription DefaultvalueBoundariesRegisterRetryWhen a connection failureoccurs, this value inseconds is how long theIP Deskphone waitsbef

Table 34: SRTP propertiesParameter AES_CM_128_HMAC_SHA1_80AES_CM_128_HMAC_SHA1_32Master keylength128 bits 128 bitsMaster saltlength112 bits 112 bitsSR

Available SRTP configurations are provided in the following table.Table 35: Configuration effects on media security displayConfiguration Result Media

The security icon indicates the security status of a call, and is useful for best-effortenvironments where there is a possibility of an unsecured call

Installation overviewTo install the Avaya 1100 Series IP Deskphones with SIP Software, three basic steps arerequired.1. Configure the provisioning ser

Figure 40: Basic login notificationThe following notification appears on the display screen when the user successfully logs onwhen Login Notify with T

Figure 42: Login failure notificationThe following notification appears on the display screen to notify the user of the date and timeof the last unsuc

Figure 44: Login and login failure notificationThe following notification appears on the display screen to notify the user of the date and timeof the

stored on the IP Deskphone is not accepted. After this time, the administrative password mustbe changed in the administrative server. Password expiry

Security224 SIP Software for Avaya 1100 Series IP Deskphones-Administration November 2012Comments? [email protected]

Chapter 14: Audio codecsThe optional audio codecs feature allows you to select the audio compression or decompression algorithm(codec) used on the IP

Table 37: Static payload types and other parameters for the supported codecs for the IP DeskphoneCodec PayloadtypeSDPencodingnameClock rate(HZ)Bit rat

The list of codecs specified in the Device Configuration file determines the list of codecs thatare available for selection on the IP Deskphone.Two fi

Codec preference selection on the IP DeskphoneThe Audio Quality Settings screen on the IP Deskphone allows the user to select an exactcodec by name. T

Supported by the IPDeskphoneOrdered list ofcodecs provided byDeviceConfigurationOrdered list ofcodecs provided byuser configurationOrdered list ofcode

Figure 2: Installation of IP Deskphones with SIP Software, page 1 of 2Installation overviewSIP Software for Avaya 1100 Series IP Deskphones-Administra

Audio codecs230 SIP Software for Avaya 1100 Series IP Deskphones-Administration November 2012Comments? [email protected]

Chapter 15: Certificate-basedauthenticationCertificate-based authenticationCertificate-based authentication allows the administrator to ensure that t

mark events, such as Certificate Addition and Deletion. The administrator is to view securityand error logs from the user interface, as well.The admin

must be installed on the IP Deskphone and stored in the IP Deskphone trusted store for thefollowing reasons:• to verify the identity of the various se

- Note:In the descriptions above, there is reference to the certificate file containing asingle customer root certificate. While this is the most comm

The following sections describe the process used to install a device certificate on the IPDeskphone.•PKCS#12 is an industry standard for importing and

• PROFILE attribute must be 1. The certificate profile index identifies the filename where the profile is stored in the IP Deskphone memory (SFS), and

The use of the CTL is optional. If the CTL is not installed on the IP Deskphone, theauthentication of the network element reverts back to the default

- a remote certificate is presented to the IP Deskphone- the CTL is expired; the CTL is deleted and an event is logged in thesecurity log.4. After the

PROTOCOL HTTPSFILENAME ctl.pem.sigThe filename attribute points to the signed CTL file. Note:The CTL file size must not exceed 20 KbytesCertificate Tr

Figure 3: Installation of IP Deskphones with SIP Software, page 2 of 2Overview24 SIP Software for Avaya 1100 Series IP Deskphones-Administration

After the Security Policy file is enabled, access the Certificate Administration screenfrom the Network screen5. Select. Device Settings > Diagnost

Table 40: Context-sensitive soft keys for the Certificates Administration screenContext-sensitive soft key ActionSelect Selects the required option.Ba

Context-sensitive soft key ActionBack Returns you to the previous screen.Figure 49: Trusted Certificates detailsThe administrator can delete the certi

Figure 50: Device Certificates screenThe administrator can delete the certificate in the details screen by using the Delete context-sensitive soft key

The administrator can delete the certificate in the "Detailed Mode" by using the Delete context-sensitive soft key. Deletion does not happen

Figure 53: CTL Certificate details screenYou can use the PDT shell command to view an installed CTL.The following is an example of a command with the

SECURITY_LOG_UI_ENABLE NOKEY_SIZE 1024KEY_ALGORITHM KEY_ALG_RSATLS_CIPHER RSA_WITH _AES_256_CBC_SHASecurity policy parametersThe security policy file

TLS_CIPHER This parameter is the preferred TLS Cipherused for HTTPS to configure a stronger cipherpreference when available. The acceptablevalues are

certificates, then you are prompted with aFinger Print display with accept or rejectoptions (default).-VAL_MANUAL_B – If the resource file is notsigne

SECURITY_POLICY_PARAM_CHANGE This Parameter defines if configuration files(11xxeSIP.cfg) are forced to be signed if there isa customer certificate ins

Chapter 5: Before installationIntroductionThis chapter features a checklist of tasks you must complete before you install SIP Softwareon the Avaya 11

If the authentication of the file is successful, the security policy file parameters isaccepted on the IP Deskphone.Example[SEC_POLICY]DOWNLOAD_MODE F

SUBJ_ALT_NAME_CHECK_ENABLE = NOFTP_PASSWORD = ****EAP AuthenticationEAP-enabled networks allow the administrator to ensure that individual devices or

Figure 56: EAP configuration menuThe administrator can do the following:•When MD5 is selected, the administrator is prompted to enter ID1 and Password

EAP DisabledEAP disabled is the factory default setting. The IP Deskphone does not send a message tothe authenticator upon startup, and normal network

For more information, seeTrusted Root certificate on page 232.If the IP Deskphone fails to authenticate to the RADIUS server or to install the require

Server authenticationA server certificate, user name, and password are required to establish TLS connectionbetween the IP Deskphone and the provisioni

Security and error logsYou can access the Security Log and the Error Log to view errors and failures that may haveoccurred during the operation of the

Table 46: Context-sensitive soft keys for the log item screenContext-sensitive soft key ActionNext Navigates to the next log entry.Prev Navigates to t

SLC_SERVICE_PROVIDER_DELETED 0x0014SLC_CTL_DELETED 0x0015 SLC_CRL_DELETED 0x0016SLC_DEVICE_CERTIFICATE_DELETED 0x0017SLC_DEVICE_CERTIFICATE_REVOKED 0x

Creating a signing certificateAbout this taskYou can create a signing certificate using OpenSSL.Procedure1. Add the following section to the openssl.c

Table 2: External power supply parts list (order separately)CPC code PEC code Product descriptionNTYS17xxE6 IP Deskphone Global Power Supply (2000 ser

phone or there must be a certificate chain that can be followed, which ends with a CA rootcertificate installed on the IP Deskphone. In either case, t

You should sign the file in a secure environment because the signing certificate private keymust be accessible. If the private key is password-protect

Certificate-based authentication262 SIP Software for Avaya 1100 Series IP Deskphones-Administration November 2012Comments? [email protected]

Chapter 16: LicensingA license is a "right to use" granted by Avaya, that the customer purchases to enable the features on theIP Deskphone.

Accessing the Keycode Retrieval SystemThe Keycode Retrieval System (KRS) User Guide provides important IP Deskphone licensing information.You must reg

Characteristics of the licensing frameworkThe following list describes the characteristics of the licensing framework on the IPDeskphone.•The embedded

For more information about provisioning parameters for the IP Deskphone, see Create the SIP provisioning file on the provisioning server on page 28.2.

Deskphone, see Create the SIP provisioning file on the provisioning server onpage 28.2. The IP Deskphone config file must include a [LICENSING] sectio

Field name Field value DescriptionFILENAME X*.Y License filename. The IPDeskphone looks for a filewith the IP Deskphone MACaddress included in thefile

Figure 59: License InfoLicensable FeaturesLicensable features are divided into three groups.1.Basic Feature Set2. Enhanced Feature Set - 1 token requi

Chapter 6: Configure the provisioningserver Important:If you have UNIStim software on your IP Deskphone, the software must be converted from UNIStim

Figure 60: Licensing menuThe Licensable Features list displays.Figure 61: Licensable FeaturesLicensing270 SIP Software for Avaya 1100 Series IP De

Node-locked license modeIn the node-locked license mode, the IP Deskphone uses a license file to acquire the requiredtokens needed to activate the fea

Figure 63: Node-locked license mode — License information for time-based token (connectedto Avaya Server)Note the extra line Tokens Required: 1. This

Figure 64: Node-locked license mode — license information for Standard token (connected tonon—Avaya Server)The following figure is an example of a nod

Figure 65: Node-locked license mode — license information for Standard token (connected toAvaya Server)The status of the standard token can be one of

Figure 66: License information — Invalid or no license fileEvaluation periodWhen the IP Deskphone arrives from the factory, it has a 31–day evaluation

AlarmsThe license feature provides notifications on the IP Deskphone screen about the licensingstatus. The license feature provides notification on th

Figure 68: License not available warningLicense expiry warningA warning window, indicating that a license has expired, appears on the IP Deskphone scr

Figure 70: Evaluation period expiry warningEvaluation threshold warningA warning window informing you of the approaching evaluation expiration date ap

Licensing expiry threshold warningWhen the expiration date of the node-locked licence approaches,, a warning window isdisplayed on the IP Deskphone. T

IP Deskphone, a new file transfer session starts for each file to be downloaded. Theprovisioning file (for example, 1165eSIP.cfg) can contain commands

• Image screensaver and lock•Standard font languages• Multiple calls per user• Server failover redundancy• Session timers• SNTP (time server)• Speed D

• DoD Network•FIPS CertifiedLicensed featuresSIP Software for Avaya 1100 Series IP Deskphones-Administration November 2012 281

Licensing282 SIP Software for Avaya 1100 Series IP Deskphones-Administration November 2012Comments? [email protected]

Chapter 17: Internet Protocol version 6Internet Protocol version 6 (IPv6) is a network layer for packet-switched internetworks and is the successorof

Table 48: Hexadecimal key sequenceKey Sequence0 01 12 2abc3 3def4 45 56 67 78 89 9* .The dot (.) is entered by pressing the asterisk (*) twice.Table 4

IPv6 address formatWhen an IPv6 address is entered different but equivalent formats can be used for the sameaddress. For example, the following addres

IPv6 Stateless address autoconfigurationThe IP Deskphone supports stateless address autoconfiguration as defined by RFC 2463 andRFC 2461.Stateless and

If the DHCPv6 server is configured with the SIP proxy IPv4–mapped address, the IPDeskphone registers with its IPv4 address. If the DHCPv6 server is co

The DHCPv6 configuration file that can be used for the IP Deskphone stateful configuration isas follows:## Example server configuration file: per-clie

{ #client with DUID 0x001365FEF48D gets this address. #DNS and SIP server addresses are assigned from the common options above address

[LANGUAGE]DOWNLOAD_MODE AUTODELETE_FILES YESVERSION 000024FILENAME French_d24langFILENAME Portuguese_d24.langFILENAME Czech_d24.langFILEN

Internet Protocol version 6290 SIP Software for Avaya 1100 Series IP Deskphones-Administration November 2012Comments? [email protected]

Chapter 18: SIP messages supported by theIP DeskphoneSIP methodsThe table below provides a list of SIP messages supported by the IP Deskphone.Table 5

Method Supported? Commentssupport of UPDATE messages is not a configurablefeature.SIP responsesThe following SIP responses are also supported:• 1xx Re

2xx Response—Successful responses2xx Response Send Receive Comments200 OK Yes Yes202 Accepted Yes Yes3xx Response—Redirection responses 3xx Response S

3xx Response Send Receive Commentsaddress in the Contact headerfield.4xx Response—Request failure responses 4xx Response Send Receive Comments400 Bad

4xx Response Send Receive Comments408 Request timeout No Yes See default handling.410 Gone No Yes See default handling.413 Request entitytoo largeNo Y

4xx Response Send Receive Commentsmaximum number of allowed callsand cannot present the incomingcall to the user. When thismessage is received by theI

6xx Response—Global responses 6xx Response Send Receive Comments600 BusyEverywhereYes YesThe IP Deskphone can send thisresponse when the IGNOREsetting

Header field Supported?Accept-Encoding YesAccept-Language YesAlert-Info YesAllow YesAllow-Events YesAuthentication-Info YesAuthorization YesCall-Id Ye

Header field Supported?Priority YesPrivacy YesProxy-Authenticate YesProxy-Require YesRAck YesReason YesRecord-Route YesRefer-To YesReferred-By YesRemo

ContentsChapter 1: New in this release...9Features...

Table 3: Provisioning file supported sections[DEVICE_CONFIG] Device configuration file[FW] Firmware image[DIALING_PLAN] Dialing plan[LANGUAGE] Downloa

Session description protocol usageSDP Headers Supported?v--Protocol version Yeso--Owner or creator and session identifier Yess--Session name Yest--Tim

SIP security authentication Authentication Supported? CommentsDigest Authentication YesProxy-to-UserAuthenticationYesUser-to-UserAuthenticationNo The

Subscription type Supported Avaya Call Server specificua-profile Partial Yesservice-package Yes Yesnetwork-redirection-reminderYes YesSupported instan

Chapter 19: Diagnostics andtroubleshootingThis chapter contains the following topics:• IP Deskphone diagnostics on page 303• Local diagnostic tools o

Things to consider when setting parameters:• Enter requested information in the menu fields by pressing the number keys on thedialpad. Press the aster

Software conversion failuresThere are four different boot loaders in the FLASH and application load. Various boot loadersare used to recover the IP De

Diagnostics option DescriptionEthernet Statistics Provides some Ethernet statistics forNetwork Interface and PC port.IP Network Statistics Provides IP

Figure 73: Network menu screenAfter you access the Network menu, the following options are available:• 1. Server Settings• 2. Device Settings• 3. Diag

Table 52: NavigationKey ActionUp and down arrows Use the up and down arrows to change theselected item in the list.Enter Invokes the Select context-se

Voice VLAN Enable: NoVoice VLAN Config: NoVLAN Voice VLAN Discovered: NoPrimary Server: S1PC Port is: ON2.Software Version: 3.00.09.02 Hardware ID: xx

this file is associated. Language files are signed by Avaya and are authenticated by thesoftware for security reasons.The following languages are supp

Table 54: NavigationKey ActionReturn Press the Return context-sensitive soft keyto cancel this screen and return to theDiagnostics menu.Network Diagno

• Packet Size—Size of the network packet used by the ping routine.•Ping—The number of ping packages.The following services are available:• activate th

Figure 77: Network Diagnostics tools (Config) screenThe screen contains the following configurable fields:1.IP—The user can enter an IP address.2. Hop

Ethernet StatisticsThe Ethernet Statistics (NI Port) screen displays ethernet statistics information for NetworkInterface (NI) or PC ports, such as th

7. Packet Collision: 08. CRC Errors: 19. Frame Errors: 1A. Unicast Packets Tx: 1B. Unicast Packets Rx: 1C. Broadcast Packets Rx: 1D. Multicast Packets

Figure 79: Ethernet Statistics (PC Port) screenThe following is an example of Ethernet Statistics for the PC Port:1. PC Link Status: Up2. Duplex Mode:

Table 61: Context-sensitive soft keys for the Ethernet Statistics (PC Port) screenContext-sensitive soft key ActionReset Resets statistics values.PC P

2. Packet Received: 03. Incoming Packets Error: 04. Outgoing Packets Error: 05. Incoming Pkt Discarded: 06. Outgoing Pkt Discarded: 07. Unknown Protos

Figure 81: USB Devices screen Important:The USB Devices screen contains a list of the USB devices attached to theIP Deskphone.The following table desc

The following screen appears:Figure 82: Advanced Diag Tools screenThe following table describes the function of the context-sensitive soft keys for th

• [CTL]—this section is used to enable an IP Deskphone to download the Certificate TrustList, which is a list of trusted device certificates.• [USER_K

The command determines whether or not the option can be managed:• If PORT_MIRROR_ENABLE is Yes, then you can activate or deactivate the option. ThePor

Figure 83: Test key screenAfter you activate the test mode, the key event appears on the screen:•Key pressing: "Test key: xx pressed"•Key pr

1. by entering a Special Key Sequence (SKS), or2. remotely using SSH-PDT.Activating Reset to Factory Settings does not affect files stored in the USB

If you select Y, the PDT displays the prompt:>Enter MAC-address:3.Type in the IP Deskphone MAC-address.><MAC><enter>For example, if

Figure 84: Logging Systems screenThe Logging Systems screen displays the SIP Logging subsystem. Press the Enter key in theNavigation key cluster to sw

You can enable or disable SIP-logging using the following command in the Device configurationfile:LOGSIP_ENABLE [Yes | No]If the parameter is Yes, the

Task MonitorThe Task Monitor performs the following functions:• Tracks the switch of any task to the suspended state. If the task gets to the suspende

automatically by the tool), and reduces the effort required to send the appropriate loginformation to technical support.The PDT provides remote access

Command DescriptionIf the input parameter is incorrect, the followingnotification appears:>prtlog: incorrect type of manager <x>clearLogFile

Command Descriptionlsr List directory contents (similar to unix Is) and thecontents of a directory and any of its subdirectoriesping <host ip> [

the file is forced to download and the version number in the IP Deskphone is overwrittenwith the version number in the 1xxxeSIP.cfg file.• DOWNLOAD_MO

Command Descriptionreset2factory >reset2factory Resets the IP Deskphone to the default setting. See Activating Reset to Factory Setting using SSH_P

tt 0x <TID>checkStack 0x <TID>To print out the list of all supported commands and short description you can enter the "?"command

Figure 85: PDT output on usbFsShow commandUpdate PDT device configuration informationThe PDT device configuration is updated with USB port lock inform

Figure 86: USB Device information from PDTDevice configuration fileThe following table describes the configuration commands in the device configuratio

Component Flag Descriptionmonitor wakes up (after start-upor the last memory checkattempt).• The values are 1800 (0.5 hrs) to86400 (24 hrs). The defau

Diagnostic LogsThe IP Deskphone supports two types of log files:• ECR-log• SIP-logECR-log fileThe ECR-log file registers and provides detailed informa

The third section includes the supplementary information. The content depends on the flag inthe calling function. The flag can be as follows:• ECR_LOG

Figure 87: Example of the supplementary information in the ECR-log fileDiagnostic LogsSIP Software for Avaya 1100 Series IP Deskphones-Administration

Figure 88: Example of the supplementary information in the ECR-log file (continued)The following is an example of the ECR-log file.PDT>prtlog 0 (--

Figure 89: Example of the ECR-log fileDiagnostic LogsSIP Software for Avaya 1100 Series IP Deskphones-Administration November 2012 339

Important:When using HTTPS, the IP Deskphone must have a device certificate loaded on theIP Deskphone.If using FTP, HTTP, or HTTPS, then SRV_USER_NAM

Figure 90: Example of the ECR-log file (continued)Diagnostics and troubleshooting340 SIP Software for Avaya 1100 Series IP Deskphones-Administrati

SIP-log fileThe SIP-log file registers incoming and outgoing SIP-packages, and each package is loggedas a record. There are two sections:• The first s

Figure 91: Example of the SIP-log fileDiagnostics and troubleshooting342 SIP Software for Avaya 1100 Series IP Deskphones-Administration November

Figure 92: Example of the SIP-log file (continued)Three ways to get SIP-logs from a phone:1.Online — connect to the phone through SSH and enter the db

SSHID <user name>SSHPWD <user password>SFTP YESSFTP_READ_PATTERNS .txt,.zip,.logSFTP_WRITE_PATTERNS .txt,.zip,.logYou can then connect thr

SSHIf a logon failure for SSH Authentication occurs, the following event is posted in the securitylog:1040[Minor][TUE JAN 02 20:12:14 2007][4189][i:/f

Diagnostics and troubleshooting346 SIP Software for Avaya 1100 Series IP Deskphones-Administration November 2012Comments? [email protected]

IndexNumerics802.1ab Link Layer Discovery Protocol (LLDP) ...184802.1x (EAP) authorization ...184802.1x (EAP)

Images ...152Installation overview ...

UUpgrade and convert the IP Deskphone software. ...107Upgrade the SIP Software ...107Upgrade the UNIStim software

Setting the default language on the IP Deskphone to FrenchTo configure the default language on a new IP Deskphone, or an IP Deskphone that has notbeen

Figure 4: Sample device configuration fileParameters in the IP Deskphone configuration file are saved on the IP Deskphone. Removinga parameter from th

Configurationcommand typeConfiguration commandsSERVER_IP1_1SERVER_IP1_2SERVER_IP2_1SERVER_IP2_2SERVER_PORT4_1SERVER_PORT4_2SERVER_PORT5_1SERVER_PORT5_

Configurationcommand typeConfiguration commandsUSER_FILE_ENABLEAUTOLOGIN_AUTHID_KEYxxPROMPT_AUTHNAME_ENABLETRANSFER_TYPEREDIRECT_TYPEENABLE_PRACKSELEC

Configurationcommand typeConfiguration commandsSCRNSVR_TEXTSCRNSVR_MODESCRNSVR_DELAYSCRNSVR_IMAGEBG_IMAGE_ENABLEBG_IMG_SELECT_ENABLEUSE_BG_IMAGESPEEDL

Configure the DHCP server to support SIP IP Deskphone class identifier...101Requested Device Settings para

Configurationcommand typeConfiguration commandsNAT configurationcommandsNAT_SIGNALLINGNAT_MEDIANAT_TTLSTUN_SERVER_IP1STUN_SERVER_IP2STUN_SERVER_PORT1S

The syntax of the device configuration file is case-sensitive. Verify that the commands enteredfollow the case defined in this document. Important:Par

y=1 indicates the primary address and y=2 indicatesthe secondary address.- port_number – the SIP proxy signaling port (default is5060).SERVER_TCP_PORT

Important:Decide carefully whether SIP_PING usage isappropriate for your environment. Even whenSIP_PING is not used for NAT TRAVERSAL, it ishighly li

- YES –IPv6 address is selected.- NO –IPv4 address is selected.IPV6_STATELESS [YES | NO] This parameter configures stateless autoconfiguration. IfIPV6

- AES_CM_128_HMAC_SHA1_80 (default value)- AES_CM_128_HMAC_SHA1_32- NoneSRTP_CIPHER_2[AES_CM_128_HMAC_SHA1_80|AES_CM_128_HMAC_SHA1_32]This parameter c

Important:Ensure there are no spaces between the extensions.When this parameter is changed, the system resets.HASH_ALGORITHM [SHA1 |MD5]This paramete

CA [IP address] This parameter is the IP address of the CertificatesServer.CA_DOMAIN [phone name] This parameter is the IP Deskphone phone name.- mini

- YES — the last IP address information is used if theDHCP server is not reached.- NO — Must receive a response to assign the IPDeskphone an IP addres

exist. When a user creates a new profile the defaultbehavior is taken from this setting. After the creationof a new profile this configuration setting

TCP/TLS operation overview...203SRTP.

USE_RPORT [YES | NO]- YES – allows the IP Deskphone to work from behindand/or in front of a symmetrical NAT with serversand/or clients that support RF

and the start of dialing the voice mail user ID. Thedefault value is 1000ms.- x – the delay in millisecondsLLDP_WAITING_TIME[timeout_sec]This paramete

IPOFFICE_REDIAL_CODE[opt_string]This parameter allows the administrator to configurethe Redial soft key. If the parameter is configured, theIP Deskpho

defined in the IP Deskphone-specific configurationfile. Note:When using this setting, the user is prevented fromlogging off the IP Deskphone. Note:If

does not try to access the provisioning server at thesame time. By default the automatic update feature isdisabled (see AUTO_UPDATE_TIME_RANGE).- x –

verify that early media is being received. SeeRFC3262 for details. Note:ENABLE_PRACK must be configured as NO whenconnected to the MCS 5100 Release 3.

• PCMU• G729• G722• G723- text description – a text description of the codec. Formore information about audio codec configuration,see Audio codecs on

FORCE_BANNER is configured as YES, the bannerfrom the configuration file is reloaded each time theIP Deskphone powers up, even if the user changes the

Location Time zone offset(seconds)(GMT-05:00) Eastern time(US and Canada)-18000(GMT-04:00) Atlantic time(US and Canada)-14400(GMT-03:00) Brasilia,Buen

- ENCRYPTED – Instant Messages are sentencrypted- TEXT – Instant Messages are sent as text.- SIMPLE – Instant Messages are sent using SIP forInstant M

Chapter 17: Internet Protocol version 6...283IPv6 address entry...

line keys. A value of 1 allows a single user at a time.A value of 0 is treated the same as a value of 1because you cannot restrict the IP Deskphone to

- YES - send the PUBLISH request- NO - do not send the requestDEF_LANG [language] This parameter configures the default language file(without the file

- RFC2543 – standard protocol of the InternetEngineering Task Force (IETF).- RFC3261 – standard protocol of the IETF.ENABLE_3WAY_CALL [YES | NO] This

minutes up to a maximum of 6 attempts, and thenhourly attempts are made. If SNTP_ENABLE isconfigured as NO, the IP Deskphone tries to retrievethe time

- YES – a brief ring splash plays when a call isforwarded.- NO – the ring splash does not play.FORCE_CFWD_NOTIFY [YES | NO ] This parameter allows the

CONFERENCE_URI1 [email protected]. This isthe address of the conference server when the userattempts to make a conference call. The default isconfere

- YES – enables the user to logout without apassword.- NO – does not allow the user to logout without apassword (default).REMOTE_CHECK_FOR_UPDATE[YES

emergency username, otherwise, the emergencycall fails.E911_PROXY [proxy_name] This parameter is a default emergency proxy. Thisvariable must contain

MENU_AUTO_BACKOUT [x] This parameter is a menu auto back-out timepreference configuration used to configure the autoback-out time on newly created pro

that all the characters are displayed properly. Thedefault value is NO.- YES – enables the customizable banner loginbanner.- NO – disables the customi

Update PDT device configuration information...332Device configu

SCRNSVR_UNPRTCTD_ENABLE[YES| NO]This parameter enables or disables the UserInterface (UI) for configuring and using thescreensaver without a password.

SCRNSVR_IMAGE [image] This parameter configures the background imagefile for the display screensaver of newly createdprofiles. The image must exist in

specified index does not exist on the IP Deskphone,or is invalid, the speed dial list is not displayed onthe IP Deskphone. The IP Deskphone retrieves

parameter (MAX_BLFCALLS =MAX_APPEARANCE).BLF_ENABLE [YES | NO | SCS | SIPX] This parameter enables or disables the Busy LampField (BLF) feature suppor

presses the Delete or Send Context-sensitive softkey, an error message appears. If the value isconfigured as Y, the user can delete or copy WAVfiles w

- YES – to act on CFG files using the file manager(default).- NO – does not allow the user to delete of copyCFG files on the IP Deskphone or USB drive

required to be in the device configuration file. Ifchange is required, the USB_KEYBOARDconfiguration command must be placed in thedevice configuration

- EU2- AusNZThe default value is NA.HOTLINE_ENABLE [YES | NO] This parameter indicates if Hotline Service isenabled or disabled. The default value is

- 0 – indicates that the refresher is omitted- 1– indicates that the refresher is configured toUAC- 2– indicates that the refresher is configured toUA

DOS_PACKET_RATE is < 1, other values areignored and packets are not dropped.LOGSIP_ENABLE [YES | NO] This parameter enables or disable SIP-logging.

8 SIP Software for Avaya 1100 Series IP Deskphones-Administration November 2012

• label_string - label characters. Maximum length ofthe string is 6 alpha-numerics characters. Note:TECH_SUPPORT_ADDRESS parameter isdefined.TECH_SUPP

DISABLE_SPKRPHN [YES | NO] This parameter disables the speakerphone for allnon-911 calls. This is intended for DoD. The defaultvalue is NO.- YES– disa

- YES – initial login and logout is alphanumeric.- NO – initial login and logout is numeric (default).FIPS_MODE [YES | NO] FIPS mode is used in a Fede

- YES –– the IP Deskphone uses private DSCP values,unless overridden.- NO –– the IP Deskphone uses either one of the configuredDSCP values or the syst

value is retrieved from the Service Package. Thedefault value is 6.- x ––a value from -1 to 7 indicating the 802.1Pvalue.DSCP_MEDIA_FLASHOVERRIDE[x]Th

value is retrieved from the Service Package. Thedefault value is 18.- x –– a value from -1 to 63 indicating the DSCPvalue.Tone configuration commandsD

- on_time – the duration of the tone when it is on. A -1 indicatesa continuous tone.- off_time – the duration when no tone is played.FASTBUSY_TONE[fre

parameter SIP_PING in the deviceconfiguration file.- SIP_PING – an Avaya proprietary NATtraversal protocol. Note that SIP_PING onlysupports NAT traver

STUN_SERVER_PORT2[port_number] This parameter is the port number usedcorresponding toSTUN_SERVER_IP2. Thedefault port number is 3478.- port_number– is

VOCODER_FLAG_G723_RATE_63VOCODER_G729VOCODER_G722VOCODER_PCM16VOCODER_PCM8vqmonVocoderTypeUnknownLISTENING_R_WARN = 70(default if not configuredand un

Chapter 1: New in this releaseSIP Software for Avaya 1100 Series IP Deskphones- Administration , NN43170-600 supports SIPSoftware Release 4.1. This d

- YES – enables the sending of alert report based on jitterdetection- NO – disables the sending of alert report based on jitterdetectionJITTER_WARN [x

- YES – enables periodic VQMon session reports.- NO – disables periodic VQMon session reports.SESSION_RPT_INT [xx] This parameter specifies the interv

Default is 255, which is equivalent to the recovery level of 2.LOG_LEVEL [x] This parameter defines which IP Deskphone bugs are logged in theECR file.

Note:To provision AUTOLOGIN_PASSWD_KEY [xx], theIP Deskphone must be rebooted after theIP Deskphone configuration file is updated.PROMPT_AUTHNAME_ENA

the numbers are mapped as intercom calls, some numbers are mapped as local PublicSwitched Telephone Network (PSTN) calls, and some numbers are mapped

Figure 5: Sample dialing planDialing function descriptionDialing planIf the IP Deskphone encounters a [DIALING_PLAN] section while parsing the 11xxeSI

As most phone users are used to dialing digits to indicate the address of the destination, thereis a need to specify the rule by which digits are tran

Figure 8: Sample dialing plan digit map sectionThe first part of a dialing plan contains a pattern defined with DRegex, which is used formatching the

Figure 9: DRegex rulesDownloadable WAV filesIf the IP Deskphone encounters a [TONES] section while parsing the 11xxeSIP.cfg file, the IPDeskphone down

It is possible to customize the ring tones on the IP Deskphone with SIP Software. Up to fivespecial ring tones can be downloaded from the provisioning