SIP Software for Avaya 1100 Series IP Deskphones-Administration Release 4.4 NN43170-600 Issue 06.
© 2015 Avaya Inc. All Rights Reserved. Notice While reasonable efforts have been made to ensure that the information in this document is complete and accurate at the time of printing, Avaya assumes no liability for any errors. Avaya reserves the right to make changes and corrections to the information in this document without the obligation to notify any person or organization of such changes. Documentation disclaimer list of Heritage Nortel Products located at http://support.avaya.
Avaya is a registered trademark of Avaya Inc. All non-Avaya trademarks are the property of their respective owners. Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries. Downloading Documentation For the most current versions of Documentation, see the Avaya Support website: http://support.avaya.com, or such successor site as designated by Avaya. Contact Avaya Support See the Avaya Support website: http://support.avaya.
Contents Chapter 1: New in this release............................................................................................... 11 Supported platforms.............................................................................................................. 11 Avaya Aura® support for 1100 Series IP Deskphones.............................................................. 11 Features....................................................................................................................
Contents Introduction........................................................................................................................... 36 SIP overview......................................................................................................................... 36 Avaya 1100 Series IP Deskphones with SIP Software.............................................................. 36 Related documentation.........................................................................................
Contents Convert SIP Software to UNIStim Software........................................................................... 151 Chapter 10: Provisioning the IP Deskphone Device Settings.......................................... 153 Manual provisioning............................................................................................................. 153 Automatic provisioning.........................................................................................................
Contents SSH and secure file transfer................................................................................................. 246 TCP/TLS operation overview................................................................................................ 247 SRTP................................................................................................................................. 259 Last successful or unsuccessful logon.....................................................................
Contents License information for the IP Deskphone............................................................................. 309 Licensable features............................................................................................................. 310 Node-locked license mode................................................................................................... 311 Invalid or no license file..........................................................................................
Contents Ethernet Statistics............................................................................................................... 349 IP Network Statistics............................................................................................................ 352 USB Devices....................................................................................................................... 354 Advanced Diag Tools..............................................................................
Contents Multi-user login on Avaya Aura®..................................................................................... 392 Chapter 26: FNEs and FACs for 1100 Series IP Deskphones..................................... 394 FNEs and FACs with Avaya Aura®................................................................................. 394 Supported features on Avaya Aura®............................................................................... 394 Feature to FAC/FNE Naming......................
Chapter 1: New in this release SIP Software for Avaya 1100 Series IP Deskphones- Administration , NN43170-600 supports SIP Software Release 4.4. This document contains administration information for the Avaya 1120E IP Deskphone, Avaya 1140E IP Deskphone, and Avaya 1165E IP Deskphone with SIP Software Release 4.4. Supported platforms SIP 4.4 supports the following platforms: • Communication Server 1000 7.6 • B5800 Branch Gateway 6.2 • IP Office Release 8.1 • Avaya Aura® Communication Manager 6.
New in this release • Avaya Aura® Presence Services 6.1 • Avaya Aura® Conferencing 7.0 Telephony features Some Communication Manager (CM) features can be invoked by dialing a Communication Manager Feature Name Extension (FNE). FNEs must be defined in Communication Manager for each of those features, subject to the existing dial plan. Some CM features can be invoked by dialing a Communication Manager Feature Access Code (FAC).
Features If the IP Deskphone configuration parameter AUTOLOGIN_ENABLE is configured as 2 or USE_AUTOLOGIN_ID, then the UserID, AuthID, and Passwd values are extracted from the AUTOLOGIN[_ID_KEY|_AUTHID_KEY|_PASSWD_KEY] configuration parameters. Server profiles support all configurations of the AUTOLOGIN_ENABLE parameter. If the AUTOLOGIN_ENABLE parameter in a profile is configured as 0(or NO) or 1 (or YES), then the configuration file behaves as if there was no profile.
New in this release In the preceding situations, if there is an active call at the time when the new best IPv6 address is added or the current IPv6 address becomes deprecated, the following message is displayed on the IP Deskphone screen: Phone will reconnect instead of SIP reset after call. Connection is re-established after the active call is completed.
Features Case-insensitive Directory search SIP Software Release 4.4 introduces the case-insensitive Directory search. When a Directory search is initiated, the displayed Address Book entries are sorted based on the entered characters, no matter what case was used. When Name search or First Character search methods are used, the first item which fits the entered search criterion is selected.
New in this release When this message is displayed, the user can: • wait until the IP Deskphone receives the required IP address from DHCP • open the Device Settings menu (by double-pressing the Services key) and try to re-configure the IP Deskphone The message window closes automatically when the IP Deskphone receives a new valid IPv4/IPv6 address. For more information, see DHCP server unreachable on page 346. Handling fixed keys for multiple calls In SIP 4.
Features If there are no incoming or active calls, the key action is applied to the call highlighted in the list of calls Note: If there is an active established call, and at the same time another call comes in, pressing the Line key puts the active call on hold and the incoming call is answered. If there are several incoming calls at the same time, the newest call is answered. In order to answer a different call, the user must select the call and press the corresponding soft key.
New in this release For more information, see the IP Deskphone User Guide for the appropriate model. Debug port security SIP 4.4 introduces a security change to prevent unauthorized access and intervention in IP Deskphone operation through the debug port (Accessory Expansion Module (AEM) port) when a dongle is used. The debug port is now disabled by default; enabling the debug port requires access to the Advanced Diag Tools menu, which is always protected by the admin password.
Features Both mutual authentication and server-only authentication methods are supported. The TLS connection cipher is set according to the security policy configured on the IP Deskphone (the security policy must be configured in Normal mode). The default cipher is TLS_RSA_WITH_AES_256_CBC_SHA. For more information, see HTTPS support in BootC mode on page 296. Permanently disable Port Mirroring SIP 4.4 introduces the ability to permanently disable Port Mirroring through provisioning.
New in this release • Detailed configured server profiles information has been added to the command output. • The displayed values of ADMIN_PASSWORD and other passwords have been replaced by “***” in the command output Miscellaneous changes for IP Deskphones Default input mode in Address Book The default input mode for a telephone number has been changed to 123 when adding a new entry to the Address Book of an IP Deskphone.
Avaya Aura®-specific features The Presence feature is configured in SIP 4.4 with the following new configuration parameters: • RPID_PRESENCE_ENABLE • PRES_SERVER_IP If the RPID_PRESENCE_ENABLE parameter is set to YES, RPID-based subscription and notification messages, required for Avaya Presence Services, are sent. PRES_SERVER_IP parameter defines the IP address of the Avaya Presence Server.
New in this release Avaya Aura® support for 1100 Series IP Deskphones on page 380 Presence status in Address Book on page 22 Presence status in Address Book The status dialog of the Address Book displays the presence state of contacts designated as Friends. In SIP 4.4, the IP Deskphone Address Book displays the presence state of Friends if RPID_PRESENCE_ENABLE is set to YES. Phone state Phone state is determined automatically, based on notifications received from Avaya Presence Server.
Avaya Aura®-specific features SIP 4.4 supports the following functionality with PPM: • retrieving contact list from PPM • adding and deleting contacts • updating contact • searching user • retrieving E911 numbers • PPM reboot mechanism Configuration parameter The ENABLE_SERVICE_PACKAGE configuration parameter is expanded to include the value PPM, which switches the mode to obtain PPM data.
New in this release • End a call • Ignore a call Note: This feature is not supported for users who have more than one Session Manager configured in their properties on Avaya Aura®. Embedded device certificates TLS connection with Avaya Aura® Session Manager requires mutual authentication by default. Mutual authentication requires proper Certificate Authority (CA) and device certificates to be installed on every IP Deskphone. SIP 4.
Other changes Note: To use SRTP, you first have to be using TLS. That is, you cannot have secure media without using secure signalling. The following SRTP modes are supported: • Secure Only • Best Effort Capability Negotiation Configuration SIP 4.4 introduces the following parameter to support SRTP on Avaya Aura®: AVAYA_AURA_MODE_ENABLE [YES | NO] The command specifies if Avaya Aura®-specific features are active on the IP Deskphone or not. The default value is NO.
New in this release Adding the IP Deskphone to Avaya Aura A Quickstart Guide — Add an 1100 Series IP Deskphone to Avaya Aura® has been added to this document. See Adding a new IP Deskphone to Avaya Aura® on page 434. Configuring FACs and FNEs Information on configuring FACs and FNEs on Avaya Aura® for the IP Deskphones has been added to this document. See Configuring FACs and FNEs for the IP Deskphones on page 437.
Revision history September 2013 Standard 05.02. This document is up-issued to reflect changes in technical content for the DEF_AUDIO_QUALITY parameter and a note has been added to Codecs preferences on the IP Deskphone on page 271. June 2013 Standard 05.01. This document is up-issued to support SIP Software Release 4.3 Service Pack 2 (SP2). April 2013 Standard 04.07. This document is up-issued to reflect changes in technical content in the section “IP Deskphone bug logging/recovery commands”.
New in this release 28 October 2010 Standard 02.01. This document is up-issued to support SIP Software Release 4.0. October 2010 Standard 01.04. This document is up-issued to reflect changes in technical content for TLS. October 2010 Standard 01.03. This document is up-issued to reflect changes in technical content for Licensing. September 2010 Standard 01.02. This document is up-issued to add content for Multi-Level Precedence and Preemption. August 2010 Standard 01.01.
Chapter 2: Customer service Visit the Avaya Web site to access the complete range of services and support that Avaya provides. Go to http://www.avaya.com/support or go to one of the pages listed in the following sections.
Customer service Getting technical support from the Avaya Web site The easiest and most effective way to get technical support for Avaya products is from the Avaya Technical Support Web site at http://support.avaya.com. 30 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 3: Introduction to this guide Subject SIP Software for Avaya 1100 Series IP Deskphones — Administration, NN43170-600 describes how to install, configure, and provision the Avaya 1120E IP Deskphone, Avaya 1140E IP Deskphone, and Avaya 1165E IP Deskphone for use on a SIP network. These IP Deskphones are collectively known as Avaya 1100 Series IP Deskphones. In this document, the Avaya 1100 Series IP Deskphones are referred to as IP Deskphones.
Introduction to this guide the guide influence the function of the IP Deskphone on the network and require an understanding of telephony and Internet Protocol (IP) networking.
Acronyms IAS Internet Authentication Service ICMP Internet Control Message Protocol IETF Internet Engineering Task Force ISDN Integrated Services Digital Network IM Instant Message IP Internet Protocol IPv6 Internet Protocol version 6 ITU-T Telecommunications Standardization sector of the International Telecommunications Union LAN Local Area Network LED Light Emitting Diode MAC Media Access Control MADN Multiple Appearance Directory Number MD5 Message Digest v5 MLLP Multi-Level P
Introduction to this guide SDP Session Description Protocol SDESC Session Description Protocol SFS Security File System SFTP Secure File Transport Protocol SSH Secure Shell Handler SIMPLE SIP for Instant Messaging and Presence Leveraging Extensions SIP Session Initiation Protocol SKS Special Key Sequence SMTP Simple Mail Transfer Protocol SOAP Simple Object Access Protocol SRTCP Secure Real-time Transport Control Protocol SRTP Secure Real-time Transport Protocol STUN Simple Travers
Related publications • Avaya 1165E IP Deskphone with SIP Software on Avaya Aura User Guide, 16-604275 • Avaya 1100 Series Expansion Module (SIP Software) User Guide, NN43110-301 • Avaya 1120E IP Deskphone with SIP Software Quick Reference Guide • Avaya 1140E IP Deskphone with SIP Software Quick Reference Guide • Avaya 1165E IP Deskphone with SIP Software Quick Reference Guide • Avaya 1120E IP Deskphone with SIP Software on Avaya Aura Quick Reference Guide • Avaya 1140E IP Deskphone with SIP Software on Ava
Chapter 4: Overview Introduction This chapter describes the hardware and software features of the Avaya 1120E IP Deskphone, Avaya 1140E IP Deskphone, and Avaya 1165E IP Deskphone with SIP Software Release 4.4. In this document, Avaya 1100 Series IP Deskphones will be referred to as IP Deskphones. SIP overview Session Initiation Protocol (SIP) is a signaling protocol used for establishing multimedia sessions in an Internet Protocol (IP) network.
Avaya 1100 Series IP Deskphones with SIP Software Important: Converting the software on an IP Deskphone from UNIStim software to SIP software overwrites the UNIStim software. The IP Deskphone cannot operate in both modes simultaneously. A switch from UNIStim to SIP software or SIP to UNIStim software requires a software reload. The following figure shows the main components of the Avaya 1165E IP Deskphone with SIP software.
Overview Figure 2: Avaya 1140E IP Deskphone with SIP Software The following figure shows the main components of the Avaya 1120E IP Deskphone with SIP software. 38 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Related documentation Figure 3: Avaya 1120E IP Deskphone with SIP Software Related documentation The Avaya 1100 Series IP Deskphones with SIP Software User Guides explains how to do the following: • 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, a
Overview • configure Bluetooth headset operation (Avaya 1140E IP Deskphone and Avaya 1165E IP Deskphone only) • configure Screensaver slide show (Avaya 1165E IP Deskphone only) For more information about using the IP Deskphones, see Avaya 1120E IP Deskphone with SIP Software User Guide, NN43112-101, Avaya 1140E IP Deskphone with SIP Software User Guide , NN43113-101 and Avaya 1165E IP Deskphone with SIP Software User Guide, NN43170-100.
Installation overview Figure 4: Installation of IP Deskphones with SIP Software, page 1 of 2 March 2015 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Overview Figure 5: Installation of IP Deskphones with SIP Software, page 2 of 2 42 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 5: Before installation Introduction This chapter features a checklist of tasks you must complete before you install SIP Software on the Avaya 1100 Series IP Deskphones. Preinstallation Complete the following checklist. Preinstallation checklist 1. Read and become familiar with your IP Deskphone User Guide. 2. Ensure there is one IP Deskphone boxed package for each IP Deskphone being installed. 3.
Before installation Expansion Module backlight can only light when the AC adapter global power supply is present. On the other hand, either the AC adapter global power supply or Power over Ethernet (PoE) to the IP Deskphone will power all of the Expansion Module’s other functionality. To have the backlight on for the Expansion Module, the IP Deskphone should be powered by AC global power supply only.
Chapter 6: Creating the provisioning files Important: If you have UNIStim software on your IP Deskphone, the software must be converted from UNIStim to SIP before you proceed with the following instructions. See the chapter Upgrade and convert the IP Deskphone software on page 144 for instructions on how to convert the software on an IP Deskphone from UNIStim to SIP.
Creating the provisioning files file transfer session starts for each file to be downloaded. The provisioning file (for example, 1165eSIP.cfg) can contain commands that prompt for confirmation before a file is downloaded. Download the SIP Software To download the SIP Software from the Avaya web site, perform the following procedure. Downloading SIP Software for the IP Deskphone 1. Go to http://www.avaya.com/support. The Avaya Support page appears. 2.
Create the SIP provisioning files registration (depending on the file) and then uses the parameters from them as required. An address book, custom keys and speed dial list can be associated with: • The overall device configuration file – generally used for the phone model. • The primary server profile – used when the phone connects to the primary server. • The secondary server profile – used when the phone connects to the secondary server. • Each User Configuration file – used for a specific phone.
Creating the provisioning files 48 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Create the SIP provisioning files The following is an example of an IP Deskphone provisioning file: [DEVICE_CONFIG] DOWNLOAD_MODE AUTO VERSION 000001 FILENAME 1120DeviceConfig.dat Device configuration section [FW] DOWNLOAD_MODE AUTO VERSION SIP1120E04.04.09.00 PROTOCOL TFTP FILENAME SIP1120e04.04.09.00.bin Firmware load section [DIALING_PLAN] DOWNLOAD_MODE AUTO VERSION 000024 Dialing plan section [LANGUAGE] DOWNLOAD_MODE AUTO DELETE_FILES YES VERSION 000024 FILENAME French.lng FILENAME Portugues.
Creating the provisioning files [CRL] DOWNLOAD_MODE FORCED VERSION 000002 FILENAME CRL.pem PROMPT YES Certificate Revocation List section [LOGGIN_BANNER] DOWNLOAD_MODE AUTO VERSION 000002 FILENAME warning_banner.txt Login banner section [USER_CONFIG] DOWNLOAD_MODE FORCED VERSION 000001 IP Deskphone-specific configuration files The following table lists the supported sections in a provisioning file.
Create the SIP provisioning files 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 Deskphone with SIP Software: • [DEVICE_CONFIG]—this section is used to configure various parameters in the IP Deskphone. • [FW] —image files originate from Avaya only and are authenticated during software download.
Creating the provisioning files The WAV files can be created and downloaded to the IP Deskphone. These files are not authenticated by the IP Deskphone. • [LICENSING]—this section is used for downloading license files. • [SEC_POLICY]—this section is use for downloading a file, which contains rules that define the security policy for the IP Deskphone. After the file downloads, the IP Deskphone verifies that the file is signed by a trusted entity before it accepts the values in the security policy file.
Create the SIP provisioning files Note: The version number of the firmware [FW] can be longer, up to 19 characters, and must follow this format: SIP1120e04.04.09.00 SIP1140e04.04.09.00 SIP1165e04.04.09.00 Caution: The version number is stored permanently on the IP Deskphone until a higher version number is downloaded. However, if the Forced option is in the 11xxeSIP.
Creating the provisioning files • PROTOCOL [TFTP | FTP | HTTP] [ HTTPS] defines the protocol used to download the file. The IP Deskphone with SIP Software supports TFTP, FTP, HTTP, and HTTPS protocols for file download. This command is optional. If it is not present, the default protocol TFTP is used. Important: When using the TFTP protocol to transfer the software image, the average round trip time must be < 75 ms.
Create the SIP provisioning files • AUTOLOGIN_AUTHID_KEYxx [* | userid@domain] is used for auto login when the AUTOLOGIN_ENABLE method is configured to USE_AUTOLOGIN_ID. If this parameter is blank and AUTOLOGIN_ENABLE is configured to USE_AUTOLOGIN_ID (or 2) in the device configuration file, then the IP Deskphone uses the value associated with AUTOLOGIN_PASSWD_KEY01.
Creating the provisioning files Setting the default language on the IP Deskphone To configure the default language on a new IP Deskphone, or an IP Deskphone that has not been logged into by an end user, include the following in the [DEVICE_CONFIG] and [LANGUAGE] sections of the 11xxeSIP.cfg configuration file, as shown in the following example. The example shows changing the default language to French; for other languages, use the same parameters but substitute the desired language filename and name.
Create the device configuration file SERVER_PORT1_2 5060 # VOICE FEATURE configuration commands VMAIL 5555 VMAIL_DELAY 300 # Administrative feature commands BANNER Avaya Aura AUTOLOGIN_ENABLE YES # Voice Application commands DEF_LANG English DEF_AUDIO_QUALITY High ENABLE_BT YES ENABLE_3WAY_CALL NO The following table provides a summary of the commands that can be used in the device configuration file.
Creating the provisioning files Configuration command type Configuration commands SERVER_TLS_PORT2_2 SERVER_TLS_PORT3_1 SERVER_TLS_PORT3_2 SERVER_TLS_PORT4_1 SERVER_TLS_PORT4_2 SERVER_TLS_PORT5_1 SERVER_TLS_PORT5_2 Feature configuration commands SIP_PING SSH REG_REFRESH_INTERVAL SFTP SIP_UDP_PORT SSHID SIP_TCP_PORT SSHPWD SIP_TLS_PORT SFTP_READ_PATTERNS REGISTER_RETRY_TIME SRTP_WRITE_PATTERS IPV6_ENABLE HASH_ALGORITHM PREFER_IPV6 EAP IPV6_STATELESS EAPID1 IPV6_ENABLE_GUI EAPID2
Create the device configuration file Configuration command type Configuration commands IPOFFICE_CONF_CODE LLDP_WAITING_TIME AUTOLOGIN_ENABLE MAX_IM_ENTRIES AUTO_UPDATE MAX_ADDR_BOOK_ENTRIES AUTO_UPDATE_TIME MAX_DOWNLOAD_ADDR_BOOK_EN TRIES AUTO_UPDATE_TIME_ RANGE USER_FILE_ENABLE USER_FILE_PATH AUTOLOGIN_AUTHID_KEYxx PROMPT_AUTHNAME_ENABLE TRANSFER_TYPE REDIRECT_TYPE ENABLE_PRACK SELECT_LAST_INCOMING TECH_SUPPORT_LABEL TECH_SUPPORT_ADDRESS MAX_LOGINS MAX_INBOX_ENTRIES MAX_OUTBOX_ENTRIES MAX_REJECTR
Creating the provisioning files Configuration command type Configuration commands E911_USERNAME RTP_MIN_PORT E911_PASSWORD RTP_MAX_PORT KEEP_ALIVE_TYPE SCA_HOLD_BEHAVIOR CONN_KEEP_ALIVE SCA_APPEARANCES AUTOLOGIN_ID_KEYxx SCA_BROADWORKS AUTOLOGIN_PASSWD_KEYxx SCA_LINE_SEIZE_EXPIRES HOLD_TYPE EXP_MODULE_ENABLE ENABLE_3WAY_CALL PROMPT_ON_LOCATION_OTHER E911_HIDE_MESSAGE E911_PROXY E911_TXLOC MAX_BLFCALLS MENU_AUTO_BACKOUT BLF_ENABLE AUTOCLEAR_NEWCALL_MSG BLF_RESOURCE_LIST_URI LOGIN_BA
Create the device configuration file Configuration command type Configuration commands PORT_MIRROR_ENABLE FTP_PASSWORD MEMCHECK_PERIOD CALL_WAITING_TONE DOS_PACKET_RATE MAX_APPEARANCE DOS_MAX_LIMIT DISABLE_SPKRPHN DOS_LOCK_TIME CALL_ORIGIN_BUSY LOGSIP_ENABLE SLOW_START_2000K CUST_CERT_ACCEPT USER_FILE_ENABLE CERT_ADMIN_UI_ENABLE DEFAULT_ADDRESSBOOK_FILE SEC_POLICY_ACCEPT DEFAULT_SPEEDDIALLIST_FILE SECURITY_LOG_UI_ENABLE DEFAULT_CUSTOMKEYS_FILE KEY_SIZE LOGINALPHA_ENABLE KEY_ALGORITHM
Creating the provisioning files Configuration command type Configuration commands QoS and ToS commands DSCP_CONTROL 802.1P_MEDIA 802.1P_CONTROL DSCP_DATA DSCP_MEDIA 802.
Create the device configuration file Configuration command type Configuration commands Deskphone bugs logging/Recovery commands RECOVERY_LEVEL LOG_LEVEL Device configuration file command syntax Important: The device configuration file uses the following syntax: • [ ] – mandatory field • < > – optional field For example: AUDIO_CODEC [ ] [ ] < > would be filled in as AUDIO_CODEC1 G729 G.729 codec Important: The syntax of the commands in the device configuration file is case-sensitive.
Creating the provisioning files Note: SIP_DOMAIN[x] is provisioned after user logout. SERVER_IP[x]_[y]_[ip_address] This parameter configures the primary and secondary IP address for each domain; two proxies for each domain. • x – the domain number from 1 to 5. • y – indicates whether it is the primary or secondary IP address. y=1 indicates the primary address and y=2 indicates the secondary address. • ip_address – the IP address of the SIP proxy server.
Create the device configuration file • port_number – the SIP proxy signaling TLS port (default is 5061). DNS_DOMAIN [domain] This parameter is the DNS domain of the IP Deskphone. SIP_PING [YES | NO] This parameter is the SIP_PING configuration value is used to maintain server heartbeat detection and to keep a firewall pinhole open in the case of UDP signaling. For TCP signaling. the OS keep alive is used for failover mode.
Creating the provisioning files • NO (default) – disables pinging, so a phone performs the failback even if server is unable to serve SIP requests. REG_REFRESH_INTERVAL [seconds] This parameter allows the administrator to change the default re-registration time of the IP Deskphone. The default is 86400 seconds (or 24 hours). The minimum value is 300 and the maximum value is 86400. Note that the proxy can override this value and force the IP Deskphone to have a different refresh interval.
Create the device configuration file IPV6_MCAST_ECHO_REPLY [Yes | /No] This parameter enables or disables the sending of an Echo Reply message in response to an Echo Request message sent to an IPv6 multicast or anycast address. The default value is Yes. • Yes — the IP Deskphone responds to the Echo Request message with an Echo Reply message. This is the default. • No — the IP Deskphone ignores the Echo Request message.
Creating the provisioning files SRTP_CIPHER_2 [AES_CM_128_HMAC_SHA1_80 | AES_CM_128_HMAC_SHA1_32] This parameter configures the preferred order for SRTP cipher offers. The default value is AES_CM_128_HMAC_SHA1_32. • AES_CM_128_HMAC_SHA1_32 (default value) • AES_CM_128_HMAC_SHA1_80 • None SSH [YES | NO] This parameter configures the SSH server on the IP Deskphone. The default value is NO.
Create the device configuration file HASH_ALGORITHM [SHA1 | MD5] This parameter provides the hash algorithm. The default value is SHA1. • SHA1 – algorithm is Secure HASH Algorithm 1 • MD5 – algorithm is Message-Digest algorithm 5 MKI_ENABLE [YES | NO] This parameter indicates whether to use the Master Key Identifier (MKI) or not. The default value is NO.
Creating the provisioning files • maximum value –12 characters HOST_NAME [hostname] This parameter is the IP Deskphone host name. • minimum value – 4 characters • maximum value –12 characters SIP_UDP_PORT [1024 to 65535 | 0] This parameter configures the listening port for incoming UDP requests. The default value is 5060. • minimum value – 1024 • maximum value – 65535 • Disabled – 0 SIP_TCP_PORT [1024 to 65535 | 0] This parameter configures the listening port for incoming TCP requests.
Create the device configuration file PCPORT_ENABLE [YES | NO] This parameter enables/disables the PC port. The default is YES. • YES — PC port is active (default). • NO — PC port is disabled. LLDP_ENABLE [YES | NO] This parameter enables/disables LLDP on the IP Deskphone. The default is NO. • YES – 802.1ab (LLDP) is enabled. • NO – 802.1ab (LLDP) is disabled (default). DHCP_NUMBER_OF_RETRIES [x] This parameter configures the number of times the IP Deskphone attempts to contact the DHCP server.
Creating the provisioning files then, after a pre-defined number of Discovery attempts, the IP Deskphone reverts to VLAN tag mode again. The default is NO. HTTP_RETRY_NUMBER [x] This parameter configures the number of times the IP Deskphone attempts to contact the server when an HTTP 503 (server is unavailable) response is received.
Create the device configuration file The default value is 1800 (seconds). • minimum value – 600 (seconds) • maximum value – 1800 (seconds) KEEPALIVE_RETRIES [x] This parameter specifies the number of times that the IP Deskphone attempts to connect to the proxy server. When the IP Deskphone determines that the proxy server does not respond (keep-alive mechanism fails), it tries to re-establish the connection the specified number of times.
Creating the provisioning files The default is mbid. SCA_APPEARANCES [x] This parameter configures the maximum number of appearances used for outgoing calls by the Shared Call Appearance (SCA) group. The valid range for this parameter is 2 to 24. The default value is 12. SCA_HOLD_BEHAVIOR [PRIVATE | PUBLIC] This parameter configures the default behavior of the hold button when user-determined behavior does not exist. When a user creates a new profile, the default behavior is taken from this setting.
Create the device configuration file stores 16384 and 32764, rather than the erroneous configuration values, to indicate that the configuration attempt has been rejected. CALL_WAITING [SPEAKER | STREAM] • SPEAKER – the Call Waiting tone is played on the IP Deskphone speaker. This is the default option. • STREAM – the Call Waiting tone is injected into the stream played on the transducer in use for the active call. DISTINCTIVE_RINGING [YES | NO] This feature works with the CS 2000 proxy.
Creating the provisioning files PROMPT_ON_LOCATION_OTHER [YES | NO] • YES – prompt the user to select new location if location “other” was previously selected. • NO – do not prompt the user to select new location if location “other” was previously selected. This is the default option. VMAIL [vmail_number] This parameter is the voice mail address, which can be the URI or the DN of the voice mail server. This command takes a string as a parameter. This is the default link for a new user profile only.
Create the device configuration file IPOFFICE_CONF_CODE *3 Note: The option is available if IP_OFFICE_ENABLE is YES. The code of the option is specified in the IP Office Administration Guide IPOFFICE_MSG_CODE [opt_string] This parameter allows the administrator to configure the Msgs soft key. If the parameter is configured, the IP Deskphone user is able to call the IP Office option "Send Message”.
Creating the provisioning files • USE_AUTOLOGIN_ID (or 2) – enables the auto login id feature using the userid specified in AUTOLOGIN_ID_KEY01 and the password specified in AUTOLOGIN_PASSWD_KEY01 to register and authenticate. Both userid and password must be specified. The AUTOLOGIN_ID_KEY01 and AUTOLOGIN_PASSWD_KEY01 parameters are defined in the IP Deskphone-specific configuration file. Note: When USE_AUTOLOGIN_ID is used, the user is prevented from logging off the IP Deskphone.
Create the device configuration file update process, the IP Deskphone reboots based on the recovery level configured. AUTO_UPDATE_TIME [x] This parameter is the actual time in seconds, starting from midnight, before an automatic update occurs. Each IP Deskphone adds random numbers to the time specified by this command so every IP Deskphone does not try to access the provisioning server at the same time. By default the automatic update feature is disabled (see AUTO_UPDATE_TIME_RANGE).
Creating the provisioning files REDIRECT_TYPE [MCS | RFC3261] This parameter is a command used to select different protocols for IP Deskphone redirection. The default setting is MCS. • MCS – when the IP Deskphone receives either 301 (moved permanently) or 302 (moved temporarily) during registration, it is assumed the IP Deskphone is moved to a new system (proxy+registrar) and all subsequent messages are sent to the new address.
Create the device configuration file to accept an incoming request directly or through an incoming proxy. • YES – the request must come directly from the proxy server. YES is the default to enable proxy checking. • NO – the request can be sent directly to the IP Deskphone. (NO is only suitable in a few situations). ENABLE_BT [YES | NO] This parameter is a flag to enable and disable Bluetooth support in the IP Deskphone. • YES – enables Bluetooth. • NO – disables Bluetooth. The default is NO.
Creating the provisioning files the IP Deskphone uses High as the default setting. This parameter is used only if the audio codecs are not configured in the device configuration file. The following codecs are used for each selection: • High – G711 (PCMU), G711 (PCMA), G729 • Medium – G711 (PCMA), G711 (PCMU), G729 • Low – G729, G711 (PCMA), G711 (PCMU) AUTH_METHOD [AUTH | AUTH_INT] This parameter is used to configure the SIP authentication method. The default is AUTH.
Create the device configuration file DST_ENABLED [YES | NO] This parameter enables and disables the Daylight Saving Time (DST) mechanism. The time received from the server is GMT and is converted to the proper timezone by the IP Deskphone. If the DST feature is enabled, the IP Deskphone automatically calculates the DST time at the appropriate date and converts the time to and from DST. The calculations used are based on the new rules applicable to DST in 2007.
Creating the provisioning files Table 5: DST start and stop parameters TIMEZONE_OFFSET [x] Char # Value 1 Ordinal week number in month [1-4/L]; L = last week 2–4 3–letter shortcut for the weekday name (Sun, Mon, Tue, Wed, Thu, Fri, Sat) 5–7 3–letter shortcut for month (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec) 8/8–9 1– or 2–digit hour (0–9 or 00–23) 9/10 Local/UTC time marker (L or U) This parameter is used to configure the current time zone offset from GMT in seconds.
Create the device configuration file Location Time zone offset (seconds) (GMT-04:00) Atlantic Standard Time -14400 (GMT-03:30) Newfoundland -12600 (GMT-03:00) Buenos Aires -10800 (GMT-02:30) Newfoundland -9000 DST March 2015 (GMT-01:00) Azores -3600 (GMT+00:00) Greenwich, Dublin, Lisbon, London 0 (GMT+01:00) Central European Time 3600 (GMT+02:00) Athens 7200 (GMT+03:00) Moscow 10800 (GMT+03:30) Tehran 12600 (GMT+04:00) Abu Dhabi 14400 (GMT+04:30) Khabul 16200 (GMT+05:00) Islamabad
Creating the provisioning files FORCE_TIME_ZONE [YES | NO] This parameter allows you to force the timezone offset on each user's IP Deskphone. The default is NO. • YES – forces the IP Deskphone to use the TIMEZONE_OFFSET specified in the device configuration file. • NO – uses the value stored in the user preferences. IM_MODE [ENCRYPTED | TEXT | SIMPLE | DISABLED] This parameter configures the mode of Instant Messaging (IM). The default setting is ENCRYPTED.
Create the device configuration file DEF_DISPLAY_IM [YES | NO] This parameter enables or disables the display of Instant Messages (IM). The default setting is NO. • YES – enables display of IMs. • NO – disables display of IMs. SELECT_LAST_INCOMING [YES |NO] This parameter determines which call is selected when there are multiple calls ringing (or active). The default value is NO. • YES — the selected call in the call list jumps to the most recent ringing call after it is added to the list.
Creating the provisioning files MAX_OUTBOX_ENTRIES [x] This parameter restricts the maximum number of outbox entries and takes a number as a parameter. For example, MAX_OUTBOX_ENTRIES 100 limits the number of entries in the outbox to 100. The default limit is 100. • x — the maximum number of outbox entries. MAX_REJECTREASONS [x] This parameter restricts the maximum number of Call Decline Reasons (Prefs > Feature Options > Call Decline Reasons) and takes a number as a parameter. The default limit is 20.
Create the device configuration file MAX_IM_ENTRIES [x] This parameter configures the maximum number of Instant Message (IM) entries and takes a number as a parameter. Once the maximum number is reached, the oldest IM is deleted without any user notification. The default limit is 999. • x – the maximum number of instant messages. MAX_ADDR_BOOK_ENTRIES [x] This parameter configures the maximum number of entries in the Address Book. • x – the maximum number of Address Book entries.
Creating the provisioning files • RFC3261 – standard protocol of the IETF. ENABLE_3WAY_CALL [YES | NO] This parameter enables or disables local telephone-based three-way calling for threeparty conferences. • YES – enables local (telephone-based) threeway calling for three-party conferences. YES is the default. • NO – disables local (telephone-based) threeway calling. DISABLE_PRIVACY_UI [YES | NO] This parameter disables the privacy setting in UI menus.
Create the device configuration file IP Deskphone cannot contact the server, the IP Deskphone tries every 15 minutes up to a maximum of 6 attempts, and then hourly attempts are made. If SNTP_ENABLE is configured as NO, the IP Deskphone tries to retrieve the time and date from the SIP proxy server. However, not all SIP proxy servers support this method of retrieving the time and date. • YES – enables NTP. • NO – disables NTP.
Creating the provisioning files the IP Deskphone plays an abbreviated ring tone to remind the user that a call has been forwarded. This configuration value only effects users when their user profile is first created, unless the FORCE_CFWD_NOTIFY flag is also used. The default setting is NO. • YES – a brief ring splash plays when a call is forwarded. • NO – the ring splash does not play.
Create the device configuration file service package based on a configurable Boolean value. The default value is YES. • YES – the IP Deskphone requests and downloads the service package (supported with Avaya Aura® Application Server 5300/ CS 2000) (default). • NO – the IP Deskphone does not request and download the service package.
Creating the provisioning files INTERCOM_PAGING [YES | NO] This parameter allows the IP Deskphone to belong to a paging group. When a page group call is received, a one-way speech path is created to the IP Deskphone, and the IP Deskphone automatically goes to a handsfree intercom state. This is used with the SCS proxy. The default value is NO. • YES – intercom/paging functionality is enabled. • NO – intercom/paging functionality is disabled (default).
Create the device configuration file E911_TERMINATE_ENABLE [YES | NO] This parameter specifies whether a 911 call can be terminated by the calling party or not. The default value is NO. • YES – the caller can terminate the emergency call. • NO – the caller cannot terminate the emergency call once the call has been established. E911_USERNAME [username] This parameter is an emergency username used for making an emergency call that does not require login.
Creating the provisioning files E911_HIDE_MESSAGE [Y | N] This parameter configures whether or not the message “Emergency Calls Only” is displayed when no user is logged in and the IP Deskphone is taken off-hook. The default is NO, which means that the Emergency Calls Only message is not hidden; it is displayed on the IP Deskphone when no user is logged in and the IP Deskphone is taken off-hook. KEEP_ALIVE_TYPE [type_string] This parameter indicates if OS keep-alive on the connection is enabled.
Create the device configuration file which already exists. A user can modify the feature parameter by using the Preferences menu on the IP Deskphone and then selecting the Feature Options > Missed Call Notification menu item. LOGIN_BANNER_ENABLE [YES | NO] This parameter enables or disables the customizable login banner. If configured as enable, the flag causes the login of the primary user to display the provisioned banner text as part of the login process.
Creating the provisioning files protected mode. If configured as Y, the screensaver password screen, Prefs > Display > Screensaver > Mode > \Enable (with password), has a configured context-sensitive soft key that allows the user to define a password for the screensaver. The default value is NO. • YES – enables the ability to configure and use a less secure user-defined password for the IP Deskphone screensaver in password protected mode.
Create the device configuration file SCRNSVR_DELAY [[minutes] This parameter determines how long an IP Deskphone remains at the idle screen before the screensaver is evoked. This parameterconfigures the delay, in minutes, for the display screensaver of newly created profiles. Changes to this value through the Prefs context-sensitive soft key overwrites the value provided through provisioning. The values, in minutes, are 5, 10, 30, and 60. The default value is 10.
Creating the provisioning files • NO – does not configure the background image for the display of newly created profiles. Note: Image files for the IP Deskphone must include the PNG format. SPEEDLIST_KEY_INDEX [x] This parameter specifies the programmable key used for displaying the Speed Dial List. If the specified index does not exist on the IP Deskphone, or is invalid, the speed dial list is not displayed on the IP Deskphone. The IP Deskphone retrieves the device configuration through provisioning.
Create the device configuration file The MAX_BLFCALLS parameter value cannot be greater than the MAX_APPEARANCE parameter value. If the value of the MAX_BLFCALLS parameter is greater than the value of the MAX_APPEARANCE parameter, the value of the MAX_BLFCALLS parameter is reduced by force and takes the value of the MAX_APPEARANCE parameter (MAX_BLFCALLS = MAX_APPEARANCE). BLF_ENABLE [YES | NO | SCS | SIPX] This parameter enables or disables the Busy Lamp Field (BLF) feature support.
Creating the provisioning files FM_SOUNDS_ENABLE [YES | NO] This parameter allows the user to act on WAV files using the file manager. If the value is configured as NO, the IP Deskphone cannot perform any actions on WAV files, such as deleting or copying a WAV file, through the file manager. If the user selects a WAV file on the IP Deskphone or on a USB drive and presses the Delete or Send context-sensitive soft key, an error message appears.
Create the device configuration file FM_LOGS_ENABLE [YES | NO] This parameter allows the user to act on CFG files using the file manager. The default value is YES. • YES – can act on CFG files using the file manager (default). • NO – does not allow the user to delete of copy CFG files on the IP Deskphone or USB drive through the file manager (default). ENABLE_USB_PORT [YES | NO] This parameter enables or disables the USB port.
Creating the provisioning files Note: If the default value is acceptable, the USB_KEYBOARD configuration command is not required to be in the device configuration file. If change is required, the USB_KEYBOARD configuration command must be placed in the device configuration file with the new value. USB_HEADSET [YES | NO[ This parameter enables or disables the USB headset. The default value is NO. • YES – enables the USB headset • NO – disables the USB headset (default).
Create the device configuration file • EU1 • EU2 • AusNZ The default value is NA. HOTLINE_ENABLE [YES | NO] This parameter indicates if Hotline Service is enabled or disabled. The default value is NO. • YES – enables Hotline Service • NO – disables Hotline Service (default). Note: If a service package is enabled then this value is overridden by the value in the service package.
Creating the provisioning files SET_REQ_REFRESHER [x] This parameter indicates what refresher value is configured in the initial session request. The values are 0, 1, and 2. The default value is 0. • 0 – indicates that the refresher is omitted • 1– indicates that the refresher is configured to UAC • 2– indicates that the refresher is configured to UAS SET_RESP_REFRESHER [x] This parameter indicates what refresher value is configured in the 200 OK response. The values are 0, 1, and 2.
Create the device configuration file dropped after the time specified in DOS_MAX_LIMIT (in seconds). DOS_LOCK_TIME [seconds] This parameter specifies the amount of time (in seconds) that the IP Deskphone stops processing packets after DOS_MAX_LIMIT is reached. If DOS_PACKET_RATE is < 1, other values are ignored and packets are not dropped. LOGSIP_ENABLE [YES | NO] This parameter enables or disable SIP-logging. The default value is NO.
Creating the provisioning files TECH_SUPPORT_LABEL [label_string] This parameter configures the label used for the Support soft key on the licensing screen. The user can call the Technical Support service by pressing this soft key. The default value of the label is "Support". — label_string - label characters. Maximum length of the string is 6 alpha-numerics characters. Note: The label appears if the TECH_SUPPORT_ADDRESS parameter is defined.
Create the device configuration file DISABLE_SPKRPHN [YES | NO] This parameter disables the speakerphone for all non-911 calls. This is intended for DoD. The default value is NO. • YES– disables the speakerphone. • NO – enables the speakerphone . CALL_ORIGIN_BUSY [YES |NO] This parameter determines if the user is presented with an incoming call when entering the address of an outbound call. This is intended for DoD. The default value is NO. • YES– user is not presented with an incoming call .
Creating the provisioning files FIPS_MODE [YES | NO] FIPS mode is used in a Federal environment. This parameter verifies that the IP Deskphone is in Federal Information Processing Standards (FIPS) certified mode. Note: The FIPS mode parameter has an intereaction with the IM_MODE parameter. Refer to the IM_MODE parameter for more information. ENABLE_ANSWER_MODE [YES | NO] This parameter allows the administrator to specify if Answer-Mode is supported when registering with the proxy.
Create the device configuration file AUDIO_PROFILE This parameter applies an audio tuning parameter for the 1165E IP Deskphone. The rating id values are: • DEFAULT — TIA audio tuning parameters are applied (default value) • S004 — S004 standard (Australia and New Zealand) audio tuning parameters are applied PREFER_CUSTOMIZED_RBT [YES | This parameter configures the opportunity to not stop the NO] customized ringback tone when a 180 Ringing message is received.
Creating the provisioning files or not. The default value is NO. It can be configured through the device configuration file and through server profiles. • YES – Avaya Aura®-specific features are active. • NO – Avaya Aura®-specific features are not active. LINE_KEY_SCROLLING [YES | NO] This parameter defines whether scrolling for long line key labels is enabled. The default value is NO.
Create the device configuration file packets. If the value is -1, the 802.1P value is retrieved from the Service Package. The default value is 6. • x –– the value from -1 to 7 indicating the 802.1P value. DSCP_MEDIA [x] This parameter uses a value entered in decimal format between -1 and 63 representing the DSCP value in the Real-time Transfer Protocol packets. If the value is -1, the DSCP value is retrieved from the Service Package. The default value is 44.
Creating the provisioning files voice call. If the value is -1, the DSCP value is retrieved from the Service Package. The default value is 42. • x –– a value from -1 to 63 indicating the DSCP value. DSCP_MEDIA_IMMEDIATE [x] This parameter uses a value entered in decimal format between -1 and 63 representing the DSCP value in the provisioning packets for immediate precedence and priority level voice call. If the value is -1, the DSCP value is retrieved from the Service Package. The default value is 44.
Create the device configuration file RINGING_TONE [frequency1 | frequency2 | on_time | off_time] This parameter selects the tone advising the caller that a connection is made and a calling signal is applied to a telephone number or service point. You can select the country-specific tone. The default tone is the North American tone. • frequency1 – the frequency of tone 1. • frequency2 – the frequency of tone 2. • on_time – the duration of the tone when it is on. A -1 indicates a continuous tone.
Creating the provisioning files • on_time – the duration of the tone when it is on. A -1 indicates a continuous tone. • off_time – the duration when no tone is played. The IP Deskphone supports using WAV files to replace the ringtone Frequency/Cadence pattern. For a system-wide setting, the country default values can be used. NAT configuration commands NAT_SIGNALLING [NONE | SIP_PING | STUN] This parameter indicates the type of protocol used for NAT traversal in the signaling port.
Create the device configuration file STUN_SERVER_IP1[ip_address] NAT traversal using STUN protocol requires a STUN server in the public internet. Two STUN server IP addresses can be provisioned. • ip_address – is the IP address of STUN server 1. STUN_SERVER_IP2[ip_address] NAT traversal using STUN protocol requires a STUN server in the public internet. Two STUN server IP addresses can be provisioned. • ip_address – is the IP address of STUN server 2.
Creating the provisioning files (highest quality). Currently, default values are used based on VOCODER on a per-call basis as summarized below. • YES – enables the sending of the alert report based on the Listening R Value. • NO – disables the sending of the alert report based on the Listening R Value.
Create the device configuration file PACKET_LOSS_WARN [xx] This parameter is the threshold to send a report on Packet Loss greater than [xx]. The default is 256 (1%). Using a value of 0 resets the threshold to the default value. • xx – is an INTEGER value scaled by 256 that is used as the threshold. The range is 1 to 25600. PACKET_LOSS_EXCE [xx] This parameter is the threshold to send a report on Packet Loss greater than [xx]. The default is 1280 (5%).
Creating the provisioning files DELAY_WARN [xx] This parameter is the threshold to give warning on Excessive Delay greater than [xx]. The default is 150 ms. Using a value of 0 resets the threshold to the default value. • xx – is an INTEGER value used as a threshold measured in 1/1000 of a second. DELAY_EXCE [xx] This parameter is the threshold to report unacceptable Excessive Delay greater than [xx]. The default is 175 ms. Using a value of 0 resets the threshold to the default value.
Create the device configuration file A simple converter is available at the following site: www.unixtimestamp.org/ To reset the expiry date value, use the following format: ADMIN_PASSWORD_EXPIRY 0 HASHED_ADMIN_PASSWORD [YES | NO] This parameter indicates whether the Admin password is hashed or not. The default value is NO. • YES – Admin password is hashed. • NO – Admin password is not hashed.
Creating the provisioning files User Login commands AUTOLOGIN_ID_KEY[nn] [userID@domain name] This parameter is located within the IP Deskphone-specific configuration file. This is the ID the IP Deskphone uses to register. The default user ID is the MAC ID of the IP Deskphone. • nn — where nn = 01 to the maximum number of keys supported on the IP Deskphone • userID@domain name — the user ID must be followed by the domain name; for example, jsmith@company_name.com; example, 2247@company_name.
Create the IP Deskphone-specific configuration file AUTOLOGIN_AUTHID_KEY[nn] [xx] This parameter specifies the authentication name to be used for a specific key. • [nn] = the key number (01 – maximum number of keys supported on the IP Deskphone) • [xx] = the authorization ID for that key’s login • Create the IP Deskphone-specific configuration file If the IP Deskphone encounters a [USER_CONFIG] section while parsing the 11xxeSIP.
Creating the provisioning files far end. For example, you can key in the SIP address, jsmith@yourcompany.com to reach John Smith. When the IP Deskphone with SIP Software receives this address, the dialing plan is bypassed and the IP Deskphone uses the SIP URI to send a SIP INVITE to jsmith@yourcompany.com (INVITE sip: jsmith@yourcompany.com). Entering a SIP URI address, however, is inconvenient on an IP Deskphone with SIP Software unless a USB keyboard is attached.
Create the Dialing Plan file ([^4960]x{3})|([^4960]x{3})# && sip:$$@$n;user=phone && /* DIGITMAP: Private intra-company call, access code 6 */ (6[^10]x{6})|(6[^10]x{6})# && sip:$$@$n;user=phone && /* DIGITMAP: Public local call, access code 9 */ (9[^1]x{9})|(9[^1]x{9})# && sip:$$@$n;user=phone && /* DIGITMAP: Public national call, access code 61 */ (61x{10})|(61x{10})# && sip:$$@$n;user=phone /* DIGITMAP: Public international call, access code 6011 */ (6011x{7,15})|(6011x{7,15})# && sip:$$@$n;user=p
Creating the provisioning files There must be a domain name defined and the domain name can be represented by any variable. In the example given in Create the Dialing Plan file on page 123, the domain name is represented by $n. The variable definitions take the form: Figure 7: Sample dialing plan variable definitions For example: $1="avaya.com" $2="Avaya" $3="." $4="com" $5="Avaya.com" $t=10000 (default timer is 10 seconds) $a=Avaya.com The second section of dialing plan contains the digit map.
Create the Dialing Plan file The pound sign (#) at the end of the digit map causes the IP Deskphone to dial the matched dialing plan immediately. DRegex The Digit Regular Expression (DRegex) syntax is a telephony-oriented mapping of Portable Operating System Interface (POSIX) Extended Regular Expressions (ERE). Users must take care not to confuse the DRegex syntax with POSI EREs, as they are not identical. In particular, there are many features of POSIX EREs that DRegex does not support.
Creating the provisioning files Example Description *6[179#] Matches *61, *67, *69, or *6# x{10} Matches ten digits 011x{7,15} Matches 011 followed by seven to fifteen digits 91(x{10}) Matches 91 followed by ten digits • (x{10}) specifies the back reference variable, so $$ collects only ten digits (does not include the 91) • Example: 911234567890 is dialed $$=1234567890 (91x{10}) Matches 91 followed by ten digits • (91x{10}) specifies the back reference variable, so $$ collects all twelve digits
Chapter 7: Configure the DHCP Server The Avaya IP Deskphones support two basic Dynamic Host Configuration Protocol (DHCP) mechanisms to provide configuration information to the IP Deskphones. These mechanisms are the following: • Normal DHCP • DHCP VLAN phase Normal DHCP The normal DHCP is used to configure standard IP parameters such as IP address, NetMask, default gateway, and DHCP lease parameters. The message sequence consists of Discover, Offer, Request, and Acknowledge.
Configure the DHCP Server • The DHCP request contains standard IP Deskphone IP DHCP option requests from the point when the IP Deskphone does not receive the VLAN information. These options include the Vendor Specific and all Site Specific options. 2. The DHCP server receives the request. If the server is configured, the DHCP server returns a DHCP Offer message with a special text string in the Vendor Specific option or one of the Site Specific options.
Server to IP Deskphone options Option Description 12 Specifies the Hostname. By default, the Hostname is “T”+MAC Address; for example, T001765FDBF1D. The Hostname can be manually provisioned using the keypad. 53 Specifies the DHCP Message Type. 55 Specifies the messages to tell the server which options the IP Deskphone is requesting. It appears in the Discover and Request.
Configure the DHCP Server DHCP Option Description Router Option 3 Domain Name Server 6 Domain Name 15 Broadcast Address 28 Vendor Specific Option 43 DHCP Renewal Time 58 DHCP Rebinding Time 59 TFTP Server Name 66 Two forms of the server name are supported. If a dotted-decimal IP address is returned, it is assumed to point to a TFTP server. A full URL can also be provided to specify a protocol and FQDN.
Configure the DHCP server to support SIP IP Deskphone class identifier Deskphones. An IP Deskphone-aware DHCP server can automatically configure IP Deskphones by sending all information that the IP Deskphone requires. The IP Deskphone and the DHCP server communicate using a unique class identifier. After the IP Deskphone first sends the DHCP DISCOVER, it includes the Nortel-SIP-Phone-A ASCII string within the Vendor Class Identifier (Option 60).
Configure the DHCP Server class "11xx12xxSIP" { match if substring(option vendor-class-identifier, 0, 18) = “Nortel-SIP-Phone-A”; option tftp-server-name “http://< IP address>/ ″; } ... pool { range 192.168.xxx.xxx 192.168.xxx.xxx; allow members of "11xx12xxUNIStim"; allow members of "11xx12xxSIP"; } ... The following is an example of the similar handling but for the Open DHCP Server’s configuration file. OpenDHCPServer.ini … [GLOBAL_OPTIONS] SubnetMask=255.255.255.0 Router=192.168.1.
Configuration parameters Below is an example of the Linux dhcpd DHCPv4 server configuration file containing an example of site-specific option 224. The example option’s data configures the phone to enable the Bluetooth radio, disable the PC port, disable the USB interface and disable LLDP. dhcpd.conf … # This line sets the tag Avaya-Custom-Phone to the numeric option option Avaya-Custom-Phone code 224 = string; ...
Configure the DHCP Server Parameter Value Description Caution: Changing this parameter can impact network connectivity and can require manual correction. Important: Information is transferred in clear text when you provision this parameter using DHCP. eapid1 Character string from 4 to 20 characters 802.1x (EAP) device ID1. Caution: Changing this parameter can impact network connectivity and can require manual correction.
Configuration parameters Parameter Value Description dns2 Character string with a maximum of 50 characters Secondary DNS server URL lldp y for yes Enable 802.1ab LLDP. n for no Caution: Changing this parameter can impact network connectivity and can require manual correction. prov st Character string with a maximum of 50 characters Provisioning server URL. y for yes Enable stickiness. For an HTTP server, you must include "http://" in the URL. n for no cachedip y for yes Enable cached IP.
Configure the DHCP Server Parameter Value a for auto VLAN using DHCP Description lv for auto VLAN using VLAN Name TLV lm for auto VLAN using Network Policy TLV PC Port nis a for automatic negotiation Network port speed. 10 for 10 Mbps 100 for 100 Mbps Caution: Changing this parameter can impact network connectivity and can require manual correction. Important: You must select automatic negotiation when using Gigabit Ethernet (GigE) on Avaya 1120E/1140E/1150E IP Deskphone.
Configuration parameters Parameter Value Description dp Value from 0 to 8 802.1Q p bit for data stream. cdiff Value from 0 to 255 Diffserv code points for control messages. mdiff Value from 0 to 255 DiffServ code point for media packets. pcuntag y for yes Enable tag stripping on packets forwarded to PC port. Diffserv Codepoint n for no dscpovr y for yes DSCP Precedence Override n for no Miscellaneous bt (1100 only) Enable Bluetooth® (Avaya 1140E/1165E IP Deskphone only).
Configure the DHCP Server Parameter Value Description blt Value from 0 to 6 Backlight timer (Avaya 1100 Series IP Deskphones and Avaya 2007 IP Deskphone).
Configuration parameters Parameter Value Description Important: Information is transferred in clear text when you provision this parameter using DHCP. Warning: The provisioning data is transferred by DHCP, which is an unsecured protocol. Warning: Changing this parameter could impact the network connectivity and may require manual correction. The following table shows the dependencies between provisioning options.
Chapter 8: Install the IP Deskphone Complete instructions to install the IP Deskphone, including detailed figures and applicable warnings, are given in the IP Deskphones User Guides. The steps for installing the IP Deskphone are summarized in the following procedure. Installing the IP Deskphone 1. Remove the stand cover. Pull upward on the center catch and remove the stand cover. The cable routing tracks are now accessible. 2. Connect the AC power adapter (optional).
Release the tilt lever and continue to push the IP Deskphone towards the base until an audible click is heard. Ensure the IP Deskphone is securely locked in position. The following figure shows the connections on the IP Deskphone. Figure 9: IP Deskphone connections March 2015 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 9: Upgrade and convert the IP Deskphone software This chapter describes how to upgrade an IP Deskphone with UNIStim software to SIP Software. In order to upgrade an IP Deskphone with UNIStim software, first determine if you have the minimum UNIStim software release on the IP Deskphone (0625C39). If your IP Deskphone is installed with the minimum version of UNIStim software, proceed to the section Convert UNIStim software to SIP Software on the IP Deskphone on page 150.
Upgrade to the minimum UNIStim Software 7. Scroll down the page and click the desired version of software; for example, SIP1165e04.04.09.00.bin. The File Download window opens. 8. Click Save. The Save As window opens. 9. Select the location to save the file and click Save. 10. After the file has downloaded, place the file in the correct directory on the provisioning server. Modify the SIP provisioning file Use the following procedure to modify the SIP Provisioning file on the provisioning server.
Upgrade and convert the IP Deskphone software software from UNIStim to SIP, the UNIStim software version on your IP Deskphone must be 0625C39 or higher. Identify the current version of UNIStim software Checking the UNIStim software version on a new IP Deskphone 1.
Upgrade to the minimum UNIStim Software Table 11: Using the Navigation key cluster to navigate in the Local Tools menu Key Action Down Moves highlight down Up Moves highlight up Right Selected current menu item Left Closes menu Select key (center of cluster) Selects current menu item To close this menu, press the Quit key. 3. Select 2. Local Diagnostics in the Local Tools menu by pressing the key in the Navigation key cluster or by pressing the number 2. 4.
Upgrade and convert the IP Deskphone software Configuring the TFTP server 1. The IP Deskphone always executes the TFTP download at bootup if a TFTP IP address is configured on the IP Deskphone after being initiated by the telephony Call Server. 2. Go to the TFTP server and create the 11xxe.cfg provisioning file (for example; 1140e.cfg for 1140E IP Deskphones, 1120e.cfg for 1120E IP Deskphones). The 11xxe.cfg provisioning file is a clear text file. Create the provisioning file as shown in the next table.
Upgrade to the minimum UNIStim Software 5. Press the Apply context-sensitive soft key to save the configurations and reset the IP Deskphone. The IP Deskphone downloads the software file. The display shows [FW] reading… If the download is successful, the display shows [FW] writing… and the blue LED flashes. After the software image is downloaded to the IP Deskphone, the display shows [FW] finished..., the blue LED stops flashing, and the IP Deskphone resets.
Upgrade and convert the IP Deskphone software Convert UNIStim software to SIP Software on the IP Deskphone The IP Deskphone can be ordered with UNIStim software installed or with SIP Software installed. If an IP Deskphone is installed with UNIStim software, it runs with SIP Software only if the software is converted from UNIStim to SIP.
Convert SIP Software to UNIStim Software Perform the following procedure to convert the UNIStim software to SIP Software on the IP Deskphone. Converting UNIStim software to SIP Software using TFTP 1. Run the TFTP server (for example Tftpd32.exe). 2. Place software and configuration files in the folder of the TFTP server (for example 11xxe.img F/W file and 11xxe.cfg file) that contains the following lines: Table 14: Sample 11xxe.
Upgrade and convert the IP Deskphone software SIP, the UNIStim software is overwritten. To convert an IP Deskphone from SIP software to UNIStim software, a software reload is required. Reloading UNIStim software 1. Determine the appropriate UNIStim version to match the hardware release number of your IP Deskphone. There are different versions of UNIStim software available for download. Which version you choose depends on the hardware release number of your particular IP Deskphone.
Chapter 10: Provisioning the IP Deskphone Device Settings For provisioning the Device Settings parameters, the IP Deskphones support the following provisioning modes: • Manual provisioning • Automatic provisioning The IP Deskphone obtains configuration parameters that are defined as AUTO in the Auto Provisioning page from an 802.1ab switch (LLDP) or DHCP server. For more information, see Parameter source precedence rules on page 163.
Provisioning the IP Deskphone Device Settings Provisioning IP Deskphone parameters By default, the IP Deskphone can automatically provision most parameters. However, you can manually provision parameters. The Auto Provisioning page provides the selection to manually override the parameter. Use the Device Settings menu item to configure IP Deskphone parameters. Double-press the Globe key to open the Network menu and press 2 on the dial pad to open the Device Settings menu.
Configuring parameters automatically for the IP Deskphone group to group, while left/right navigation takes you from item to item). Press the Enter key to uncheck the parameter, making it "Manual" provisioned. 3. To exit and save, press the Config key to return to the Device Settings page, then press Apply. Configuring parameters automatically for the IP Deskphone About this task Perform the following procedures to configure all parameters or specific parameters using automatic provisioning. Procedure 1.
Provisioning the IP Deskphone Device Settings Key Description Left Go to previous item. Enter Select or clear the check box for item or group. Config Return to manual configuration page. AllMan / AllAut Context-sensitive. Set all items to manual (clear checkboxes) or auto (check all boxes). Cancel Exit Device Settings. The Auto page provides control over the auto-provisioning of the Device Settings parameters. The page’s items in order of appearance: 01. EAP Settings 02.
Manual provisioning parameters 20. 21. 22. 23. 24. Sip TCP Port Sip TLS Port Keep Alive Type Connection Keep Alive Register Retry Time Register Retry Max Time Login Notify Login Notify With Time IPv6 Enable FIPS Enable Manual provisioning parameters Use the Device Settings menu to manually provision the IP Deskphones. Double-press the Services key. You can press the number associated with the menu item or you can use the navigation keys to scroll through the list of items.
Provisioning the IP Deskphone Device Settings Key Description Enter Exit edit mode. OK Exit edit mode. BkSpc Backspace: delete highlighted characters or character to the left Clear Clear input field. Cancel Exit edit mode without saving changes. Table 17: Provisioning parameters legend Configuration menu item List each configuration parameter in the order it appears in the menu.
Manual provisioning parameters Config option Options or input Description Phone IP IP address IPv4 and IPv6 IP address. Note: Maximum of 2 Phone IP addresses can be configured (1 IPv4 and 1 IPv6). Net Mask Subnet mask IP Deskphone subnet mask. Note: IPv6 does not support Net Mask, however Net Mask is required for the IPv4 address in a dual mode. Gateway IP address IP Deskphone gateway IPv4 and IPv6 IP address. DNS IP1 IP address DNS server 1 IPv4 and IPv6 IP address.
Provisioning the IP Deskphone Device Settings Config option Options or input Description Voice VLAN No VLAN VLAN not used. Auto All telephony traffic transmitted on the telephony port is forwarded untagged. Includes: • DHCP—VLAN ID from DHCP Auto VLAN • LLDP VLAN Name—VLAN ID from LLDP VLAN Name TLV • LLDP MED—VLAN ID from Network Policy Discovery TLV. Manual VLAN ID entered 1 to 4094. checked Filter frames without Voice VLAN tag. Unchecked Process all frames.
Manual provisioning parameters Config option Enable Data 802.1Q Data VLAN Data Priority bits PC-Port Untag all Cached IP Ignore GARP Provisioning Options or input Description Force Half Forced half duplex. Checked 802.1Q header and features used. Unchecked 802.1Q not used. No VLAN Data VLAN not used. Enter VLAN ID VLAN ID entered 1 to 4094. Auto Use value from the info block or default of 7. 0 to 7 Force all priority bits to chosen value. Checked Removes the 802.
Provisioning the IP Deskphone Device Settings Config option PVQMon IP Options or input Description Password Password used by provisioning server to authenticate the IP Deskphone. Maximum number of characters is 99. IP address PVQM server IPv4 or IPv6 IP address. Note: Maximum of 1 PVQM server can be configured. NAT Traversal NAT Signal NAT method for SIP signaling. • None Note: • STUN IPv4 mode only (IPv6 disabled). NAT Media NAT method for media signaling.
Parameter source precedence rules Config option Options or input Description Failure Both Login Notify With Time Unchecked Configuration values for login banner with time notification. Enable Bluetooth (1120E/ 1140/1165E only) Checked Bluetooth is enabled. Unchecked Bluetooth is disabled. SSH-SFTP Checked SSH-SFTP is enabled. Unchecked SSH-SFTP is disabled. Checked SSH is enabled. Unchecked SSH is disabled.
Provisioning the IP Deskphone Device Settings The default value of the stickiness attribute is AUTO. If the provisioning parameter is AUTO, the IP Deskphone can receive the value from automatic provisioning sources based on the precedence rule. If you manually change the parameter, the attribute value is MANUAL. If the attribute is MANUAL, the provisioning information from automatic provisioning sources is ignored, except for the standard DHCP parameters.
Chapter 11: Features This chapter describes the features that are supported on the Avaya 1100 Series IP Deskphones with SIP Software. Voice Quality Monitoring Feature overview Proactive Voice Quality Monitoring (PVQMon or VQMon) allows the IP Deskphone with SIP Software to report voice quality statistics to a server in the network.
Features Server set-up The IP Deskphone with SIP Software works with Telchemy server software. The name of the software is SQmediator and is available through Telchemy (http://www.telchemy.com). The minimum version required is release 1.0. How VQMon works The IP Deskphone with SIP Software gathers statistics about the current call when VQMon is enabled. Statistics are also gathered regarding the quality metrics of the current call.
Multiuser Metric Description millisecond (8 sample) block. An MIU means a frame in the i200x implementation. MOS Mean Opinion Score. A subjective measurement of the voice quality of a voice call. MOS_CQ The VQMon conversational quality MOS score calculated for a call channel. MOS_LQ The VQMon listening quality MOS score calculated for a call channel. Packet loss rate The percentage of total packets loss versus packets received.
Features One account is considered a primary account and is used by default for most IP Deskphone operations. Each account is associated to a line key; the primary account is always on the bottom right line key of the IP Deskphone (this is the first key, Key 01), and an arbitrary key (including a key on an Expansion Module) can be selected for additional accounts.
Multiuser • Configure DOD_ENABLE to NO; a secondary user cannot log on if DOD_ENABLE is enabled. The default value is NO. • The SELECT_LAST_INCOMING parameter determines call selection when multiple calls are in the Ringing state. If you configure SELECT_LAST_INCOMING to NO, the first selected call remains the selected call as new calls are added to or drop from the list of ringing calls. If you configure this value to YES, the selected call becomes the ringing call last added to the list.
Features Figure 11: Example of secondary logon screens You can specify a Line Key for a new account. By default, the IP Deskphone selects the first unused key. If the IP Deskphone reaches the configured limit on concurrent logons and you select the Login command, an error message appears. During the logon operation, a Logging in user message appears on the IP Deskphone screen.
Multiuser Logging off The Logout command in the System submenu, prompts you to select an account, asks for confirmation, and then proceeds to log off the account. Logging off an account frees the corresponding Line key and does not require a password. Figure 12: Example of log off screens Consider the following when logging out of an IP Deskphone: • Unless the parameter LOGOUT_WITHOUT_PASSWORD is set to YES (default is NO), the phone prompts you for the User Password before logging off an account.
Features Server failover If the connection to your account proxy is lost, the IP Deskphone notifies your account and periodically attempts to reconnect. Some features, such as incoming calls, remain accessible for other accounts, but other features are not available until connection is reestablished or you cancel the reconnection. Cancelling the connection to your account is the same as logging off. If you are using the primary account, the IP Deskphone returns you to the initial logon screen.
Multiuser Figure 13: IP Deskphone with Expansion Module and multiple accounts Pressing a line key brings up a dialing prompt, initiates a call to a preselected target, or answers an incoming call. See Making a call on page 173. At select account prompts, such as the Logout screen or User Settings screen, pressing a line key highlights the corresponding account. See Account selection on page 181. The icon for each line key reflects the state of the account associated with that line key.
Features Receiving a call When you receive an incoming call, the account that the call is intended for is displayed on the IP Deskphone. The line key of that account displays the icon for an incoming call. You cannot use a different account to answer the call. If you are receiving multiple calls at the same time, a list of all active and incoming calls appears. If you select a specific call in the list, you can choose to answer or process that specific call.
Multiuser Figure 14: Example of the IP Deskphone with one call The following figure is an example of the IP Deskphone with multiple calls. Figure 15: Example of the IP Deskphone with multiple calls Instant messages You can only receive or send instant messages from the primary account. Incoming messages for secondary accounts are rejected, are not displayed on the screen, and are not added to the instant message logs.
Features select a registered account. After you select a registered account, a menu appears that lets you modify the settings of the account you selected. Per-account call notification options The Call Settings entry in the User Settings menu provides you with a number of configuration options relating to how incoming calls for a particular account are treated.
Multiuser The Do Not Disturb, Call Forward, and Presence keys are associated to a specific user account that you create, and determine which account status to affect. See User status on page 178. By default, pressing a Speed Dial programmed key initiates a call using the primary account. If you press a line key to obtain a dialing prompt, and then press a speed dial key, the IP Deskphone uses the account associated with that line key.
Features Address Books with Multiuser Each registered account can have a network-based Address Book. Each profile contains a local Address Book that is independent from all network Address Books. Accessing the Address Books, by pressing the Directory hard key from the Idle screen, displays the Address Book of the primary account. If the primary account does not have a network Address Book, the local Address Book is accessed.
Multiuser The following scenarios apply to DND. • If you select a single account that is in DND mode, the IP Deskphone displays a prompt that asks if you want to deactivate the DND mode. • If you select a single account that has Call Forwarding active, an error message appears to indicate that DND cannot be activated. • If you select the option all, and at least one account is not in DND mode, DND mode is activated for all accounts. If an account is in Call Forward mode, Call Forward is disabled.
Features • If the account is not forwarding calls to the programmed target, the account is set to forward calls to the given target, disabling DND if necessary, and overriding any other call forward target that is active for the account. After you press a forward all programmed key: • If all accounts are already set to forward calls to the key target, call forward is disabled for all accounts (behaves like the forward all option).
Multiuser all accounts. It is more effective to program a separate Presence key to set all accounts to the Connected state. Events that update presence states automatically occur for each account. For example, the On The Phone state is applied to any account that has at least one call active. Account presence is not retained after logging off or restarting the IP Deskphone. Notifications The IP Deskphone can spontaneously display messages on the screen to report events that you did not initiate.
Features Feature dependencies and restrictions The number of line keys on the IP Deskphone limits the number of accounts that you can register simultaneously. The IP Deskphone is limited to six accounts. Connecting an Expansion Module to the IP Deskphone increases the limit by 18, allowing for 24 registered accounts. Additional Expansion Modules do not increase the limit further. These are hard limits. Further restrictions may be imposed by the administrative policy.
Multiple Appearance Directory Number Multiple Appearance Directory Number The Multiple Appearance Directory Number (MADN) feature operates differently depending on the type of Communication Server. For instance, the MADN feature operates differently on the Communication Server 2000 than the Communication Server 1000. Communication Server 1000 CS 1000 Multiple Appearance Directory Numbers (MADN) provides the following features: • Several devices (TNs) share a common Directory Number (DN).
Features Figure 18: SCA MADN Multiple Call Arrangement Multiple Call Arrangement (MCA) MADN allows as in-progress calls as there are appearances of the DN: • A call on a DN appearance does not make other appearances busy (they can receive or make calls). • Activity on one DN appearance does not reflect on other appearances. • There is no simple method for a DN appearance to bridge into or pick up a call on another DN appearance.
Multiple Appearance Directory Number KEY 0 SCR 8000 KEY 1 HOT U xxxx The following example shows a TN configured for MCA MADN: TN 100 0 0 2 UEXT/SIPL With: SIPU user2 SCPW xxxx KEY 0 MCR 8001 KEY 1 HOT U xxxx Note: You must enter 8000/8001 as the Login ID and user1/user2 as the Authentication ID when you register to a corresponding user on an IP Deskphone.
Features Privacy access codes The privacy access codes are: PRV, PRLA, PRLC. For example: PRV = 191 PRLA = 192 PRLC = 193 If the initial state of the MADN group is nonprivate , the PRV access code is used to toggle between privacy on and privacy off. If the initial state of the MADN group is private, the PRLA access code allows bridging and PRLC closes it.
Images for the Avaya 1100 Series IP Deskphones • ss01sun.png • ss02boat.png • ss02ship.png • ss02sailboat.png These files are loaded into the IP Deskphone through a Universal Serial Bus (USB) flash drive or through the provisioning server and the 11xxeSIP.cfg file. See Create the SIP provisioning file on the provisioning server on page 46 for an example of the IMAGES section of the 11xxeSIP.cfg.
Features For example: • abig1_sunset001.png • abig1_sunset002.png • abig1_sunset003.png • abig1_sunset004.png • abig1_sunset005.png • abig1_sunset006.png • abig1_bckgrnd_sunset.png Speed Dial List When configured by provisioning, a feature key can be used as a "Speed Dial List". The feature key and the contents of the Speed Dial List must be specified by the provisioning mechanism.
Speed Dial List feature (greater than one (1) and less than or equal to the available number of programmable keys), the following events occur: 1. The IP Deskphone checks for a previously loaded "Speed Dial List" file (a file containing the contents of the speed dial list), which must be properly configured and uploaded to the IP Deskphone through provisioning. 2. The IP Deskphone parses the file, and configures the feature key specified by SPEEDLIST_KEY_INDEX to hold the Speed Dial List. 3.
Features Figure 21: Example of a Speed Dial List The Speed Dial List screen displays all the Speed Dial List entries provisioned for the user. The listed items displayed are based on the provisioned list as well as the current Idle or Mid-call state of the IP Deskphone. When the Speed Dial List is invoked while the IP Deskphone is idle, only Speed Dial List entries that are configured as IDLE are displayed.
Speed Dial List The following table describes the function of the context-sensitive soft keys for the Auto Retrieve screen. Table 21: Context-sensitive soft keys for the Auto Retrieve screen Context-sensitive soft key Action Yes Enables the Speed Dial Auto Retrieve behavior. No Disables the Speed Dial Auto Retrieve behavior. Back Dismisses the screen and returns you to the previous key programming screen.
Features The following is an example of a Speed Dial List file (for example, a file named speedDialList.txt) that must be loaded through provisioning. [key] label=S1 target=s1@avaya.com retrieve=YES mode=MidCallOnly type=spdial [key] label=S2 retrieve=NO mode=IdleOnly subject=subject2 target=s2@avaya.com type=spdial [key] label=S3 retrieve=NO target=s3@avaya.com Address Book Overview The IP Deskphone with SIP software supports two modes of the Address Book: 1.
Address Book Note: The MAX_ADDR_BOOK_ENTRIES parameter only applies to LOCAL Address Book mode. In NETWORK Address Book mode, the size of the Address Book is controlled through a service package. The MAX_DOWNLOAD_ADDR_BOOK_ENTRIES parameter specifies the maximum number of Address Book entries that can be downloaded from the network in LOCAL Address Book mode. The default value of this parameter is 1000 (permitted values are 0 to 1000).
Features Example The following is an example of the Address Book section of the device configuration file. #------Address book USER_FILE_ENABLE Y ADDR_BOOK_MODE LOCAL MAX_ADDR_BOOK_ENTRIES 1000 MAX_DOWNLOADED_ADDR_BOOK_ENTRIES 1000 DEFAULT_ADDRESSBOOK_FILE /Addressbook/addressbook.txt Roaming profiles Roaming profiles enable the user to obtain the same settings when they are logged on to multiple IP Deskphones for features such as Address Book, Programmable keys, and Speed Dial List.
Roaming profiles Address Book file The Address Book file represents each contact [contact] and each group [group] (name only). A contact provides attributes to specify a nickname, SIP address, group and whether the contact is a friend. The following is an example of the syntax. [version] id=12345 [contact] nickname=lpg address=lpg@abc_company.com group=abc_company buddy=1 [group] name=macadamian Custom keys file The Custom keys file enables programmable keys to be provisioned for the IP Deskphone.
Features The sections in the custom keys file can be in any order. Each section contains parameters and values. All parameters should contain values, except for the following: • banner • screensvrText • screensvrImage • backgroundImage • hotlineURL If a parameter has no value, its previous value is restored. For parameters which are allowed blank values, if the parameter is blank then the value is cleared. The custom keys file supports sections which contain user preferences.
Roaming profiles Section name Key Value example Description index 3 Key number; sequential, starting with the IP Deskphone, then the Expansion Module(s) label CallForward Text to be displayed for the key target *4 Information number to be sent to IP Office type feature Key type [prefs] Contains the main profile preferences.
Features Section name Key Value example Description hotlineURL 2600@mycountry.gov Target url for a hotline call. language English User interface language.
Roaming profiles Section name Key Value example Description 2 = FIRST_CHARCTER_SEARCH 3 = NAME_SEARCH [reasons] This section contains the list of reject reasons str-1 Out of office The key consists of prefix “str-“and the sequence number 0, 1… The value can be any string. str-2 Busy str-0 Hello!! [subjects] The key consists of prefix “str-“and the sequence number 0, 1… The value can be any string. str-1 Hi! The following rules apply to the [key] section: 1.
Features • note – for presence keys. Optional. The note to configure when the presence is changed; arbitrary text. An example of the syntax is provided below: [key] index=2 label=label1 target=lpgp@macmcs.madadamian.com type=spdial subject=my first call subject [key] index=4 label=label22 note=on vacation state=UNAVAILABLE type=presence Speed Dial List file The Speed Dial List file is used to populate the menu which appears when a Speed Dial List custom key is pressed.
Customizable banner for login • If a file is downloaded that places a custom key on a non-existent key - for example, Key 10 and the IP Deskphone does not have an Expansion Module attached, then the key is not shown. The key appears only when an Expansion Module is attached.
Features Figure 23: Login Banner The following table describes the function of the context-sensitive soft key for the Login Banner screen. Table 22: Context-sensitive soft key for the Login Banner screen Context-sensitive soft key Action Ok Completes the login process and dismisses the login screen. The following table describes the function of the Navigation keys for the Login Banner screen. Table 23: Navigation Key Action Up and down arrows Allows you to scroll up and down the banner text.
Busy Lamp Field Key or action Result Headset Brings up the dial prompt (in case the user wants to place an emergency call). Hold No action. Dialpad No action. Handsfree Brings up the dial prompt (in case the user wants to place an emergency call). Off Hook Brings up the dial prompt (in case the user wants to place an emergency call). Mute No action. Volume up and volume down No action. User-defined feature keys No action.
Features How it works If you configure an IP Deskphone to monitor a list of zero or more extensions, it sends a SUBSCRIBE SIP message to the server. A NOTIFY SIP message, which includes XML in the message body, is sent to the subscriber to advise the subscriber of the current state of the extension being monitored. Once the status of the monitored extension changes, the subscriber receives a NOTIFY SIP message from the server.
Universal Serial Bus device support aggregating mechanism, the user would have to generate a SUBSCRIBE request for each resource they monitor. A resource list is identified by a URI, and it represents a list of zero or more URIs (SIP endpoints). Each URI is an identifier for an individual resource to which the user can subscriber.
Features Important: During software upgrade, the IP Deskphone goes into the Do Not Disturb (DND). The IP Deskphone cannot receive any incoming calls, or make outgoing calls, until the software upgrade is complete and the IP Deskphone restarts. USB port behavior By default, the Avaya 1100 Series IP Deskphones start with the USB port and all the supported USB devices enabled.
Universal Serial Bus device support After you have configured the IP Deskphone to manually override the USB device setting, the USB lock configurations from the device configuration file are ignored and the configurations stored in the IP Deskphone are used. If you later decide to not allow manual override, you have to access the IP Deskphone to reset it individually.
Features Figure 26: Sample USB Devices information menu USB lock Although the USB port allows the IP Deskphone to extend peripheral support without hardware changes, the customer is required to lock the USB port in compliance with the corporate security policy. The lock can be applied on the USB port to disable all USB devices, or it can be applied on individual types of USB devices. USB Locks preference menu You can override the system configurations on the IP Deskphone through the USB Locks screen.
Universal Serial Bus device support Figure 27: USB Locks screen The following table describes the options that are listed on the USB Locks screen. Table 26: USB Locks screen options USB Locks options Description USB Locks Override • Enables or disables the USB lock configurations from the device configuration file. • If USB Locks Override is not checked, the remaining items on the list appear dimmed and the configurations from the device configuration file are used.
Features USB Locks options Description Lock USB Keyboard • The checkbox is used to lock or unlock the USB Keyboard. (only if Enable USB Port is checked) • Reboot is not required for change to take effect. Disable USB Headset (only if Enable USB Port is checked) • The checkbox is used to lock or unlock the USB Headset. • A change from unlock to lock USB Headset triggers an optional reboot request in order to remove the USB headset driver.
Hotline service Figure 28: Warning screen USB flash drive SIP Software supports a standard USB flash drive for the IP Deskphone. File system support is restricted to FAT file system with a long file name (Microsoft VFAT). The file system supports a USB memory stick with 8G or less. USB headsets USB headsets are supported Avaya IP Deskphone 1100 Series IP Deskphones. The Avaya IP Deskphone 1100 Series IP Deskphones support Wideband audio on USB headsets.
Features Making a Hotline call A call to a Hotline target is automatically placed when an off-hook condition occurs, or when you press digits during idle on-hook, and then lift the handset. Hotline Service allows only one hotline user to login to the Hotline Phone. The Multiuser Login feature is restricted to one user only. Hotline service restrictions Because the Hotline Phone is a dedicated IP Deskphone used only for Hotline service, certain features are restricted on the Hotline Phone.
Session Timer Service Table 28: Hotline Service configuration parameters Parameter name Description Default HOTLINE_ENABLE Indicates if Hotline Service is enabled or disabled. No (indicates that Hotline Service is disabled) HOTLINE_URL Used as To field of INVITE message by the SIP IP Deskphone to notify the Proxy Server that this is a call from a Hotline Phone. The HOTLINE_URL is not a real URL of the Hotline target. The IP Deskphone has no idea about the Hotline target.
Features Min-SE header The Min-SE header indicates the minimum value for the session expiration in units of delta-seconds. When your make a call, the presence of the Min-SE header informs the terminating endpoint, and proxies, of the minimum value that the originating endpoints accept for the session timer duration in units of delta seconds. When present in a 422 response, the Min-SE header indicates the minimum session value the terminating endpoint accepts.
Emergency Services Parameter name Description Default value SET_RESP_REFRESHER Indicates what refresher value is configured in the 200 OK response. Value 0 indicates that the refresher is omitted (only valid when SET_REQ_REFRESHER is not equal to 0); value 1 indicates that the refresher is configured to UAS; value 2 indicates that the refresher is configured to UAC.
Features Location information If the IP Deskphone turns on or off, the IP Deskphone restarts in the usual way and receives the location information through LLDP-MED or DHCP protocols (from the Layer 2 switch or DHCP server , which must be available and properly configured). On certain Call Servers that support service packages , a list of locations is sent to the IP Deskphone and the end user is able to select the location during the login process.
Emergency Services Table 30: E911 Configuration in the IP Deskphone Config file E911_USERNAME The emergency user name used for making an emergency call that does not require a logon. You must configure the proxy with the same emergency user name, otherwise, the emergency call fails. E911_PROXY Default emergency proxy.
Features 2. Adding the emergency user to the IP Deskphone configuration file. • The IP Deskphone must have E911_USERNAME, E911_PROXY, and E911_PASSWORD configured for making emergency calls. • The IP Deskphone must have a specified proxy that contains a user record with the specified user name and password. • The IP Deskphone must have these values for automatic REGISTER of the emergency user (if you choose this way of implementation).
NAT firewall traversal • is not notified of incoming calls and cannot accept incoming calls. Incoming calls receive a call waiting tone. • cannot transfer, join, or conference the emergency call, place the emergency call on hold, or park the emergency call. • cannot auto-retrieve a parked call and auto-retrieval of parked calls is not displayed. • cannot disconnect the emergency call. Only an emergency center or operator can disconnect the emergency call.
Features The server returns Binding Response packets, which tell the IP Deskphone the public IP address and port number from which it received the Binding Request. The IP Deskphone knows the private IP address and port number it used to send the Binding Request, and therefore, it learns the mapping between the private and public address space being performed by the NAT. If the Binding Response packets indicate the same address and port number as the request, the IP Deskphone knows no NATs are present.
Three-port switch and VLAN functionality Figure 29: Voice-VLAN and Data VLAN Table 31: Port functions on the three-port switch when VLAN is enabled Ports Voice VLAN enabled Data VLAN enabled Both Voice and Data VLAN enabled Network Port N/A N/A N/A Receiving the frames with Voice VLAN tagged only. N/A Receiving the frames with Voice VLAN tagged only. (Port 0) IP Deskphone Port (SMP) Sending the frames with Voice VLAN tagged. Sending the frames with Voice VLAN tagged.
Features Ports Voice VLAN enabled Data VLAN enabled other than Data-VLAN and forwarding it to network port. Both Voice and Data VLAN enabled Data-VLAN and forwarding it to network port. Sending all kinds of frames. Sending all kinds of frames. VLAN configuration can be done either manually or through DHCP. See Provisioning IP Deskphone parameters on page 154 for more detail on configuring VLANs. 802.
802.1ab Link Layer Discovery Protocol Authorization If 802.1x is configured and the IP Deskphone is physically connected to the network, the IP Deskphone (supplicant) initiates 802.1x authentication by contacting the Layer 2/3 switch (authenticator). The IP Deskphone also initiates 802.1x authentication after the Ethernet connection (network interface only) is restored following a network link failure.
Features • Implementation of behavioral requirements specified by Link Layer Discovery Protocol Media Endpoint Discovery (LLDP-MED). • Storage of received data in local data structures, for example, in MIB modules. TLVs The information fields in each MIB are contained in a Link Layer Discovery Protocol Data Unit (LLDPDU) as a sequence of short, variable-length, information elements known as TLVs that each include type, length, and value fields.
802.1ab Link Layer Discovery Protocol Receive direction The IP Deskphone expects to receive the following TLVs: 1. Chassis ID 2. Port ID 3. Time To Live 4. End of LLDPPDU 5. System Capabilities 6. VLAN Name 7. MAC/PHY Configuration Status 8. LLDP-MED Capabilities 9. Network Policy 10.
Features TLV Fields If you disable the PC Ethernet port, the advertised enabled capabilities configured to Telephone only. Port VLAN ID PVID = 0 The IP Deskphone does not support port-based VLAN operation. Port And Protocol VLAN ID PPVID = 0 VLAN Name VLAN name field is configured to “data” and “voice”. Protocol Identity Port and Protocol VLAN is not supported and not enabled. 1. STP: Protocol identity = the first 8 bytes of an STP PDU starting with the Ethertype field.
802.
Features TLV Fields Although location is received, it is not available to end user in this release of the SIP Software. Extended Power-via MDI Discovery Power Type = 01–PD Device Power Source = 00–Unknown. There is no hardware support for determining the power source. Power Priority = 0010–High Power Value = Maximum power required as shown below: 1120E NTYS03 = 8 1140E NTYS05 = 8 1165E NTY507 Software Revision Configure to the software version being used, for example, 0604D97.
PC Client Softphone interworking Pre-granting authorization for the Answer-Mode The user must specify which users or groups of users are authorized to request auto-answer. The user can grant authorization through the Feature Options menu if the interworking feature is enabled in the user’s IP Deskphone device configuration. The user can enable and disable one or more of the following groups: • Allow Public—Authorizes anyone on the internet.
Features Figure 30: Answer-Mode Settings screen Allow-Mode Settings screen The Allow-Mode Settings screen allows you to disable the feature, and to allow automatic requests for Friends, Directory, or Public users. To access the Allow-Mode Settings screen, on the Preference menu, choose Feature Option, Answer-Mode Settings, and Allow Mode. The following screen appears.
PC Client Softphone interworking sipuser@sipdomain.com • SIP domain For example: sipdomain.com (all users from sipdomain.com • IPv4 address of a SIP domain For example: 172.25.20.20 • IPv6 address of a SIP domain For example: 2001:db8::57ab The user can add as many entries as the device configuration allows. If the Add soft key is disabled, then the user has reached the maximum number or entries. The user can also edit and delete entries.
Features Figure 33: Allow Addresses screen with domains and SIP addresses Automatically answering a call With the interworking feature enabled, the IP Deskphone can answer automatically, manually, or reject an incoming auto-answer request. If the request is valid and the user is authorized to make the request (see Pre-granting authorization for the Answer-Mode on page 229), the call is answered automatically.
Multi-Level Precedence and Preemption Configuring the PC Client Softphone Enabling the interworking feature in the IP Deskphone device configuration file allows the user to pre-grant authorization to other users and to configure the IP Deskphone to auto-answer.
Features Once the precedence level for a call has been set, the precedence level for that call cannot be changed. Precedence calls cannot be placed to clients that are using SIP software earlier than SIP 3.1. Precedence level for a call is set either at the IP Deskphone used by the user or through the World Wide Numbering Plan at the Local Session Controller (LSC) Assured Real-Time Services-Avaya Aura® Application Server 5300.
Multi-Level Precedence and Preemption If the MLPP_NETWORK_DOMAIN value does not match any of the values listed in the preceding table, then the list of precedence levels specified for the DSN Network Domain is applied. Preemption Higher precedence calls preempt calls lower in precedence when a user has no free call appearances.
Features If the new password is entered correctly, the call is placed and the password is updated on the IP Deskphone. If an incorrect password is entered, then an error message is displayed, the user hears a busy tone, and the IP Deskphone returns to the idle state. Speakerphone Exclusive to 911 Emergency If this feature is enabled, speakerphone is allowed only for making 911 Emergency calls. The speakerphone restriction is applicable to both the Handsfree key and line keys.
Multi-Level Precedence and Preemption Feature Interaction with MLPP Call Transfer — Consultative Available. A consultation call can have its own precedence level. The transferred call uses the greater precedence level of the initial call and the consultative call. Conference call (Ad-hoc conference) Available. The precedence level of the conference is the highest precedence level of all the joined calls. Call Waiting Disabled Not available when MLPP is enabled.
Features Parameter Description Default DOD_ENABLE [YES | NO] Identifies whether it is DoD ARTS network. NO MLPP_NETWORK_DOMAIN [] The network domain of the user to be added to the INVITE message of outgoing calls. DSN MLPP_PRECEDENCE_DOMAIN [x] The local precedence domain of the user to be added to the INVITE message of outgoing calls. 000000 MAX_APPEARANCE [x] The maximum number of call appearances a single user can have. 10 CALL_WAITING_TONE [0|1] Configures the call waiting tone.
Server Profiles If the IP Deskphone attempts to log on using these configured addresses and fails to do so, the IP Deskphone then tries to discover the IP addresses using DNS. If there is no primary or secondary SIP domain IP address configured, then the IP Deskphone uses DNS to determine the IP address. If only SERVER_IP[x]_2 is configured (SERVER_IP[x]_1 is 0.0.0.0), then DNS Lookup is used first; if DNS Lookup fails, only then is the secondary IP address tried.
Features configured separately by updating configuration parameters contained in the System Configuration file with values taken from the Server Profile configuration file. Server Profile parameters are always applied on top of the System Configuration file.
Server Profiles The Server Profile option is implemented using the following command parameters: • PRIMARY_SERVER_PROFILE • SECONDARY_SERVER_PROFILE The commands are processed as follows: 1. If the x_SERVER_PROFILE command is specified and contains the x Server Profile , the Server Profile file is downloaded to the IP Deskphone during the standard upgrade mechanism after downloading the System Configuration file.
Features MLPP_NETWORK_DOMAIN SESSION_TIMER_MIN_SE PCPORT_ENABLE MLPP_PRECEDENCE_DOMAIN SET_REQ_REFRESHER LLDP_ENABLE SNTP_ENABLE SET_RESP_REFRESHER EAP IPV6_ENABLE DOD_ENABLE EAPID1 IPV6_STATELESS SLOW_START_200OK EAPID2 SIP_TCP_PORT MAX_APPEARANCE EAPPWD SIP_TLS_PORT USE_PUBLISH_FOR_PRESENC E Managing Server Profile files To download a new Server Profile file, the Server Profile parameters must first be configured in the System Configuration file and provisioned in the Device Configura
Server Profiles If the AUTOLOGIN_ENABLE parameter in the profile is configured as 2 (or USE_AUTOLOGIN_ID), the IP Deskphone performs a soft reset. After the soft reset, users specified by the AUTOLOGIN[_ID_KEY|_AUTHID_KEY|_PASSWD_KEY] configuration parameters are logged in. If the profile does not contain the AUTOLOGIN_ENABLE parameter, the parameter from the System Configuration file is used.
Chapter 12: IP Deskphone restrictions Service package restrictions A limited number of Call Servers support the service package. The service package is a means of providing configuration settings to the IP Deskphone. Individual features and feature restrictions are sent to the IP Deskphone as a part of the service package every time a particular user logs on to the IP Deskphone.
Chapter 13: Security This chapter describes the following security features: • SIP over TLS • Connection persistence • SRTP • SFTP • SSH • Last successful or unsuccessful logon • Enhanced administrative password security • Debug port security SIP over TLS To avoid security problems such as message integrity attacks, SIP over TLS uses Transport Layer Security (TLS) to provide secure communication between the Avaya 1100 Series IP Deskphone and the SIP proxy.
Security The IP Deskphone establishes connection with the proxy using the commonly accepted ports. Periodically, based on a configured timer value, the IP Deskphone issues a request to the server to verify that the connection with the server at the TCP level is still active. When the IP Deskphone discovers that the keep-alive packet has not been answered, it attempts to reestablish a connection with the proxy.
TCP/TLS operation overview Parameter Description Deskphone SSH or SFTP. Default value Boundaries Password The password that must be entered when connecting to the IP Deskphone through SSH, SFTP. None Non-null string Maximum: 11 characters UI Properties for Device Settings SSH and SFTP parameters are as follows: • The User ID field is empty and the Password field displays "****" when both SSH and SFTP are disabled and applied. • The user can enable SSH or SFTP.
Security How the IP Deskphone uses TLS Transport Level Security (TLS) is a protocol for establishing a secure connection between two endpoints. After a connection is established using TCP, TLS negotiates the cryptographic parameters used to secure the traffic that is sent over that connection. TLS, Public Key Cryptography, and X. 509 certificates provide either mutual or server authentication.
IP Deskphone configuration Certificate requirements For the IP Deskphone to validate that the server certificate provided by the TLS-enabled proxy matches the connected address, the certificate must contain the IP Addresses of the IP Deskphone. The server certificate has a Subject Alternative Name field, which contains the IPv4 and IPv6 IP addresses that correspond with the proxy. For example: subjectAltName=IP:192.168.100.
Security Parameter SERVER_TCP_PORT5_ 1 Purpose Default Allowed Configures the local SIP listening ports. After you change the listening ports parameters through the Check For Updates functionality, you must restart the IP Deskphone to apply the modified values. UDP: 5060 Integer Configuration values that affect connection persistence.
IP Deskphone configuration Parameter Purpose KEEPALIVE_RETRIES Default Allowed 3 Min: 0 Max: 10 See Managing connection persistence on page 258. SRTP_ENABLED SRTP_MODE SRTP configuration values. No BE-2MLines BE-2MLines BE-Cap Neg SecureOnly SRTP_CIPHER_1 SRTP_CIPHER_2 Allows configuration of the preferred order for SRTP cipher offers.
Security Parameter Purpose Default Allowed After a change is detected in this parameter, the system resets. SSHID Configuration of the SSH and SFTP user ID. None See Note 3. SSHPWD Configuration of the SSH and SFTP password. None See Note 3. HASHED_ADMIN_PASS W ORD Indicates whether the Admin Password is hashed or not. NO YES ENALBE_LOCAL_ADMI N_ UI Configures the availability of the local administration UI on the IP Deskphone. YES HASH_ALGORITHM Hash algorithm.
Manually configure the IP Deskphone for UDP and TCP Parameter Purpose longer valid, and a new password must be downloaded from the provisioning server. Default Allowed 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 read and write patterns. Example of valid formats: SFTP_READ_PATTERNS: cfg,.rel,.re2,.re3,.dat SFTP_WRITE_PATTERNS: cfg,.txt,.wr1,.wr2 Example of an invalid format: .cfg, .
Security Note: Disabling the local administration user interface drastically reduces the ability to view or edit the configuration of the IP Deskphone, and almost completely removes the ability to diagnose any communication or configuration errors in the field. However, disabling the local administration user interface increases the security of the IP Deskphone because the user is not able to view the configurations or make changes. Configuring the domain protocol 1. Press the Globe key twice. 2.
Using the TLS to connect to the SIP proxy Using the TLS to connect to the SIP proxy The IP Deskphone can establish a connection with the proxy after the appropriate configurations are made for the TLS. After the IP Deskphone registers with the SIP Proxy, the user can detect if a secure connection is established by the presence of a security icon (padlock) on the idle screen.
Security Configuration Result Idle Screen Security Icon Display No – if fall back to TCP or UDP occurs None : unsupported Unsupported Unsupported Unsupported configurations cannot be saved. If the configurations are unsupported, the IP Deskphone displays an error message. The following is an example of an error message for unsupported configurations: Unsupported: UDP + TLS Unsupported: No protocols enabled.
Registration behavior based on configuration settings Configurati on + TCP + TLS Description Expected result Possible results IP Deskphone: TLS only Server: UDP + TCP + TLS The IP Deskphone only has TLS configured for sending requests to the server. The IP Deskphone must have a device certificate installed if the server is configured for mutual authentication. The IP Deskphone registers using SIP over TLS.
Security Managing connection persistence The IP Deskphone attempts to establish and maintain a persistent connection with the proxy when TCP and TLS are active protocols. After this connection is established, the IP Deskphone sends all outgoing connections over this persistent connection. SIP IP Deskphones and servers, which use UDP to communicate, listen for incoming connections on known ports, and originate each request on a randomly selected UDP port.
SRTP Table 37: Connection timers definitions and allowed values Parameter name Description OS Keep-alive only Selecting this value causes the Not checked OS TCP Keep-alive functions to be used instead of the CRLF ping/pong mechanism. Some system deployments may prefer the lighter weight TCP keep-alive Checked Keep-alive This is a value, measured in seconds, that the IP Deskphone uses when a connection to the server is established using TCP or TLS.
Security Media security — SRTP Secure RTP (SRTP) encrypts the media path between two end-points. After both end-points agree on the necessary parameters to encrypt and decrypt audio packets, the voice path between them is established. SRTP is configured on the IP Deskphone to provide multiple levels of protection. The following table highlights the two cipher suites that are used and their related parameters.
SRTP Available SRTP configurations are provided in the following table. Table 39: Configuration effects on media security display Configuration Result Media Security Icon Display (during active call) Default: UDP + TCP, no SRTP SIP is unsecured; media is unsecured. No UDP + TCP. Best-Effort SRTP SIP is unsecured; media is No encrypted, but due to transmission of crypto parameters in clear text, the media cannot be considered secure.
Security Note: The FAST_EARLY_MEDIA_ENABLE option must be set to NO to support SRTP. Last successful or unsuccessful logon You can configure the IP Deskphone to provide the user with logon feedback regarding the last successful logon or the last unsuccessful logon, and provide the local time at which logon feedback was logged (assuming that the IP Deskphone has the correct time configured).
Last successful or unsuccessful logon Figure 39: Basic login notification The following notification appears on the display screen when the user successfully logs on when Login Notify with Time is enabled. Figure 40: Basic login and time notification The following notification appears on the display screen to notify the user of the last unsuccessful log on attempt made. March 2015 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Security Figure 41: Login failure notification The following notification appears on the display screen to notify the user of the date and time of the last unsuccessful log on attempt made. Figure 42: Login failure with time notification The following notification appears on the display screen to notify the user of the last successful and unsuccessful log on attempts made. 264 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Enhanced administrative password security Figure 43: Login and login failure notification The following notification appears on the display screen to notify the user of the date and time of the last successful and unsuccessful log on attempts made. Figure 44: Login and login failure with time notification Enhanced administrative password security The provisioning server can provide additional security associated with the administrative password.
Security the administrative server. Password expiry can only be enforced if the date and time are retrieved by the IP Deskphone through SIP, SOAP, or SNTP. Important: IP Deskphone licensing information is located in the Keycode Retrieval System (KRS) User Guide. You must register for access to KRS. File Manager interface A File Manager interface allows a user to use a USB drive to copy files from the flash file system of the IP Deskphone.
Debug port security When the Debug port option is disabled, and a dongle is connected to the IP Deskphone, the dongle is disabled from the very start of VxWorks and neither input nor output debug information is available. If an Expansion Module is connected to the AEM port, it is recognized and is fully functional (EXP_MODULE_ENABLE parameter must be set to YES). When the Debug port option is enabled, the debug port of the IP Deskphone can be used for connecting a debug dongle.
Chapter 14: Audio codecs The optional audio codecs feature allows you to select the audio compression or decompression algorithm (codec) used on the IP Deskphone. You provision codecs using the Device Configuration file, and then the user can select from the provisioned codecs using the Audio menu on the IP Deskphone. This feature supports wideband audio performance, where wideband is defined as the frequency range between 150 and 6800 Hz.
Codec preference through the Device Configuration file Table 41: Static payload types and other parameters for the supported codecs for the IP Deskphone Codec Payload type SDP encoding name Clock rate (HZ) G.711 a-law 8 PCMA G.711 u-law 0 G.729A + 40ms ptime 18 G.729B 18 G.722 (1100 series only) 9 G.723.1 4 Bit rate (kbps) Default ptime (msec) Channels 8000 20 1 PCMU 8000 20 1 G729 8000 20 1 8000 8 20 1 G722 8000 48 20 1 G723 8000 5.3 30 1 30 1 6.3 G.723.
Audio codecs Two fields in the device configuration file, G729_ENABLE_ANNEXB and G723_ENABLE_ANNEXA are used to enable or disable AnnexB and AnnexA support by G.729 and G.723 codecs, respectively. These flags can have the following values: YES, NO (No is the default value). Important: If codecs are not specified, the default list used by the current version of the IP Deskphone is PCMU, PCMA, G.729.
Codec preference selection on the IP Deskphone Codec preference selection on the IP Deskphone The Audio Quality Settings screen on the IP Deskphone allows the user to select an exact codec by name. This grants the user full control over the audio settings used for inbound and outbound calls. The list of codecs is populated with the names of the codecs provided during Device Configuration. If a text descriptor is provided for a codec in the Device Configuration file, it appears after the codec name.
Audio codecs Note: The user-defined order of the codecs can be specified/changed by means of the Custom keys file through the section [audiocodecs]. See Custom keys file on page 195. When the IP Deskphone downloads the Custom keys file, the IP Deskphone performs the following actions: • The IP Deskphone parses the section [audiocodecs] from the Custom keys file.
Chapter 15: Certificate-based authentication Certificate-based authentication Certificate-based authentication allows the administrator to ensure that the IP Deskphone is authorized to access the enterprise LAN environment and to connect securely to: • SIP proxy using TLS • Provisioning servers using HTTPS • EAP service using EAP-PEAP, EAP-TLS Certificates bind an identity to a pair of electronic keys that are used to encrypt and sign digital information, and make it possible to verify someone’s claim that
Certificate-based authentication Trusted certificates are installed on the Deskphone using [USER_KEYS] section of the configuration file. They are used for establishing SIP-TLS and HTTPs and use a PEM certificate format. Device Certificates are used to establish mutual authentication. They are installed on the Deskphones using [DEV_CERT] section of the configuration file. Device certificates use a password-protected PKCS#12 file device certificate.
Trusted Root certificate Trusted root certificate installation You can install one or more customer root certificates on the IP Deskphone by using the configuration file 11xxeSIP.cfg. • The [USER_KEYS] section is added to the configuration file 11xxeSIP.cfg to download a customer root certificate from a provisioning server. For example: [USER_KEYS] DOWNLOAD_MODE AUTO PROTOCOL HTTPS FILENAME custroot.
Certificate-based authentication • CUST_CERT_ACCEPT parameter is a Security Policy Parameter to disable Customer Certificate file signing. • CUST_CERT_ACCEPT – VAL_NO_CHECK parameters only controls further signing of customer root certificates. The first Certificate must be either signed by Avaya Trusted Certificate or Finger Print Accepted. Caution: There is a security risk in not having the Trusted Certificates loaded with VAL_NO_CHECK.
Installing a device certificate using PKCS12 Note: The PKCS#12 password cannot exceed 12 characters in length and must include only characters that you can enter on the IP Deskphone. These characters include all numbers, upper and lower case letters, and the following special characters: _ - . ! @ $ % & + : ^. Installing a device certificate using PKCS12 Use the following procedure to install a device certificate using a PKCS#12 file. Installing a device certificate using PKCS12 1.
Certificate-based authentication 4. Enter the PKCS#12 protected password. 5. The IP Deskphone validates the device certificate to ensure the following: • the correct password is entered • key size is >= to the value specified in the Security Policy File • key algorithm is RSA • the certificate is not revoked • the certificate is not expired 6.
Certificate Trust List The parts are appended together with the Validity periods first, followed by the certificates, and then by the digital signature. The signature must be in the form of a PKCS7 detached signature of the file in PEM format. A detached signature is a signature that does not embed the content that is signed. The IP Deskphone does not accept unsigned CTL files. After a CTL file is accepted, the included certificates are added to the trusted certificate store of the IP Deskphone.
Certificate-based authentication Installing a Certified Trust List About this task The IP Deskphone uses the Certified Trust List (CTL) method to verify the various network elements, such as proxy servers and provisioning servers. Procedure Add the [CTL] section to 11xxeSIP.cfg to allow the IP Deskphone to download a CTL file. After the 11xxeSIP.cfg file downloads from the provisioning server, the IP Deskphone executes the [CTL] sections and downloads the CTL file.
Certificate administration Certificate administration The administrator can view and delete certificates and CTLs. Because a certificate can be deleted, it is critical that the administrator password used to access this function is protected and limited to only those who require it. Certificate administration is accessed through the Diagnostics menu . To view the Certificate Administration option in the Diagnostics menu: 1. Create Security Policy file (a text file). 2.
Certificate-based authentication Figure 46: Certificates Administration main menu The following table describes the function of the context-sensitive soft keys for the Certificates Administration screen. Table 44: Context-sensitive soft keys for the Certificates Administration screen Context-sensitive soft key Action Select Selects the required option. Back Returns you to the Diagnostics menu.
Certificate administration Table 45: Context-sensitive soft keys for the Trusted Certificates screen Context-sensitive soft key Action View Displays the information of the selected Trusted Certificate which includes the following: • Common Name (CN) • Serial Number (SN#) • Expiry Date • Certificate Status (such as OK or Expired) Back Returns you to the previous screen.
Certificate-based authentication Figure 49: Device Certificates screen The administrator can delete the certificate in the details screen by using the Delete contextsensitive soft key. Deletion does not happen automatically; the IP Deskphone displays a warning confirmation screen. The following table describes the function of the context-sensitive soft keys for the Device Certificates screen.
Certificate administration The administrator can delete the certificate in the "Detailed Mode" by using the Delete contextsensitive soft key. Deletion does not happen automatically; the IP Deskphone displays a warning confirmation screen. CTL screen The CTL screen displays a list of subject Common Names (CN) of the CTL certificates as shown in the following figure: Figure 51: CTL certificate screen The following table describes the function of the context-sensitive soft keys for the CTL screen.
Certificate-based authentication Figure 52: CTL Certificate details screen You can use the PDT shell command to view an installed CTL. The following is an example of a command with the output of the command. Figure 53: Example of command output Important: The CTL file size must not exceed 20 Kbytes. CRL screen The CRL is also used to validate a certificate before the IP Deskphone starts to use it by checking it against the CRL lists stored in the phone.
Security Policy When CRL is selected from the Certificates Administration menu, the CRL screen displays a list of all serial numbers in the CRL loaded on the phone. Figure 54: CRL screen The following table describes the function of the context-sensitive soft keys for the CRL screen. Table 49: Context-sensitive soft keys for the CRL screen Context-sensitive soft key Action Back Returns you to the previous screen.
Certificate-based authentication Security policy parameters The security policy file parameters and the excepted and default values are as follows: CERT_ADMIN_UI_ENABLE This parameter determines if the Certificate Administration user interface is enabled on the IP Deskphone. The acceptable values are as follows: • YES – Certificate Administration user interface is enabled on the IP Deskphone. • NO – Certificate Administration user interface is disabled on the IP Deskphone (default).
Security Policy plan file. You cannot override the file signing of the Security Policy and Customer Certificates. The acceptable values are as follows: • YES – Signing is required. • NO – No authentication check is performed (default). FP_PRESENTED If the resource file is not signed and if there are no customer certificates, then you are prompted with a Finger Print display with accept or reject options.
Certificate-based authentication • LOG_EXPIRE – A certificate is not deleted when it expires A security log entry is added. Note: Even though the certificate is not deleted, it still cannot be used to authenticate a file. • NO_EXPIRE_LOG –A certificate is not deleted when it expires. A security log entry is not added. Note: Even though the certificate is not deleted, it still cannot be used to authenticate a file.
Security Policy Installing a Security Policy file About this task You can install a Security Policy file on the phone by using the configuration file 11xxeSIP.cfg. Procedure 1. Create a text file, for example SecurityPolicy.txt. 2. Add a security parameter and value in the text file, for example CERT_ADMIN_UI_ENABLE YES. The parameter name and value are separated by a space. 3. Sign the file using a signing certificate. For example, SecurityPolicy.txt.sig file.
Certificate-based authentication The PDT (Problem Determination Tool) shell command can be used to view the output of the security policy command. This command lists the security policy parameters and their values on the IP Deskphone. The following is the output of the security policy command from the PDT shell.
EAP Authentication Figure 55: 802.1x and EAP network architecture IEEE 802.1x defines three roles: • a supplicant—an entity that requires access to the network for use of its services. • an authenticator—the network entry point to which the supplicant physically connects, typically a Layer 2 switch. The authenticator acts as a proxy between the supplicant and the authentication server and controls the access to the network based on the authentication status of the supplicant.
Certificate-based authentication • When PEAP is selected, the administrator is prompted to enter ID1, ID2 and Password. If the administrator enters only ID1, then ID2 has the same value of ID1. • When TLS is selected, the administrator is prompted to enter ID1. Note: Before using EAP-TLS, a device certificate must be installed. • When Disable is selected, the existing IDs and passwords are erased.
EAP Re-authentication EAP-TLS EAP-TLS allows the IP Deskphone to authenticate to the RADIUS server before the IP Deskphone can access the network. This procedure requires a user ID, root certificate, and device certificate. The root and device certificates must be installed on the IP Deskphone before using this feature. The customer root certificate can be installed using SIP configuration file. For more information, see Trusted Root certificate on page 274 .
Certificate-based authentication An example of a TLS authentication failure is as follows: 1033 [Minor][FRI MAY 15 13:48:06 2009][10223][n:/fw/build/../bsp/vxWorks/ common/dot 1x/Supplicant/moceap_tls.c:147] - EAP-TLS Failed to Authenticate Provisioning configuration files download through HTTPS HTTPS can be used to securely download provisioning configuration files on the IP Deskphone using the following process. 1. The IP Deskphone can contact a provisioning server and download an 11xxeSIP.
Server authentication Server authentication A server certificate, user name, and password are required to establish TLS connection between the IP Deskphone and the provisioning server. The server certificate must be signed by a certificate authority. The IP Deskphone uses the server certificate to validate the identity of the provisioning server that the IP Deskphone is connected to; the provisioning server uses the user name and password to authenticate the IP Deskphone.
Certificate-based authentication Security and error logs You can access the Security Log and the Error Log to view errors and failures that may have occurred during the operation of the IP Deskphone. Before you can access the Security and Error Logs, you must configure the Security Policy file with the SECURITY_LOG_UI_ENABLE YES parameter: If configured as yes, you can access the Security and Error Logs from the Network screen by selecting Device Settings > Security and Error Logs.
Security and error logs Table 51: Context-sensitive soft keys for the log item screen Context-sensitive soft key Action Next Navigates to the next log entry. Prev Navigates to the previous log entry. Back Returns you to the Logs main menu.
Certificate-based authentication SLC_DEVICE_CERTIFICATE_EXPIRED 0x0019 SLC_CTL_EXPIRED 0x0020 SLC_CTL_DOWNLOAD_ERROR 0x0021 The following is a list of minor errors that are logged in the Security Log. SLC_AVAYA_CERTIFICATE_EXPIRED_AUTH 0x1002 SLC_SERVICE_PROVIDER_CERTIFICATE_EXPIRED_AUTH 0x1003 SLC_PROVIDER_CERTIFICATE_IN_AVAYA_KEYS_FILE 0x1004 SLC_PKI_MGMT_INIT_FAILURE 0x1005 The following is the Security Policy parameter change event.
Creating a signing certificate subjectKeyIdentifier=hash authorityKeyIdentifier=keyid,issuer:always keyUsage=critical,digitalSignature extendedKeyUsage=critical,codeSigning,emailProtection 2. Use the following OpenSSL command to create a certificate request: openssl req -new -keyout signing_key.pem -out signing_req.pem –days 365 This creates the following files in PEM format: • signing_key.pem, which holds the private key of the signing certificate • signing_req.
Certificate-based authentication You can use many commercial CAs, Open source CAs, such as OpenSSL, and EJBCA to create and manage these certificates. The CA must meet the following requirements: • The root certificate must be exportable in PEM format without the private key. • The CA must be capable of issuing a Signing Certificate with the above attributes and an exportable private key. This requirement can require additional CA configuration.
Creating a signing certificate # Clean up rm –f ${tmp_signature_file} • OpenSSL-based Windows script for file signing REM %1 - Input Unsigned File REM %2 - Signing Certificate REM %3 - Signing Certificate Private Key REM %4 – Output Signed File set unsigned_file=%1 set sign_cert_file=%2 set sign_cert_pk_file=%3 set signed_file=%4 REM Setup temporary files set tmp_signature_file="sig.
Chapter 16: Licensing A license is a "right to use" granted by Avaya, that the customer purchases to enable the features on the IP Deskphone. A license contains at least one entitlement and can contain more than one entitlement. A license usually has an expiry date and is keyed for a specific license server. An entitlement is the most basic component of a license and represents a single instance of a right to a particular feature or capability.
Licensing framework Accessing the Keycode Retrieval System The Keycode Retrieval System (KRS) User Guide provides important IP Deskphone licensing information. You must register for access to KRS. The ollowing section describes how to access the KRS User Guide. Registering for access to KRS 1. Go to http://support.avaya.com/krs. Users must have an Avaya Access registration profile to access the KRS application 2.
Licensing • The license file contains only one type of token because the IP Deskphone only uses one type at a time. • The administrator must enter the IP Deskphone system ID directly into the Keycode Retrieval System (KRS). • A Node Locked license file is keyed for the IP Deskphone so that the license is only valid on a specific IP Deskphone. • A Network Locked license file can be installed on a limited number of IP Deskphones at a given site. • The system ID is the MAC of the IP Deskphone.
License file download [LICENSING] DOWNLOAD_MODE AUTO VERSION 000001 FILENAME ipctoken*.cfg 3. Place the IP Deskphone license file on the provisioning server. The generated license file must be named ipctokenMAC.cfg, where MAC is the 12-character MAC address of the IP Deskphone. For example, for an IP Deskphone with MAC address “000f1fd304f8”, the license file will be named “ ipctoken000f1fd304f8.cfg”. 4. Start the provisioning server so the IP Deskphone can retrieve the .cfg files when the server starts.
Licensing 3. Place the IP Deskphone license file on the provisioning server. 4. Start the provisioning server so the IP Deskphone can retrieve the .cfg files when the server starts. When the new license file is downloaded to the IP Deskphone from the provisioning server, it overwrites the existing license file and reboots the IP Deskphone to activate the new license. [LICENSING] section The IP Deskphone config file must include a [LICENSING] section to enable the IP Deskphone to download the licence file.
License information for the IP Deskphone PROTOCOL TFTP SERVER_IP 47.11.183.165 ... [LICENSING] VERSION 000001 FILENAME ipctoken*.cfg The following is an example of an 11xxe.cfg file with the [LICENSING] section only. [LICENSING] VERSION 000001 FILENAME ipctoken*.cfg License information for the IP Deskphone The Licensing information screen provides information on Embedded Mode, status and other licensing information. To access the licensing feature, press the Globe key twice.
Licensing Licensable features Licensable features are divided into three groups. 1. Basic Feature Set 2. Enhanced Feature Set - 1 token required 3. Advanced Feature Set - 2 tokens required Basic Features are always enabled on the IP Deskphone. Enabling the Enhanced Feature Set requires an additional token. Enabling the Advanced d Feature Set requires two tokens. When connected to an Avaya Server, the IP Deskphone receives an additional token.
Node-locked license mode Figure 61: Licensable features screen Node-locked license mode In the node-locked license mode, the IP Deskphone uses a license file to acquire the required tokens needed to activate the features. There are two types of tokens: time-based tokens, and standard tokens. Time-based token The following figure is an example of a node-locked time-based token.
Licensing Figure 62: Node-locked license mode — License information for time-based token (connected to nonAvaya Server) The following figure is an example of a node-locked time-based token. In this example, the embedded server on the IP Deskphone contains 5 tokens and the IP Deskphone is enabled for Advanced Feature Set and connected to an Avaya server. 312 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Node-locked license mode Figure 63: Node-locked license mode — License information for time-based token (connected to Avaya Server) Note the extra line Tokens Required: 1. This line is displayed only when the IP Deskphone connects to an Avaya Server.
Licensing Figure 64: Node-locked license mode — license information for Standard token (connected to non— Avaya Server) The following figure is an example of a node-locked Standard token. In this example, the embedded server on the IP Deskphone contains five tokens. The IP Deskphone is enabled for Advanced Feature Set and is connected to an Avaya server. Note that the extra line Tokens Required: 1 is displayed only when the IP Deskphone connects to an Avaya Server.
Invalid or no license file Figure 65: Node-locked license mode — license information for Standard token (connected to Avaya Server) The status of the standard token can be one of the following: • Active • Inactive A standard token can be inactive for one of the following reasons: • Insufficient token • License expired Invalid or no license file The following figure is an example of an invalid or no license file.
Licensing Figure 66: License information — Invalid or no license file Evaluation period When the IP Deskphone arrives from the factory, it has a 31–day evaluation period. This period allows users to try licensed features before they actually purchase the tokens. Any time the user loads a valid license file and has tokens granted, the evaluation is terminated immediately. Note: Once the evaluation period expires, there is no way to reset it.
Alarms Alarms The license feature provides notifications on the IP Deskphone screen about the licensing status. The license feature provides notification on the IP Deskphone screen if the following conditions apply: • No avaliable tokens • Expired tokens • Evaluation period has ended A notification message is displayed in a pop-up window on top of the IP Deskphone screen. The window can be dismissed by pressing the Stop key or by lifting the handset.
Licensing License expiry warning A warning window, indicating that a license has expired, appears on the IP Deskphone screen when a node-locked license expires. The following figure is an example of a warning window indicating that a license is expired.
Licensing expiry threshold warning Evaluation threshold warning A warning window informing you of the approaching evaluation expiration date appears on the IP Deskphone at the following predefined times: • 15 days before expiration date • 7 days before expiration date • 1 day before expiration date The following figure is an example of the evaluation threshold warning.
Licensing Figure 72: License expiry threshold warning Licensed features The following Standard features are available to all users without a token.
Licensed features • Authentication security • Bluetooth headset support (1140E/1165E) • Call Server Service Package • Expansion Module support • Instant Messaging • Media Security (SRTP) • Multiuser login support • NAT Traversal/STUN • Proactive Voice Quality Management • PC Client Control • Signaling Security (TLS) • USB headset support for audio • IPv6 support The following advanced features are available with two tokens or if the IP Deskphone is registered to a recognized Avaya server (Avaya, Avaya CS 1
Chapter 17: Internet Protocol version 6 Internet Protocol version 6 (IPv6) is a network layer for packet-switched internetworks and is the successor of IPv4. Important: IPv6 is not supported on Avaya Aura®. IPv6 provides larger address space, which allows greater flexibility in assigning addresses.
IPv6 address entry IPv6 address entry Addresses are entered using hexadecimal or alphanumeric formats. The tables below list the key sequences. Table 53: Hexadecimal key sequence Key Sequence 0 0 1 1 2 2abc 3 3def 4 4 5 5 6 6 7 7 8 8 9 9 * . The dot (.) is entered by pressing the asterisk (*) twice. Table 54: Alphanumeric key sequence Key Sequence 0 0+=<>$%&@~^ 1 1 _ - .
Internet Protocol version 6 IPv6 address format When an IPv6 address is entered, different but equivalent formats can be used for the same address. For example, the following addresses are all equivalent: 2001:0db8:0000:0000:0000:0000:1428:57ab 2001:0db8:0000:0000:0000::1428:57ab 2001:0db8:0:0:0:0:1428:57ab 2001:0db8:0:0::1428:57ab 2001:0db8::1428:57ab 2001:db8::1428:57ab Any of the above formats can be entered.
IPv6 Stateless address autoconfiguration • For IPv6 RTP only or SRTP only modes are supported. Mixture of RTP and SRTP is not supported. • SRTP BE-Cap Neg cannot be configured when IPv6 is enabled IPv6 Stateless address autoconfiguration The IP Deskphone supports stateless address autoconfiguration as defined by RFC 2463 and RFC 2461. Stateless and stateful (DHCPv6) address autoconfiguration can be used simultaneously.
Internet Protocol version 6 If the DHCPv6 server is configured with the SIP proxy IPv4–mapped address, the IP Deskphone registers with its IPv4 address. If the DHCPv6 server is configured with the SIP proxy IPv4-mapped and IPv6 addresses, the DHCPv6 client calls the destination address selection algorithm and selects the address based on the configured preference. If PREFER_IPV6 is configured to YES, the IP Deskphone selects the IPv6 address of the highest precedence.
Configuring the DHCP server The DHCPv6 configuration file that can be used for the IP Deskphone stateful configuration is as follows: # # Example server configuration file: per-client configuaration # # In this example, some clients receive different parameters than others.
Internet Protocol version 6 } 328 client duid 0x0016ca0081f7 { #client with DUID 0x001365FEF48D gets this address. #DNS and SIP server addresses are assigned from the common options above address fdde:b1a8:d98d:0000:2F87:9FBC:0A0A:0AC9 } SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 18: SIP messages supported by the IP Deskphone SIP methods The table below provides a list of SIP messages supported by the IP Deskphone. Table 55: SIP methods Method Supported? Comments INVITE Yes Mid-call re-invites for media changes also supported.
SIP messages supported by the IP Deskphone SIP responses The following SIP responses are also supported: • 1xx Response—Information Responses • 2xx Responses—Successful Responses • 3xx Response—Request Failure Responses • 4xx Response—Server Failure Responses • 6xx Response—Global Responses 1xx Response—Information Responses 1xx Response Send Receive Comments 100 Trying Yes Yes The IP Deskphone can generate this response for an incoming INVITE if it has taken too long to generate a 180 response.
3xx Response—Redirection responses 3xx Response—Redirection responses 3xx Response Send Receive Comments 300 Multiple Choices No Yes When receiving this response, the IP Deskphone redirects the original request to next contact specified. Yes When receiving this response, the IP Deskphone redirects the original request to the new contact specified. However, the IP Deskphone takes no additional special consideration of the "permanent" status of this change.
SIP messages supported by the IP Deskphone 4xx Response 404 Not found 405 Method not allowed Send Yes Yes Receive Comments Yes The IP Deskphone generates this response for requests to unknown users. Receiving this response falls through to the default handling. Yes The IP Deskphone ends this response to a known method if it is received at a time when the IP Deskphone is not prepared to handle or the request is missing necessary information.
5xx Response—Server failure responses 4xx Response Send Receive Comments 482 Loop detected Yes Yes Default handling is used when this response is received. 483 Too Many Hops No Yes See default handling. 484 Address Incomplete No Yes See default handling. 485 Ambiguous No Yes See default handling. The IP Deskphone does not attempt to retry the request.
SIP messages supported by the IP Deskphone 6xx Response—Global responses 6xx Response 600 Busy Everywhere Send Yes Receive Comments Yes The IP Deskphone can send this response when the IGNORE setting is configured to NETWORK, and the user chooses to ignore an incoming call. When received, this response falls through the default handling. 603 Decline Yes Yes The IP Deskphone can send this response when the user declines an incoming call. An optional reason can be supplied.
SIP header fields Header field Supported? Allow-Events Yes Authentication-Info Yes Authorization Yes Call-Id Yes Call-Info Yes Contact Yes Content-Disposition Yes Content-Encoding Yes Content-Length Yes Content-Type Yes Cseq Yes Date Yes Expires Yes Error-Info Yes Max-Forwards Yes Mime-Version Yes Organization Yes P-Access-Network-Info Yes P-Asserted-Identity Yes P-Associated-URI Yes P-Called-Party-ID Yes P-Charging-Function-Addresses Yes P-Charging-Vector Yes
SIP messages supported by the IP Deskphone Header field Supported? Referred-By Yes Remote-Party-ID Yes Replaces Yes Reply-To Yes Require Yes Resource-Priority Yes Retry-After Yes Route Yes RSeq Yes Server Yes Service-Route Yes Subject Yes Supported Yes Timestamp Yes To Yes Unsupported Yes User-Agent Yes Via Yes Warning Yes WWW-Authenticate Yes Session description protocol usage 336 SDP Headers Supported? v--Protocol version Yes o--Owner or creator and session
SDP and Call Hold SDP and Call Hold The IP Deskphone can support sending and receiving of hold using the method specified by RFC2543 and RFC3261/3264.
SIP messages supported by the IP Deskphone Supported subscriptions Subscription type Supported Avaya Call Server specific address-book Yes Yes call-park Yes Yes dialog Yes Yes presence Yes Yes message-summary Yes No ua-profile Partial Yes service-package Yes Yes network-redirection-reminder Yes Yes Supported instant messaging 338 Message type Supported? plain text Yes Avaya unencrypted Yes Avaya encrypted Yes SIP Software for Avaya 1100 Series IP Deskphones-Administrati
Chapter 19: Diagnostics and troubleshooting This chapter contains the following topics: • IP Deskphone diagnostics on page 339 • Local diagnostic tools on page 341 • How to access the Diagnostics menu on page 342 • IP Set and DHCP information on page 343 • Network Diagnostics tools on page 346 • Ethernet Statistics on page 349 • IP Network Statistics on page 352 • USB Devices on page 354 • Advanced Diag Tools on page 354 • Test key on page 356 • Logging System on page 359 • Problem Determination Tool (PDT)
Diagnostics and troubleshooting Server unreachable after the IP Deskphone is powered up If the display indicates that the server is unreachable and it continuously resets, some parameters must be configured. Things to consider when configuring parameters: • Enter requested information in the menu fields by pressing the number keys on the dialpad. Press the asterisk (*) key to enter a period (.) when entering an IP address.
Local diagnostic tools • If the software download fails while the application is being written to FLASH, there are two possible recovery methods: - If an application file was not created, then after power-up the IP Deskphone jumps to the BootC loader and downloads a new application load using the same mechanism as the application. - If the application is executed and the file created is corrupted, the IP Deskphone crashes.
Diagnostics and troubleshooting Diagnostics option Description Advanced Diag Tools Provides information for setting up the following configuration parameters: • Auto Recovery (enable/disable) • SSH (enable/disable) • Port Mirroring (enable/disable) • Debug Port • User ID and Password for SSH Test Key Activates key testing mode.
IP Set and DHCP information • 6. Lock Select Diagnostics, or press Back to return to the Network menu. The following screen appears: Figure 74: Diagnostics menu screen The following table describes the function of the Navigation keys for the Diagnostics screen. Table 57: Navigation Key Action Up and down arrows Use the up and down arrows to change the selected item in the list. Enter Invokes the Select context-sensitive soft key.
Diagnostics and troubleshooting Figure 75: IP Set and DHCP information screen The following is an example of the information that appears: 1. Configuration Network Data Valid: Yes MAC Address Stored: Yes Perform DHCP: No Voice VLAN Enable: No Voice VLAN Config: No VLAN Voice VLAN Discovered: No Primary Server: S1 PC Port is: ON 2. Software Version: 3.00.09.02 Hardware ID: xxxxxx 3. Set IP: xxx.xxx.xxx.xxx (could be in IPv4 or IPv6 format) 4. Sub-Mask: xxx.xxx.xxx.xxx (could be in IPv4 or IPv6 format) 5.
Duplicate IPv6 addresses from DHCPv6 server Port: 4100 Act: 1 Retries: 5 10. Provisioning Server: xxx.xxx.xxx.xxx The following table describes the function of the context-sensitive soft keys for the IP Set and DHCP Information screen. Table 58: Context-sensitive soft key for the IP Set and DHCP Information screen Context-sensitive soft key Action Up and down arrows Use the up and down arrows to scroll the screen.
Diagnostics and troubleshooting DHCP server unreachable This section describes the IP Deskphone behavior when the DHCPv4/DHCPv6 server is unreachable.
Network Diagnostics tools Figure 76: Network Diagnostics Tools screen The screen contains the following configurable fields: • IP—The user can enter an IP address. • Hops—The number of hops used as a configurable parameter for tracert routine. • Packet Size—Size of the network packet used by the ping routine. • Ping—The number of ping packages.
Diagnostics and troubleshooting The following table describes the function of the Navigation keys for the Network Diagnostics Tools screen. Table 61: Navigation Key Action Up and down arrows Use the up and down arrows to scroll through a list of testing information. Left and right arrows Use the left and right arrows to move through the configurable fields. Enter Use the Enter key to enter the editing mode for the active configurable field.
Ethernet Statistics Table 62: Context-sensitive soft keys for the Network Diagnostics (Config) screen Context-sensitive soft key Action Apply Applies settings, dismisses the screen, and returns you to the Network Diagnostics menu. Back Returns you to the Diagnostics menu. The following table describes the function of the Navigation keys for the Network Diagnostics tools (Config) screen.
Diagnostics and troubleshooting Figure 78: Ethernet Statistics (NI Port) screen The following is an example of Ethernet Statistics for the IP Deskphone: 1. NI Link Status: Up 2. Duplex Mode: Full 3. Network Speed: 1000Mb 4. Auto Sense/Negotiate Auto-Negotiate Capability: Yes Auto-Negotiate Completed: Yes 5. Port VLAN Priority: 0 6. Port VLAN ID: 0 7. Packet Collision: 0 8. CRC Errors: 1 9. Frame Errors: 1 A. Unicast Packets Tx: 1 B. Unicast Packets Rx: 1 C. Broadcast Packets Rx: 1 D.
Ethernet Statistics Table 64: Context-sensitive soft keys for the Ethernet Statistics (NI Port) screen Context-sensitive soft key Action Reset Resets statistics value. NI Port Switches to the PC Port Ethernet statistics. Back Returns you to the Diagnostics menu. The following table describes the function of the Navigation keys for the Ethernet Statistics (NI Port) screen.
Diagnostics and troubleshooting 4. Auto Sense/Negotiate Auto-Negotiate Capability: Yes Auto-Negotiate Completed: Yes 5. Port VLAN Priority: 0 6. Port VLAN ID: 0 7. Packet Collision: 0 8. CRC Errors: 1 9. Frame Errors: 1 A. Unicast Packets Tx: 1 B. Unicast Packets Rx: 1 C. Broadcast Packets Rx: 1 C. Broadcast Packets Rx: 1 D. Multicast Packets Rx: 1 The following table describes the function of the context-sensitive soft keys for the Ethernet Statistics (PC Port) screen.
IP Network Statistics Figure 80: IP Network Statistics screen The following is an example of IP Network Statistics for the IP Deskphone: 1. Packet Sent: 0 2. Packet Received: 0 3. Incoming Packets Error: 0 4. Outgoing Packets Error: 0 5. Incoming Pkt Discarded: 0 6. Outgoing Pkt Discarded: 0 7. Unknown Protos: 0 8. Last ICMP Type/Code: 1 The following table describes the function of the context-sensitive soft keys for the IP Network Statistics screen.
Diagnostics and troubleshooting USB Devices The USB Devices screen provides information about USB devices attached to the IP Deskphone. To access the USB Devices screen, from the Diagnostics menu, choose USB Devices. The following screen appears: Figure 81: USB Devices screen Important: The USB Devices screen contains a list of the USB devices attached to the IP Deskphone. The following table describes the function of the context-sensitive soft keys for the USB Devices screen.
Advanced Diag Tools • Debug Port To access the Advanced Diag Tools screen from the Diagnostics menu, choose Advanced Diag Tools. The following table describes the function of the context-sensitive soft keys for the Advanced Diag Tools screen. Table 72: Context-sensitive soft keys for the Advanced Diag Tools screen Context-sensitive soft key Action Apply Invokes the selected service. Return Dismisses the dialog box and returns you to the Diagnostics menu.
Diagnostics and troubleshooting Gathering network traces from an IP Deskphone You can capture network traces from the PC port of the IP Deskphone. 1. Ensure the PC port is enabled on the IP Deskphone. Open the Device Settings menu. Check to see if the Enable PC Port parameter checkbox is displayed and the checkbox is checked. If the Enable PC Port parameter checkbox is not visible, do the following: • Press the Auto soft key and check the 07. PC Port Enable checkbox in the Auto Provisioning window.
Reset Factory Settings support Figure 82: Test key screen After you activate the test mode, the key event appears on the screen: • Key pressing: "Test key: xx pressed" • Key pressing: "Test key: xx pressed" The following table describes the function of the context-sensitive soft keys for the Test key screen. Table 74: Context-sensitive soft keys for the Test key screen Context-sensitive soft key Action Quit Dismisses the Services menu.
Diagnostics and troubleshooting After you activate Reset to Factory Settings the action is registered in the ECR-log file. Activating Reset to Factory Setting by SKS 1. At any point while the IP Deskphone is operating, press the Special Key Sequence (SKS). 2. Enter the following command: **73639## (or **renew##) For example, the MAC-address, A1B2C3D4E5F6 can be translated to 212223343536 . Therefore, the SKS would be **73639212223343536## .
Logging System 4. Click Enter. • If the MAC-address is correct, the IP Deskphone is reset and the remote telnet client is restarted. • If the MAC-address is incorrect, the IP Deskphone displays: >Incorrect MAC-address. Action is rejected . Return to Step 1. Logging System Logging System contains a subsystem for logging incoming and outgoing SIP packages to the log file in FFS, for the IP Deskphone.
Diagnostics and troubleshooting Table 77: Context-sensitive soft keys for the Logging Systems screen Context-sensitive soft key Action Apply Applies the setting and returns to the parent screen. Back Dismisses the setting and returns you to the parent screen. The following table describes the function of the Navigation keys for the Logging Systems screen. Table 78: Navigation Key Action Up and down arrows Use the up and down arrows to scroll the screen.
ECR Watchdog ECR Watchdog The ECR Watchdog tracks the IP Deskphone to ensure the IP Deskphone survives transitions (for example: soft reset). If the watchdog is active and has not detected activity in a certain period of time, the watchdog logs the appropriate error and recovers the IP Deskphone. Task Monitor The Task Monitor performs the following functions: • Tracks the switch of any task to the suspended state.
Diagnostics and troubleshooting PDT commands The PDT is a troubleshooting tool for the IP Deskphone. The PDT has powerful functions which allow you to perform special testing actions, and can display the content of any log files.
PDT commands Command Description • Outputs content of the specified log file to stdout (the screen, a stream, stdout, or a string). The input parameter specifies a type of logging manager: - 0 (default)—ECR-log file - 1—SIP-log file If the input parameter is incorrect, the following notification appears: >prtlog: incorrect type of manager clearLogFile Clears a content of the ECR-log file setLogLevel Configures log level, where the loglevel is in the range 0...
Diagnostics and troubleshooting Command Description • Language file lsr List directory contents (similar to unix Is) and the contents of a directory and any of its subdirectories ping [# of pings] Ping any host (ping) tracert [max hops] Traceroute to any host (tracert) netinfo Print common network information routeshow Display host and network routing tables and stats arp Display entries in the system ARP table listcerts List all trusted certificates printcert D
PDT commands Command Description ifShow Displays IPv4 interface. ping Sends ICMPv6 Echo Request messages and records the receipt of ICMPv6 Echo Reply messages. With ping, the IP Deskphone can detect network or host communication failures and troubleshoot common IPv6 connectivity problems. Link-Local and Global addresses, as well as other node names, can be pinged.
Diagnostics and troubleshooting PDT for USB flash drive The PDT contains commands that allow the IP Deskphone to display file system information on the first valid USB flash drive attached to the IP Deskphone. File system information is not displayed in the True Flash File System (TFFS) because there are already commands in the PDT to perform similar operations for the TFFS. The following table describes the USB flash drive PDT commands.
Update PDT device configuration information Figure 84: PDT output on usbFsShow command Update PDT device configuration information The PDT device configuration is updated with USB port lock information. You can remotely monitor the individual USB device configuration status using the PDT. March 2015 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Diagnostics and troubleshooting Figure 85: USB Device information from PDT Device configuration file The following table describes the configuration commands in the device configuration file for alarms, logs and diagnostics. Table 81: Alarms, logs and diagnostics configuration commands Component Flag PC Port Mirroring parameter which PORT_MIRROR_ENABLE can be enabled and disabled in the Advanced Diag Tools dialog.
Diagnostic Logs Component Flag Description Memory Monitor. MEMCHECK_PERIOD Determines the time period in seconds when the Memory monitor wakes up (after start-up or the last memory check attempt). • The values are 1800 (0.5 hrs) to 86400 (24 hrs). The default value is 86400 (24 hrs). SIP-traffic monitor DOS_PACKET_RATE Determines the maximum number of packets per second that is allowed.
Diagnostics and troubleshooting ECR-log file The ECR-log file registers and provides detailed information on the errors or bugs that occur during the operation of the IP Deskphone. The ECR-log also contains records indicating some events, such as restart. Each error is logged as a record. The format of the record is the same regardless of the monitor that generates it or the level of severity of the error. There are three sections to the record.
Diagnostic Logs Figure 86: Example of the supplementary information in the ECR-log file March 2015 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Diagnostics and troubleshooting Figure 87: Example of the supplementary information in the ECR-log file (continued) The following is an example of the ECR-log file. PDT>prtlog 0 (-----------------> example of the ECR-log file) 372 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Diagnostic Logs Figure 88: Example of the ECR-log file March 2015 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Diagnostics and troubleshooting Figure 89: Example of the ECR-log file (continued) 374 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Diagnostic Logs SIP-log file The SIP-log file registers incoming and outgoing SIP-packages, and each package is logged as a record. There are two sections: • The first section requires mandatory information for each record including: - type of the package (incoming or outgoing) - time stamp - software version • The second section contains the content of the package in the text format. The following is an example of the SIP-log file.
Diagnostics and troubleshooting Figure 90: Example of the SIP-log file 376 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Diagnostic Logs Figure 91: Example of the SIP-log file (continued) There are three ways to obtain SIP-logs from an IP Deskphone: 1. Online — connect to the IP Deskphone through SSH and enter the dbgshell PDT command. The log messages are printed out during a call to the SSH console. 2. Offline— connect to the IP Deskphone through SSH and enter the prtlog 1 PDT command. The active SIP log file is printed out to the SSH console. 3. Offline Log File — Log files are stored on the IP Deskphone flash device.
Diagnostics and troubleshooting SSHID SSHPWD SFTP YES SFTP_READ_PATTERNS .txt,.zip,.log SFTP_WRITE_PATTERNS .txt,.zip,.log You can then connect through SFTP and obtain the most recent log file — /logs/ SIPLogFile.log, and the archive file — /logs/SIPLogFile.log.zip. PC Client Softphone interworking If the user does not have access to the pre-authorization configurations in the Feature Options menu, the feature is not enabled.
Logging and errors If there is a media negotiation failure, such as secure telephone to non-secure telephone, the call log (inbox of the called party and the outbox of the caller) contains the following additional information string: Media negotiation failure SSH If a logon failure for SSH Authentication occurs, the following event is posted in the security log: 1040[Minor][TUE JAN 02 20:12:14 2007][4189][i:/fw/buil d/../util/sshapp/ sshServer.
Part 2: Avaya Aura® support for 1100 Series IP Deskphones The Avaya Aura® communications platform (solution comprised of Avaya Aura™ Communication Manager, Avaya Aura™ Session Manager, Avaya Modular Messaging) now supports the 1100 Series IP Deskphone with SIP 4.4 software. The 1100 Series IP Deskphones are directly registered to Session Manager and are supported by Communication Manager configured as an Evolution Server (CM-ES).
Chapter 20: Presence support Presence support for 1100 Series IP Deskphones SIP 4.4 introduces support for the Presence feature for 1100 Series IP Deskphone users on Avaya Aura® with Avaya Presence Server (PS). The Presence feature is configured in SIP 4.
Presence support Dinner Sleeping Holiday Spectator In transit Steering Looking for work Travel Lunch TV Meal Vacation Meeting Working On the phone Worship Performance Unknown To set the desired presence state and activity, the IP Deskphone user must open the Presence dialog, select the presence state (Connected or Unavailable) and then select the desired activity. Any combination of presence state and activity can be selected.
Presence support for 1100 Series IP Deskphones • The 1100 Series IP Deskphones do not support the Avaya One-X Communicator’s use of Notes. Related Links Presence support for 1100 Series IP Deskphones on page 20 March 2015 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 21: Personal Profile Manager Personal Profile Manager support SIP software supports the Personal Profile Manager (PPM) for Avaya Aura Communication Manager/Session Manager. The PPM is a web service that runs as part of Avaya Aura® Session Manager and the System Manager. PPM processes SOAP messages over HTTP/HTTPS with digest authentication. PPM is responsible for maintaining and managing an end user’s personal information in the system.
Personal Profile Manager support Configuration To enable support for PPM, configure the following parameter in the device configuration file : ENABLE_SERVICE_PACKAGE PPM Related Links Personal Profile Manager support on page 384 Contact lists and PPM PPM is responsible for maintaining and managing an end user’s personal information in the system.
Personal Profile Manager Note: Calls to an emergency number are blocked from: • Conference • Transfer • Join • Hold • Park Related Links Personal Profile Manager support on page 384 Global search with PPM When PPM is enabled, and a global search is initiated from the IP Deskphone, PPM allows the IP Deskphone to search the Session Manager database for administered users. This search is based on search criteria sent in the request.
Personal Profile Manager support Figure 92: Reboot in Session Manager Related Links Personal Profile Manager support on page 384 March 2015 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 22: One-X PC Client Control One-X PC Client Control support A shared control mechanism is supported on Avaya Aura®, where a soft client application such as one-X Communicator or one-X Agent Desktop creates a shared control session with a controlled IP Deskphone with SIP software. Note: The SIP shared control mechanism only works between SIP endpoints that are based on Spark/ Client Platform XML messaging.
One-X PC Client Control support Feature operation 1. The One-X Communicator is configured to use the 11xxE/12xx IP Deskphone to place and receive calls by selecting “Desk Phone” from the drop-down list in Devices and Services > General Settings > Outgoing Calls. 2. The user logs into their 11xxE/12xx IP Deskphone. 3. The user logs into the One-X PC Client with the same extension as the user’s IP Deskphone.
Chapter 23: Embedded Device Certificate Embedded device certificate support TLS connection with Avaya Aura® Session Manager requires mutual authentication by default. Mutual authentication requires proper Certificate Authority (CA) and device certificates to be installed on every IP Deskphone. A default device certificate in the firmware allows easy connection to Avaya Aura® through Session Manager using TLS .
Chapter 24: SRTP with Avaya Aura SRTP support with Avaya Aura® SRTP is supported with Avaya Aura®. The following SRTP modes are supported: • Secure Only • Best Effort Capability Negotiation Note: To use SRTP, you first have to be using TLS. That is, you cannot have secure media without using secure signalling.
Chapter 25: Multi-user login on Avaya Aura Multi-user login on Avaya Aura® The following multi-user scenarios are supported: • One user can log on to a maximum of 10 IP Deskphones. Note: Once the call is answered at one phone, other users cannot see status of that call on the other phones. • Multiple users (extensions) can log onto one IP Deskphone. • When multiple users are logged onto one IP Deskphone, the IP Deskphone can be logged into more than one system.
Multi-user login on Avaya Aura® Related Links Avaya Aura® support for 1100 Series IP Deskphones on page 380 March 2015 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 26: FNEs and FACs for 1100 Series IP Deskphones FNEs and FACs with Avaya Aura® Some Avaya Aura® features are invoked by dialing a Communication Manager Feature Name Extension Extension (FNE) or Feature Access Code (FAC). A speed dial button on the IP Deskphone can be programmed to an FNE or FAC. Note: Most FNEs require first configuring the equivalent FAC. This enables a feature to be easily accessed by pressing a speed dial key on the IP Deskphone instead of dialing an entire FNE or FAC code.
Supported features on Avaya Aura® Avaya Aura® feature name Access method Abbreviated Dial – Prgm Group List FAC Ring Again Automatic Callback FNE Call Forward Busy Call Forwarding Activation Busy/DA FNE Call Forward All Calls Call Forwarding Activation All FNE Call Forward Disable Call Forwarding Deactivation FNE Call Park Call Park FNE Answer Back FNE Call Pickup Call Pickup FNE Charge Account, Forced CDR Account Code FAC Calling Party Privacy Per Call CPN Blocking FNE Confer
FNEs and FACs for 1100 Series IP Deskphones Avaya Aura® support for 1100 Series IP Deskphones on page 380 Feature to FAC/FNE Naming The following table provides a listing of Communication Server 1000 (CS 1000) features and their FAC/FNE equivalents.
Feature configuration details CS 1000 feature name FAC name FNE name Extended Call Fwd Activate Busy D/A — Extended Call Fwd Activate All — Extended Call Fwd Deactivation — Control Restrict Activation — Group Control Restrict Deactivation — Hunt Group Busy Activation — Hunt Group Busy Deactivation — Malicious Call Trace Activation Malicious Call Trace Malicious Call Trace Deactivation Malicious Call Trace Cancel Per Call CPN Blocking Code Access Code Calling Number Block Per Call CPN
FNEs and FACs for 1100 Series IP Deskphones Feature / Functionality Comments Call Appearances 1. The endpoint template defaults to 3 call appearances. 2. You can add more/remove call appearances in Endpoint Editor. Autodial List 1. Configure FACs for Abbreviated Dialing List 1/2/3 and Program Group List. 2. Configure abbreviated-dialing group entries. 3. Configure the phone extension with abbreviated dialing group numbers. 4. Use FACs to access lists and/or program entries.
Feature configuration details Feature / Functionality Comments 2. Configure FNEs to enable and disable EC500. 3. Configure the IP Deskphone extension for EC500 through off-pbx-telephone station-mapping. 4. Use the FAC to change the mobile number. User FNEs to enable/disable the feature. Ring Again 1. Configure the FAC and FNE for enabling and disabling auto callback 2. Configure the auto-callback button in the IP Deskphone’s Endpoint Editor. 3. Use FNEs to enable and disable the feature.
Chapter 27: Feature interactions This chapter provides information on feature interactions for IP Deskphones with SIP Software on Avaya Aura® Communication Manager. Conf and Join softkeys The Conf and Join soft keys on the IP Deskphone support the IP Deskphone’s local 3-way conference bridge.
Codec support Communication Manager offers 4 options for codec G722: • G.722-64K • G.722.1-24K • G.722.1-32K • G.722.2 Important: The IP Deskphones only support the G722-64K option. Related Links Avaya Aura® support for 1100 Series IP Deskphones on page 380 March 2015 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 28: IP Deskphone configuration parameters Device configuration file with Avaya Aura® This chapter describes the parameters required in the device configuration files for the 1100 Series IP Deskphones when the IP Deskphones are used on Avaya Aura®. Note: The # symbol preceding a line of text indicates a comment in the device configuration file.
Device configuration file with Avaya Aura® # Local Privacy feature disabled in favor of Calling Number Block FNE DISABLE_PRIVACY_UI YES #------Audio Codecs AUDIO_CODEC1 G722 AUDIO_CODEC2 PCMU AUDIO_CODEC3 G729 AUDIO_CODEC4 PCMA #YES if Avaya Presence Services with Avaya Aura Session Manager/ Communication Manager are used RPID_PRESENCE_ENABLE YES #-----Presence PRES_SERVER_IP #For secure calls with Aura MKI_ENABLE NO AVAYA_AURA_MODE_ENABLE YES #For TLS connection with Aura U
Part 3: IP Deskphone migration Part III of this document provides information on how to migrate IP Deskphones in the following scenarios: • UNIStim IP Deskphone migration from CS 1000 to Avaya Aura® on page 405 • SIP IP Deskphone migration from MCS 5200 to Avaya Aura® on page 413 • UNIStim IP Deskphone migration from CS 1000 to IP Office on page 421 Related Links UNIStim IP Deskphone migration from CS 1000 to Avaya Aura® on page 405 SIP IP Deskphone migration from MCS 5200 to Avaya Aura® on page 413 UNIStim
Chapter 29: UNIStim IP Deskphone migration from CS 1000 to Avaya Aura® This chapter provides information on a method to migrate IP Deskphones with UNIStim firmware from a Communication Server (CS 1000) system to Avaya Aura® by using Aura® Utility Server as a provisioning server.
UNIStim IP Deskphone migration from CS 1000 to Avaya Aura® This chapter does not describe how to configure CS 1000, Avaya Aura®, or third-party applications such as the DHCP and TFTP servers. For this information, refer to the appropriate product documentation. This chapter does not provide information on how to migrate the CS 1000 users and their profiles over to the Avaya Aura® system.
Migrating IP Deskphones with UNIStim software from CS 1000 to Avaya Aura® using Aura® Utility Server For direct connection to Avaya Aura® Communication ManagerM/Session Manager, a license with no tokens is needed. For connection through Secure Router, a license with one token is needed. 3. Create a device configuration file with the configuration options required for connecting the IP Deskphones to Avaya Aura®.
UNIStim IP Deskphone migration from CS 1000 to Avaya Aura® 1140eSIP.cfg: [FW] DOWNLOAD_MODE AUTO VERSION 04.04.09.00 <— version should be taken from the SIP software file name PROTOCOL HTTP FILENAME SIP1140e04.04.09.00.bin <— specify the SIP software file name here [DEVICE_CONFIG] DOWNLOAD_MODE FORCED FILENAME device_config.dat <— name of the device configuration file PROTOCOL HTTP [Licensing] DOWNLOAD_MODE FORCED VERSION 0002 PROTOCOL HTTP FILENAME ipctoken.
Migrating IP Deskphones with UNIStim software from CS 1000 to Avaya Aura® using Aura® Utility Server Figure 93: Utility Services main page b. In the menu at the top of the page, click Utilities > Utility Admin. The Utility Services Administration page opens. Figure 94: Utility Services Administration c. In the menu list on the left, click IP Phone Tools > IP Phone Custom File Upload. The IP Phone Custom File Upload page opens.
UNIStim IP Deskphone migration from CS 1000 to Avaya Aura® Figure 95: IP Phone Custom File Upload page d. Click Browse and navigate to the created ZIP archive containing the provisioning files. e. Click the Upload Custom Files and Activate button. f. Return to the IP Phone Custom File Upload page after the files have uploaded. g. Click Display Custom Directory and make sure that all files from the zip archive are listed.
Migrating IP Deskphones with UNIStim software from CS 1000 to Avaya Aura® using Aura® Utility Server The following is an example of an appropriate configuration file for a Linux dhcpd DHCPv4 server. Please refer to the documentation of your DHCP server on how to configure the appropriate configuration file. dhcpd.conf: .....
UNIStim IP Deskphone migration from CS 1000 to Avaya Aura® 6. Force a reboot of the IP Deskphones by running the isetResetAll command in the Signaling Server shell. Result 1. The IP Deskphone reboots. 2. During bootup, the IP Deskphone sends a DHCP request with Vendor Class Id “Norteli2004-A” or “Nortel-i2004-B”. The DHCP server sends back a DHCP response with the IP Deskphone’s IP address and the URL of the Avaya Aura Utility server (in DHCP option 66). 3.
Chapter 30: SIP IP Deskphone migration from MCS 5200 to Avaya Aura® This chapter provides information on a method to migrate 1120E and 1140E IP Deskphones with SIP software from an MCS 5200 server to Avaya Aura® by using Aura® Utility Services as a provisioning server.
SIP IP Deskphone migration from MCS 5200 to Avaya Aura® requires knowledge of which phones belong to which users and the passwords for all users; this is out of scope of this procedure. Related Links SIP IP Deskphone migration from MCS 5200 to Avaya Aura® on page 413 Requirements Ensure that the following requirements for migration have been implemented: • DHCP is enabled on the IP Deskphones . The DHCP option should be set to YES in the Network Configuration menu.
Migrating IP Deskphones with SIP software from MCS 5200 to Avaya Aura® using Aura® Utility Server Important: If TLS is used for secure connection to Aura® Session Manager, the following option must be added to the device configuration file: USE_DEFAULT_DEV_CERT YES Related Links SIP IP Deskphone migration from MCS 5200 to Avaya Aura® on page 413 Migrating IP Deskphones with SIP software from MCS 5200 to Avaya Aura® using Aura® Utility Server About this task If you have IP Deskphones running SIP software o
SIP IP Deskphone migration from MCS 5200 to Avaya Aura® PROTOCOL HTTP FILENAME ipctoken.cfg <— name of the license file Configuration file for 1120E IP Deskphone: 1120eSIP.cfg: [FW] DOWNLOAD_MODE AUTO VERSION 04.04.09.00 <— version should be taken from the SIP software file name PROTOCOL HTTP FILENAME SIP1120e04.04.09.00.bin <— specify the SIP software file name here [DEVICE_CONFIG] DOWNLOAD_MODE FORCED FILENAME device_config.
Migrating IP Deskphones with SIP software from MCS 5200 to Avaya Aura® using Aura® Utility Server Figure 96: Utility Services main page b. In the menu at the top of the page, click Utilities > Utility Admin. The Utility Services Administration page opens. Figure 97: Utility Services Administration c. In the menu list on the left, click IP Phone Tools > IP Phone Custom File Upload. The IP Phone Custom File Upload page opens.
SIP IP Deskphone migration from MCS 5200 to Avaya Aura® Figure 98: IP Phone Custom File Upload page d. Click Browse and navigate to the created ZIP archive containing the provisioning files. e. Click the Upload Custom Files and Activate button. f. Return to the IP Phone Custom File Upload page after the files have uploaded. g. Click Display Custom Directory and make sure that all files from the zip archive are listed.
Migrating IP Deskphones with SIP software from MCS 5200 to Avaya Aura® using Aura® Utility Server Note: If there is more than one DHCP server/utility server, the described process must be performed in each DHCP/Utility server, according to the migration plan. Important: Once the DHCP configuration is put in place, there is no way to prevent “random” phones migrating to the Avaya Aura environment at an unexpected time due to rebooting caused by a power outage or other reason. 5.
SIP IP Deskphone migration from MCS 5200 to Avaya Aura® Warning: A power outage at this stage may cause firmware corruption. If this happens, the IP Deskphone may not be able to boot up, and it may be necessary to return the IP Deskphone for repair. 4. The IP Deskphone starts and downloads the device configuration file, images, licenses, languages, and so on, from the Avaya Aura Utility server. 5. When configuration is complete, the IP Deskphone automatically reboots. 6. The IP Deskphone is ready to use.
Chapter 31: UNIStim IP Deskphone migration from CS 1000 to IP Office This chapter provides information on a method to migrate IP Deskphones with UNIStim firmware from a Communication Server (CS 1000) system to IP Office. Related Links IP Deskphone migration on page 404 Overview on page 421 Requirements on page 422 Before you begin on page 422 Migrating IP Deskphones with UNIStim firmware from CS 1000 to IP Office on page 423 Overview It is assumed that the IP Deskphones connect to IP Office through TCP.
UNIStim IP Deskphone migration from CS 1000 to IP Office Related Links UNIStim IP Deskphone migration from CS 1000 to IP Office on page 421 Requirements Ensure that the following requirements for migration have been implemented: • The IP Deskphones are running UNIStim Release 3.3 firmware release or newer. The latest firmware is recommended - 062xC8Q. • DHCP is enabled on the IP Deskphones . The DHCP option should be set to YES in the Network Configuration menu.
Migrating IP Deskphones with UNIStim firmware from CS 1000 to IP Office Migrating IP Deskphones with UNIStim firmware from CS 1000 to IP Office About this task If you have IP Deskphones running UNIStim firmware on a CS 1000 system, and you want to migrate the IP Deskphones to Avaya IP Office, use the following procedure. Procedure 1. Create configuration files for the 1120E and 1140E IP Deskphones with UNIStim firmware, with the following content. Configuration file for 1140E IP Deskphone (1140e.
UNIStim IP Deskphone migration from CS 1000 to IP Office PROTOCOL HTTP FILENAME SIP1140e04.04.09.00.bin <— specify the SIP software file name here [DEVICE_CONFIG] DOWNLOAD_MODE FORCED FILENAME device_config.dat <— name of the device configuration file PROTOCOL HTTP [Licensing] DOWNLOAD_MODE FORCED VERSION 0002 PROTOCOL HTTP FILENAME ipctoken.
Migrating IP Deskphones with UNIStim firmware from CS 1000 to IP Office Figure 99: IP Office Manager – main window • Select IP Office system and log in. Figure 100: Select IP Office window • Navigate to the Disk > system > primary folder in the Embedded File Management window. March 2015 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
UNIStim IP Deskphone migration from CS 1000 to IP Office Figure 101: IP Office manager – Embedded File Management window • In Windows Explorer, open the folder that was created in Step 3. • Select the created configuration files in Windows Explorer and drag-and-drop them to the Disk > system > primary folder in the Embedded File Management window. 5. Configure the DHCPv4 server. The DHCP server must provide option 66 with the IP address of the IP Office that will be used as a provisioning server.
Migrating IP Deskphones with UNIStim firmware from CS 1000 to IP Office The following is an example of an appropriate configuration file for a Linux dhcpd DHCPv4 server. Please refer to the documentation of your DHCP server on how to configure the appropriate configuration file. dhcpd.conf: .....
UNIStim IP Deskphone migration from CS 1000 to IP Office 6. Force a reboot of the IP Deskphones by running the isetResetAll command in the Signaling Server shell. Result 1. The IP Deskphone reboots. 2. During bootup, the IP Deskphone sends a DHCP request with Vendor Class ID “Norteli2004-A” or “Nortel-i2004-B”. The DHCP server sends back a DHCP response with the IP Deskphone’s IP address and the URL of the IP Office server (in DHCP option 66). 3.
Appendix A: User provisioning using System Manager 6.3 FP2 This appendix describes how to add an IP Deskphone user to Avaya Aura® using System Manager 6.3 FP2. Related Links Adding an IP Deskphone user to Avaya Aura® using System Manager 6.3 FP2 on page 429 Adding an IP Deskphone user to Avaya Aura® using System Manager 6.3 FP2 1. Open a browser and navigate to the System Manager (SMGR) login page, as shown in the following figure. Figure 102: System Manager login page 2.
User provisioning using System Manager 6.3 FP2 Figure 103: System Manager front page 3. In the Users pane on the left, click User Management. 4. Click Manage Users, and then click New, as shown in the following figure. Figure 104: User Management page 5. On the Identity tab, shown in the following figure, enter the user information. The minimum information required is Last Name, First Name, and Login Name. The Login Name format is extension_number@; for example, 4655@mycompany.
Adding an IP Deskphone user to Avaya Aura® using System Manager 6.3 FP2 Figure 105: System Manager New User Profile page 6. In the upper-right corner, click Commit & Continue. 7. Click the Communication Profile tab. The Communication Profile window opens, as shown in the following figure. Figure 106: Communication Profile tab 8. In the Communication Profile pane, in the Communication Profile Password field, enter the password that the user will input to log into the IP Deskphone.
User provisioning using System Manager 6.3 FP2 Figure 107: Communication Profile > Session Manager Profile 12. Check the Session Manager Profile check box. 13. In the SIP Registration section: a. Select the Primary Session Manager from the drop-down list. b. If available, select the Secondary Session Manager from the drop-down list. 14. In the Application Sequences section, select the Communication Manager for both the Origination Sequence and the Termination Sequence from the drop-down lists. 15.
Adding an IP Deskphone user to Avaya Aura® using System Manager 6.3 FP2 Related Links User provisioning using System Manager 6.3 FP2 on page 429 March 2015 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Appendix B: Quickstart — Add an 1100 Series IP Deskphone to Avaya Aura® This appendix is a quickstart guide to adding one IP Deskphone to Avaya Aura®. The 1120E IP Deskphone is used as an example. Related Links Adding a new IP Deskphone to Avaya Aura® on page 434 Adding a new IP Deskphone to Avaya Aura® 1. Use System Manager (SMGR) to add the new extension. Use the same approach/steps as configuring a 96x1 SIP phone. Use the 9600SIP_Default_CM_ template.
Adding a new IP Deskphone to Avaya Aura® PROTOCOL HTTP 4. Create the phone’s DeviceConfig.dat device configuration file. AVAYA_AURA_MODE_ENABLE YES USE_DEFAULT_DEV_CERT YES SIP_DOMAIN1 mycompany.com SERVER_IP1_1 135.20.253.150 SERVER_TLS_PORT1_1 5061 5. Store all 3 config files (11xxe.cfg, 11xxeSIP.cfg, DeviceConfig.dat) on the Aura Utility Server using IP Phone Tools > IP Phone Custom File Upload, as shown in the following figure. Figure 108: IP Phone Tools > IP Phone Custom File Upload screen 6.
Quickstart — Add an 1100 Series IP Deskphone to Avaya Aura® b. Press the Auto soft key. Un-check the Provision Server check box and press the Config soft key. c. In the Provision field, enter the Utility Server IP address. Press the OK soft key and then press the Apply soft key. Note: Toggle the “1” key to obtain ‘:’, ‘/’ and ‘.’. 8. Reboot the IP Deskphone. The IP Deskphone may reboot again after obtaining the config.dat file. 9. Log in with the User ID (extension number) and password.
Appendix C: Configuring FACs and FNEs for the IP Deskphones on Avaya Aura® This appendix provides information on configuring Feature Access Codes (FACs) and Feature Number Extensions (FNEs) for the IP Deskphones on Avaya Aura®. Related Links Configuring FACs for the IP Deskphones on page 437 Configuring FNEs on page 439 Configuring FACs for the IP Deskphones Feature Access Codes (FACs) are configured in System Manager (SMGR). in Home > Elements > Communication Manager > System > Feature Access Codes.
Configuring FACs and FNEs for the IP Deskphones on Avaya Aura® 3. Input FAC codes consistent with your dial plan and click Enter when finished. Related Links Configuring FACs and FNEs for the IP Deskphones on Avaya Aura® on page 437 438 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Configuring FNEs Configuring FNEs Configuring Feature Name Extensions (FNEs) is a two-part process. 1. Configure the FNEs in SMGR Cut Through or in Communication Manager SAT. 2. Add the FNEs as Implicit Users to the Session Manager (SM). Configuring the FNEs FNEs are configured on Communication Manager but can be accessed through System Manager using the path Home > Elements > Communication Manager > Element Cut-Through. 1. Go to Communication Manager Element Cut-Through page. 2.
Configuring FACs and FNEs for the IP Deskphones on Avaya Aura® Adding FNEs as Implicit Users FNEs are added as Implicit Users in Session Manager after the FNEs have been configured. 1. In System Manager, go to Home > Elements > Session Manager > Application Configuration > Implicit Users. 2. Click New to add an FNE, or click Edit to change an FNE. 3. Enter the data for the FNE and click Commit. 4. Repeat steps 2 and 3 for each FNE to be added or changed.
Appendix D: Creating a speed dial list For ease of access to frequently-used features, you can configure a Features speed dial list. Determine the key features that are used and create a speed dial list to easily access those features. Example: In this example, a speed dial list has been created for the EC500 feature set. When the Features key is pressed, the IP Deskphone displays the EC500 feature options. The user presses 1, 2, or 3 to dial the desired EC500 FNE.
Creating a speed dial list 3. DEFAULT_SPEEDDIALLIST_FILE
Creating the speed dial list file FNE_Speeddiallist.txt [key] label=EC500 Enable target=4914@mycompany.com [key] label=EC500 Disable target=4924@mycompany.com [key] label=EC500 Self-Administration target=15@mycompany.com subject=Enter number Related Links Creating a speed dial list on page 441 March 2015 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Appendix E: References and additional documentation Related Links References on page 444 Additional documentation on page 445 References • Configuring SMGR 6.2 LDAP Synchronization white paper. http://support.avaya.com/css/P8/documents/100145665. • System Manager “Managing bulk importing and exporting”. See Administering Avaya Aura® System Manager Release 6.3. http://support.avaya.com/css/P8/documents/100168146 • Application Notes for Avaya 1100- and 1200-Series IP Deskphones R3.
Additional documentation Additional documentation User Guides (Avaya Aura® system) • Avaya 1120E IP Deskphone with SIP Software on Avaya Aura® User Guide, 16-604273 • Avaya 1140E IP Deskphone with SIP Software on Avaya Aura® User Guide, 16-604274 • Avaya 1165E IP Deskphone with SIP Software on Avaya Aura® User Guide, 16-604275 • Avaya 1220 IP Deskphone with SIP Software on Avaya Aura® User Guide, 16-604276 • Avaya 1230 IP Deskphone with SIP Software on Avaya Aura® User Guide,16-604277 User Guides (other s
Index Numerics 802.1ab Link Layer Discovery Protocol (LLDP) .................223 802.1x (EAP) authorization ................................................223 802.1x (EAP) device ID ..................................................... 223 802.1x (EAP) password ..................................................... 223 A Add an 1100 Series IP Deskphone to Avaya Aura® ..........434 Adding an IP Deskphone user to Avaya Aura® using System Manager 6.3 FP2 .......................................................
Index Downloading the SIP Software .................................... 46, 144 Downloading UNIStim software through TFTP on bootup .147 DRegex ..............................................................................127 DRegex rules ..................................................................... 127 Duplicated IPv6 Address message ....................................345 Duplicate IPv6 address ........................................................
Index P Permanently disable Port Mirroring ..................................... 19 Personal Profile Manager, contact lists in ..........................385 Personal Profile Manager configuration .............................385 Personal Profile Manager support ............................... 22, 384 Phone will reconnect message ............................................ 13 Port functions on the three-port switch when VLAN is enabled .......................................................................
Index Utility Server ...................................................................... 405 V Vertical services (MADN) ...................................................185 Voice-VLAN and Data VLAN ............................................. 220 VQMon configuration commands ...................................... 117 VQMon - how it works ........................................................166 VQMon set-up ....................................................................165 W WAV files ......