SIP Software for Avaya 1200 Series IP Deskphones-Administration Release 4.3 SP2 NN43170-601 Issue 05.02.
© 2013 Avaya Inc. Heritage Nortel Software All Rights Reserved. “Heritage Nortel Software” means the software that was acquired by Avaya as part of its purchase of the Nortel Enterprise Solutions Business in December 2009. The Heritage Nortel Software currently available for license from Avaya is the software contained within the list of Heritage Nortel Products located at http://support.avaya.com/ LicenseInfo under the link “Heritage Nortel Products”.
parties. Users are not permitted to use such Marks without prior written consent from Avaya or such third party which may own the Mark. Nothing contained in this site, the Documentation and Product(s) should be construed as granting, by implication, estoppel, or otherwise, any license or right in and to the Marks without the express written permission of Avaya or the applicable third party. Avaya is a registered trademark of Avaya Inc.
SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Contents Chapter 1: New in this release........................................................................................... 13 Features.................................................................................................................................................... 13 Failover support in centralized deployment (IP Office 8.0, ABG 5800 6.2)...................................... 13 DHCP enhancements.......................................................................................
Server and network configuration commands.................................................................................. Feature configuration commands..................................................................................................... QoS and ToS commands................................................................................................................. Tone configuration commands...............................................................................................
802.1x (EAP) Port-based network access control.................................................................................... 120 Authorization............................................................................................................................................. 121 Device ID................................................................................................................................................... 121 Password.................................................
Cable unplugged....................................................................................................................................... 154 Line keys................................................................................................................................................... 155 Making a call............................................................................................................................................. 156 Receiving a call.....................
Chapter 17: Session Timer Service................................................................................... 193 Session-Expires header............................................................................................................................ 193 Min-SE header.......................................................................................................................................... 193 Provisioning........................................................................
Signing a resource file............................................................................................................................... 232 Device certificate installation..................................................................................................................... 233 Device certificate profiles.......................................................................................................................... 234 SCEP..............................................
Chapter 26: Licensing......................................................................................................... 293 Licensing framework................................................................................................................................. 294 Characteristics of the licensing framework................................................................................................ 294 License file download................................................................
Stack Overflow Monitor.................................................................................................................... Traffic Monitor.................................................................................................................................. PDT commands........................................................................................................................................ Device configuration file.....................................................
Chapter 1: New in this release SIP Software for Avaya 1200 Series IP Deskphones- Administration , NN43170-601 supports SIP Software Release 4.3 andSIP Software Release 4.3 Service Pack 2 (SP2). This document contains administration information for the Avaya 1220 IP Deskphone and Avaya 1230 IP Deskphone. Features SIP Software Release 4.3 introduces support for the following: • Failover support in centralized deployment (IP Office 8.0 ABG 5800 6.
New in this release when it detects that the current server is unreachable. The IP Deskphone stays with the new server, not switching back unless the new server fails. 2. In Survivable Branch mode, the IP Deskphone is configured with IP addresses for a primary server and a secondary server. When the primary server is unreachable, the IP Deskphone switches to the secondary server. The IP Deskphone continues to monitor the primary server and switches back to the primary server as soon as it is back on line.
Features If an IP Deskphone fails to obtain an IP address from the DHCP process, SIP 4.3 enables the IP Deskphone to use the phone's previously-used IP address, as long as there is not an IP address conflict. The following configuration parameter is introduced: CACHED_IP_ENABLED [YES|NO] (default value is NO) If DHCP=YES on the IP Deskphone, then the cached IP parameter can also be modified through the IP Deskphone's UI in the Network > Diagnostics menu. DHCP untag: SIP 4.
New in this release Check-synch enhancement (IP Office 8.0) The Remote Check for Update feature allows SIP servers to start a check for an update remotely using the event called check-sync. This feature enables the IP Deskhones to be updated with the latest firmware/configuration files present on the provisioning server. This feature is enabled/disabled using the REMOTE_CHECK_FOR_UPDATE parameter in the Device Configuration file. SIP 4.
Features Remote control talk and hold (IP Office 8.0) In SIP 4.3, when providing CTI-based applications such as desktop call control clients, the IP Office One-X™ application can remotely request: • an endpoint answer an incoming call without local user intervention • remotely retrieving a call that has been previously held • a call be put on hold without local user intervention Hotline option configuration in User Preferences (IP Office 8.0) SIP 4.3 provides the ability for IP Office 8.
New in this release Customize feature/line key labels SIP 4.3 provides the ability to create and edit a label for a line key through the IP Deskphone user interface. If the IP Deskphone user enters a blank label, and a default key label had been created in the custom keys file, then the default key label overrides the blank key label. For more information, see the User Guide for the appropriate IP Deskphone model. SIP 4.3 Service Pack 2 (SP2) SIP 4.3 SP2 introduces the following changes.
Revision history SIP Domain DNS Lookup feature The DNS Lookup feature enables the IP Deskphone to discover IP addresses for a specified SIP domain using DNS. See SIP Domain DNS Lookup feature on page 184. HTTP 503 response enhancement SIP 4.3 introduces the following parameter for the Device Configuration file: HTTP_RETRY_NUMBER If the IP Deskphone receives a HTTP 503 response from the server (server unavailable), the IP Deskphone performs up to HTTP_RETRY_NUMBER attempts to connect to the server again.
New in this release November 2012 Standard 04.04. This document is up-issued to remove references to Broadsoft content, April 2012 Standard 04.03. This document is up-issued for changes to the Multiuser and Multiple Appearance Directory Number sections, the IP Deskphone to Server Options section and the IP Deskphone Security section. February 2012 Standard 04.02. This document is up-issued to include revised content in the section IP Deskphone to Server options on page 94. December 2011 Standard 04.
Revision history October 2010 Standard 01.03. This document is up-issued to reflect changes in the configuration of TLS for SIP. September 2010 Standard 01.02. This document is up-issued with minor revisions to support SIP Software Release 3.2. August 2010 Standard 01.01. This document is a new document and is issued to support SIP Software Release 3.2.
New in this release 22 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
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 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://www.avaya.com/support. 24 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 3: Introduction to this guide Subject This document describes how to install, configure, and provision the Avaya 1220 IP Deskphone and Avaya 1230 IP Deskphone for use on a SIP network. The Avaya 1220 IP Deskphone and Avaya 1230 IP Deskphone are collectively known as Avaya 1200 Series IP Deskphones. In this document, the Avaya 1220 IP Deskphone and Avaya 1230 IP Deskphone are referred to as IP Deskphones.
Introduction to this guide 26 DCP Device Certificate Profile DET Distinguished Encoding Rules DHCP Dynamic Host Configuration Protocol DN Distinguished Name DND Do Not Disturb feature DNS Domain Name System DRegex Digit Regular Expression DSCP Differentiated Services Code Point EAP Extensible Authentication Protocol ECR Error Collection and Recovery EJBCA Enterprise Java Bean Certificate Authority ERE Extended Regular Expressions FQDN Fully Qualified Domain Name FTP File Transfe
Acronyms NAT Network Address Translator NetConfig Configuration screens available after an IP Deskphone resets NDU Network Diagnostic Utility OAM Operation, Administration (and) Maintenance PDT Problem Determination Tool PEAP Protected Extensible Authentication Protocol PEC Product Engineering Code PKCS#12 Public Key Cryptographic Standard #12 POE Power Over Ethernet POSIX Portable Operating System Interface PRACK Provisional Acknowledgement PSTN Public Switched Telephone Network PV
Introduction to this guide TPS Terminal Proxy Server TTL Time-to-live UDP User Datagram Protocol UFTP UNIStim File Transfer Protocol UI User Interface UNIStim Unified Network IP Stimulus Protocol VoIP Voice over IP VLAN ID Virtual Local Area Network Identification VLAN IP Virtual Local Area Network Internet Protocol VQMon Voice Quality Monitoring Related publications Other publications related to the SIP Software for Avaya 1200 Series IP Deskphones administration include the following:
Chapter 4: Overview Introduction This chapter describes the hardware and software features of the Avaya 1200 Series IP Deskphones and provides a brief overview of Session Initiation Protocol (SIP). In this document, Avaya 1200 Series IP Deskphones are 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. SIP is a text-based protocol similar to HTTP and SMTP.
Overview This chapter explains how to: • configure the provisioning server and the DHCP server. Note: The provisioning server is where the software and the configuration files for the IP Deskphones. • convert an IP Deskphone with UNIStim software to an IP Deskphone with SIP software • provision the Device Settings parameters on the IP Deskphones with SIP software Important: Converting the software on an IP Deskphone from UNIStim software to SIP software overwrites the UNIStim software.
Related documentation Related documentation The Avaya 1200 Series IP Deskphones with SIP Softphone User Guide 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, and call park • use other features such as speed dial,
Overview network-configuration data or a more comprehensive set of network-configuration data for the IP Deskphone with SIP Software. 2. Load SIP Software on the IP Deskphone. 3. Configure the initial network-configuration parameters on the IP Deskphone with SIP Software. 32 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Installation overview Figure 2: Installation of Avaya 1230 IP Deskphone with SIP Software, page 1 of 2 SIP Software for Avaya 1200 Series IP Deskphones-Administration September 2013 33
Overview Figure 3: Installation of Avaya 1230 IP Deskphone with SIP Software, page 2 of 2 34 SIP Software for Avaya 1200 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 1200 Series IP Deskphone. 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 Item Avaya 1220 IP Deskphone order number 2.3 m (7 ft) CAT5 Ethernet cable Avaya 1230 IP Deskphone order number NTYS13AA The IP Deskphone can be powered either by Power Over Ethernet (POE) or through an external AC power adapter. Order the external AC adapter global power supply separately. Warning: Do not use the AC power adapter if you are connected to a Power over the Ethernet (PoE) connection. Only use the AC power adapter when you do not have a PoE connection.
Preinstallation • One of the following file servers used as a Provisioning server: - TFTP server - FTP server - HTTP server Only a TFTP server can be used for an initial UNIStim-to-SIP Software conversion. An IP Deskphone with SIP Software can operate with a TFTP, FTP, or HTTP file server.
Before installation 38 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 6: Configure the provisioning server 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 105 for instructions on how to convert the software on an IP Deskphone from UNIStim to SIP. If the IP Deskphone is installed with SIP Software, further SIP Software upgrades can be done with a TFTP, an FTP, or an HTTP server.
Configure the provisioning server provisioning file (for example, 1230SIP.cfg) can contain commands that prompt for confirmation before a file is downloaded. Download the SIP software to the provisioning server To download the SIP software, perform the following procedure. Downloading SIP software for the IP Deskphone 1. Go to http://www.avaya.com/support. 2. Log on to the Avaya Web site with a valid Avaya User ID and Password. The Support page appears. 3.
Create the SIP provisioning file on the provisioning server SIP Software for Avaya 1200 Series IP Deskphones-Administration Figure 4: Sample provisioning file September 2013 41
Configure the provisioning server Table 4: Provisioning file supported sections [DEVICE_CONFIG] Device configuration file [FW] Firmware image [DIALING_PLAN] Dialing plan [LANGUAGE] Downloadable language files (more than one can be specified in each section) [IMAGES] Downloadable images [TONES] Downloadable tones (.
Create the SIP provisioning file on the provisioning server this file is associated. Language files are signed by Avaya and are authenticated by the software for security reasons.
Configure the provisioning server • [LOGIN_BANNER] — section for the log in banner files • [USER_CONFIG] — section for IP Deskphone-specific configuration file IP Deskphone-specific configuration files support customizing the IP Deskphone on a per IP Deskphone/user level. Parameters in the device configuration file can be overwritten with a IP Deskphone-specific configuration file.
Create the SIP provisioning file on the provisioning server Note: In FORCED or AUTO DOWNLOAD_MODE, the version number is overwritten with each software download. • FILENAME [filename] — specifies the file name to be downloaded for this section. For the language and tone section, the use of multiple filenames is allowed. Optional keywords in the Provisioning file are: • PROMPT [YES | NO] — used to indicate if the IP Deskphone should prompt the user for an update before the operation is performed.
Configure the provisioning server • SRV_USER_NAME [username] — If the protocol is FTP or HTTP, this keyword specifies the user name to log on to the server. • SRV_USER_PASS [password] — If the protocol is FTP or HTTP, this keyword specifies the password to log on to the server. The downloading of these files is initiated when an IP Deskphone is powered on, when an automatic check for updates is invoked, or when you select Srvcs > System > Erase User Data.
Create the device configuration file Create the device configuration file After the IP Deskphone downloads the provisioning file from the provisioning server, the IP Deskphone reads the [DEVICE_CONFIG] section and is directed to download the device configuration file from the provisioning server. The device configuration file is a clear text file and the naming convention is defined by the administrator. See the FILENAME keyword in the [DEVICE_CONFIG] section of the SIP provisioning file.
Configure the provisioning server Table 5: Device configuration commands Configuration command type 48 Configuration commands Server and network configuration commands SIP_DOMAIN1 SIP_DOMAIN2 SIP_DOMAIN3 SIP_DOMAIN4 SIP_DOMAIN5 SERVER_IP1_1 SERVER_IP1_2 SERVER_IP2_1 SERVER_IP2_2 SERVER_IP3_1 SERVER_IP3_2 SERVER_IP4_1 SERVER_IP4_2 SERVER_IP5_1 SERVER_IP5_2 SERVER_PORT1_2 SERVER_PORT2_2 SERVER_TCP_PORT2_2 SERVER_TCP_PORT3_2 SERVER_TCP_PORT4_2 SERVER_TCP_PORT5_2 SERVER_TLS_PORT1_2 SERVER_TLS_PORT2_2 SERVE
Create the device configuration file Configuration command type Configuration commands SERVICE_PACKAGE_PROTOC OL Feature configuration commands (continued) PROXY_CHECKING ENABLE_BT AUTH_METHOD BANNER FORCE_BANNER DST_ENABLED TIMEZONE_OFFSET FORCE_TIME_ZONE IM_MODE IM_NOTIFY FAST_EARLY_MEDIA_ENABLE DEF_DISPLAY_IM CALL_WAITING DISTINCTIVE_RINGING USE_RPORT TOVM_SOFTKEY_ENABLE TOVM_VOICEMAIL_ALIAS TOVM_VOICEMAIL_PARAM MAX_RING_TIME ENABLE_UPDATE E911_TERMINATE_ENABLE E911_USERNAME E911_PASSWORD HOLD_TYPE
Configure the provisioning server Configuration command type 50 Configuration commands Feature configuration commands (continued) CUST_CERT_ACCEPT CERT_ADMIN_UI_ENABLE SEC_POLICY_ACCEPT SECURITY_LOG_UI_ENABLE KEY_SIZE KEY_ALGORITHM TLS_CIPHER SIGN_SIP_CONFIG_FILES FP_PRESENTED FP_ENTERED ADHOC_ENABLED1 ADHOC_ENABLED2 ADHOC_ENABLED3 ADHOC_ENABLED4 ADHOC_ENABLED5 PREFER_CUSTOMIZED_RBT SUBJ_ALT_NAME_CHECK_ENA BLE SECURITY_POLICY_PARAM_CH ANGE CERT_EXPIRE AUTO_PRV_ACCEPT DWNLD_CFG_ACCEPT AUTO_PRV_SIGNING
Create the device configuration file Configuration command type Configuration commands AUDIO_CODEC3 AUDIO_CODEC4 AUDIO_CODEC5 AUDIO_CODEC6 Deskphone bugs logging/ Recovery commands AUDIO_CODEC12 AUDIO_CODEC13 AUDIO_CODEC14 AUDIO_CODEC15 RECOVERY_LEVEL LOG_LEVEL Device configuration commands Caution: The syntax of the device configuration file is case sensitive. Verify that the commands entered follow the case defined in this document.
Configure the provisioning server • SERVER_PORT[x]_[y] [port_number] — configures the signaling ports for each proxy. - x - the domain number. - y - the corresponding primary and secondary IP addresses. y=1 indicates the primary address and y=2 indicates the secondary address. - port_number - the SIP proxy signaling port (default is 5060). • SERVER_TCP_PORT[x]_[y] [port_number] — This parameter configures the signaling TCP ports for each proxy. - x — the domain number.
Create the device configuration file The default value is YES if not specified in the device configuration file. If SIP_PING is changed in the Device configuration file, the IP Deskphone must be rebooted for the change to take effect. - YES - enables pinging - NO - disables pinging • IPV6_ENABLE [YES] [NO] — This parameter must be applied at boot time prior to the network being enabled. The default value is NO. When this parameter is enabled, IPv4/ IPv6 are supported on the IP Deskphone.
Configure the provisioning server If HTTP_RETRY_NUMBER is not specified in the Device Configuration file, the default number of attempts is applied. If HTTP_RETRY_NUMBER is set to 0 in the Device Configuration file, the IP Deskphone performs HTTP retries continuously until it receives a response other than HTTP 503. If the HTTP_RETRY_NUMBER is configured as a negative value, the default number of attempts is applied.
Create the device configuration file - NO – disables SRTP (default). • 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 • SSHPWD — This parameter configures SSH and SFTP passwords. The maximum limit is 49 characters. Feature configuration commands • TOVM_SOFTKEY_ENABLE [YES | NO] - YES - enables the toVM soft key on the IP Deskphone.
Configure the provisioning server Note: The RTP port configuration parameters must satisfy the constraints that (RTP_MAX_PORT - RTP_MIN_PORT) is greater than or equal to 10 and less than 1000. Note: If there is a provisioning error, RTP_MIN_PORT is reset to the default value of 50000 and RTP_MAX_PORT is reset to the default value of 50100. An error message is logged.
Create the device configuration file Note: ENABLE_UPDATE is provisioned after user logoff. • 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] — is the voice mail address, which can be the URI or the DN number of the voice mail server. This command takes a string as a parameter.
Configure the provisioning server 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”. — opt_string = code of the Send Message option Example: IPOFFICE_MSG_CODE *5 Note: The option is available if IP_OFFICE_ENABLE is YES.
Create the device configuration file OR - 1 - turns on the Autologin feature. - 0 - turns off the Autologin feature. - 2 - enables the Autologin ID feature using the User ID 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.
Configure the provisioning server - NO - turns off the AUTO_UPDATE feature. Note: If the IP Deskphone encounters any Major or Critical error in memory during the Auto update process, the IP Deskphone reboots based on the recovery level configured. • AUTO_UPDATE_TIME [x] — is the actual time in seconds, starting from midnight, before an automatic update occurs.
Create the device configuration file Note: ENABLE_PRACK must be configured as NO when connected to the MCS 5100 Release 3.5 system. Note: ENABLE_PRACK is provisioned after user logoff. - NO - disables PRACK and is the default value. - YES- enables PRACK. • ENABLE_INTERWORKING [YES | NO] This command is used to enable the interworking feature to pre-authorize users or groups of users to access automatic call answer. The configuration values are YES and NO. The default value is NO.
Configure the provisioning server any other parameter is entered or if these commands are misspelled, 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] — is used to configure the SIP authentication method.
Create the device configuration file Table 6: Time zone offset Location Time zone offset (seconds) (GMT-10:00) Hawaii -36000 (GMT-09:00) Alaska -32400 (GMT-08:00) Pacific time (US and Canada) -28800 (GMT-07:00) Mountain time (US and Canada) -25200 (GMT-06:00) Central time (US and Canada) -21600 (GMT-05:00) Eastern time (US and Canada) -18000 (GMT-04:00) Atlantic time (US and Canada) -14400 (GMT-03:00) Brasilia, Buenos Aires -10800 (GMT+00:00) Greenwich, Dublin, Lisbon, London 0 (GMT+01:
Configure the provisioning server - DISABLED - Instant Messaging is turned off and no Instant Messages can be sent or received. Note: According to Federal Requirements: - If the parameter FIPS_MODE=NO and IM_MODE=TEXT, the IM_MODE is changed to ENCRYPTED by force. - If the parameter FIPS_MODE=YES, the IM_MODE is changed to TEXT by force • IM_NOTIFY [YES | NO] — is used to turn on or off the Blue LED indicator upon receipt of an Instant Message.
Create the device configuration file • MAX_INBOX_ENTRIES [x] — used to restrict the maximum number of inbox entries and takes a number as a parameter. For example, MAX_INBOX_ENTRIES 100 limits the number of entries in the inbox to 100. The default limit is 100. - x - the maximum number of in box entries. • MAX_OUTBOX_ENTRIES [x] — used to restrict 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.
Configure the provisioning server • MAX_IM_ENTRIES [x] — used to configure 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] — used to configure the maximum number of entries in the address book and takes a number as a parameter. The default limit is 100.
Create the device configuration file - NO - the pound (#) key functions as any other digit or character on the dial pad typically used in networks that use vertical service codes or access codes. • FORCE_OCT_ENDDIAL [YES | NO] — a flag used to override attempts to change the function of the pound (#) key on the Graphical User Interface (GUI). The default setting is NO. - YES - overrides attempts to change the function of the pound (#) key on the GUI.
Configure the provisioning server - NO - the ring splash does not play. • DISPLAY_CALL_SNDR_IM_KEY [YES|NO] — This parameter allows the administrator to display or hide the Call soft key when viewing Instant Messages (IMs). The default setting is YES. - YES – the Call soft key is displayed - NO – the Call soft key is not displayed • FORCE_CFWD_NOTIFY [YES | NO ] — allows the administrator to force the behavior of the DEFAULT_CFWD_NOTIFY value on all users who login to the IP Deskphone.
Create the device configuration file - NO – the Call Serverr does not support ad hoc conferencing. • MAX_ADHOC_PORTS[x] [max_ports_number] — This parameter configures the maximum number of adhoc conference participants that can join the conference on the IP Deskphone. - x – the SIP domain number from 1 to 5 - max_ports_number - number of participants from 0 to 4. The default value is 0. • INTERCOM_PAGING [YES | NO] — allows the IP Deskphone to belong to a paging group.
Configure the provisioning server • E911_PROXY — a default emergency proxy. This variable must contain the value that matches the value defined by one of the following variables specified in the same config file: - SIP_DOMAIN1 - SIP_DOMAIN2 - SIP_DOMAIN3 - SIP_DOMAIN4 - SIP_DOMAIN5 If E911_PROXY does not match the value defined by these five variables, or the variable E911_PROXY is not defined, then the value of SIP_DOMAIN1 is used as the emergency proxy.
Create the device configuration file Note: There are some application screens that do not time out. Some menus, such as the administration menus, require the user to press the Back or Quit key to exit the screen. • AUTOCLEAR_NEWCALL_MSG [YES | NO] — used to configure the missed calls notification mode. Y means that the notification is cleared as soon as the inbox is entered without needing to visit all missed entries. The values are Y and N. The default value is N.
Configure the provisioning server • USE_BG_IMAGE — used to configure the background image for the display of newly created profiles by specifying a file name available on the FFS. BG_IMAGE_ENABLE must be configured as Y in order to select a background image. Note: Image files for the IP Deskphone must be in PNG format. • SPEEDLIST_KEY_INDEX — used to specify the programmable key used for displaying the Speed Dial List.
Create the device configuration file • BLF_RESOURCE_LIST_URI — used to configure the Busy Lamp Field (BLF) resource list URI for the BLF feature. You must use the URI provided by the proxy when properly configuring the user for BLF. The is the server provided URI to subscribe for BLF notifications, for example, blf-resource-list@as.avaya.com . • FM_PROFILES_ENABLE [YES | NO] — This parameter allows the user to perform actions on User Profiles using the file manager.
Configure the provisioning server is not a real URL of the Hotline target. The IP Deskphone has no idea about the Hotline target. The Proxy server replaces the To field of INVITE request message with a real Hotline target when it receives an INVITE request from the Hotline Phone. The default value is Hotline. • SESSION_TIMER_ENABLE [YES | NO] indicates if the session timer service is enabled or disabled. The values are Yes and No. The default value is Yes.
Create the device configuration file • MEMCHECK_PERIOD — used to determine the time period in seconds when the Memory monitor wakes up (after re-start or the last memory check attempt). The values are 1800 (0.5 hrs) to 86400 (24 hrs). The default value is 86400 (24 hrs). • DOS_PACKET_RATE — determines the maximum number of packets per second that is allowed. • DOS_MAX_LIMIT — specifies how many packets past the DOS_PACKET_RATE the IP Deskphone can receive before packets are dropped.
Configure the provisioning server RSA_WITH_AES_256_CBC_SHA. The default value is RSA_WITH_AES_256_CBC_SHA. • SIGN_SIP_CONFIG_FILES [YES | NO] — overrides the file signing of files (resource files such as the device configuration file and the dial plan) other than the Security Policy and Customer Certificates. The values are YES and NO. The default value is NO. - YES — Signing is required. - NO — No authentication check is performed.
Create the device configuration file if the customer certificates are installed. The default parameter value is no. The following are the acceptable values for this parameter: - NO — If there is a customer certificate installed, the downloaded file is automatically accepted without authentication. - YES — If there is a customer certificate installed, the downloaded file must be signed and fully authenticated.
Configure the provisioning server - NO - the Answer-Mode is not supported (default). • ANSWER_MODE_MAXALLOWADDR [max_addr] — This parameter specifies the maximum number of addresses that can be white-listed for Answer-Mode support. The allowed values are from 0 to 200. The default value is 100. — max_addr - maximum number of addresses • ANSWER_MODE_MICMUTE [YES | NO] — This parameter specifies if the microphone is muted when a call is auto-answered by the Answer-Mode functionality.
Create the device configuration file • 802.1P_CONTROL [x] — a value entered in decimal format between -1 and 7 representing the 802.1P value in the SIP signaling 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] — a value entered in decimal format between -1 and 63 representing the DSCP value in the Real-time Transfer Protocol packets.
Configure the provisioning server 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. - off_time - the duration when no tone is played.
Create the device configuration file NAT configuration commands • NAT_SIGNALLING [NONE | SIP_PING | STUN] — indicates the type of protocol used for NAT traversal in the signaling port. The IP Deskphone with SIP Software supports two methods of NAT traversal of the signaling path: SIP_PING and STUN. - NONE - If the value is not configured as None, this parameter overrides the value of the parameter SIP_PING in the device configuration file. - SIP_PING - an Avaya proprietary NAT traversal protocol.
Configure the provisioning server VQMon configuration commands It is important to read How VQMon works on page 116 before configuring the VQMON parameters. • VQMON_PUBLISH [YES | NO] — the command that is used to enable or disable the publish message containing the voice quality monitoring metrics sent to the Proactive Voice Quality Monitoring (PVQMoN) collecting server. - YES - enables VQMoN. - NO - disables VQMoN. NO is the default. • VQMON_PUBLISH_IP [xxx.xxx.xxx.
Create the device configuration file lost since the beginning of reception. The value is an integer scaled by 256. The range is 1 to 25600. - YES - enables the sending of alert report based on the packet loss - NO - disables the sending of alert report based on the packet loss • PACKET_LOSS_WARN [xx] — the threshold to send a report on Packet Loss greater than [xx]. The default is 256 (1%). Using 0 resets the threshold to default. - xx - is an INTEGER value scaled by 256 that is used as threshold.
Configure the provisioning server • SESSION_RPT_EN [YES | NO] — used to enable or disable periodic VQMon session reports. The default is disabled. Both session report enable and session report interval must be configured if the IP Deskphone software has been upgraded to SIP Release 3.0 or later. Otherwise, the SESSION_RPT_INT default of 60 seconds is used automatically. - YES - enables periodic VQMon session reports. - NO - disables periodic VQMon session reports. Default is NO.
Create the IP Deskphone-specific configuration file on the provisioning server - 1 - IP Deskphone recovers from Critical error - 2 - IP Deskphone recovers from Major and Critical errors Default is 255, which is equivalent to the recovery level of 2. • LOG_LEVEL [x] — This parameter defines which IP Deskphone bugs are logged in the ECR file. The following values are used for configuring the logging level on the IP Deskphone. x - level of bugs from 0 to 255. The default value is 2.
Configure the provisioning server Table 7: IP Deskphone configuration commands on page 86 provides a summary of the commands that can be used in the IP Deskphone configuration file. The syntax of each command is summarized in User Login commands on page 86. Table 7: IP Deskphone configuration commands Auto login AUTOLOGIN_ID_KEY01 AUTOLOGIN_PASSWD_KEY01 User Login commands • AUTOLOGIN_ID_KEY01 [* | xx] [userID@domain name] — This parameter is located within the IP Deskphone-specific configuration file.
Create the Dialing Plan file on the provisioning server Create the Dialing Plan file on the provisioning server A dialing plan essentially describes the number and pattern of digits that a user dials to reach a particular telephone number. Access codes, area codes, specialized codes, and combinations of the number of digits dialed are all part of a dialing plan.
Configure the provisioning server Figure 6: Sample dialing plan Dialing function description Dialing plan If the IP Deskphone encounters a [DIALING_PLAN] section while parsing the 12xxSIP.cfg configuration file, the IP Deskphone downloads the specified dialing plan configuration file from the provisioning server. 88 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Create the Dialing Plan file on the provisioning server As most IP Deskphone users are used to dialing digits to indicate the address of the destination, there is a need to specify the rule by which digits are transformed into a URI. The IP Deskphone with SIP Software dialing plan contains two sections delimited by two percent signs (%%). Figure 7: Sample dialing plan declarations section In the declaration section, the administrator can define the variables.
Configure the provisioning server Figure 9: Sample dialing plan digit map section The first part of a dialing plan contains a pattern defined with DRegex, which is used for matching the dialed number. The patterns are separated by the pipe (|) sign. The second part contains the result string used in the dial step. The third part defines the parameters used by UA in dialing action. The following parameter is currently defined: t=xxxx: After this timer expires, the number entered is automatically dialed.
Create the Dialing Plan file on the provisioning server Figure 10: DRegex rules SIP Software for Avaya 1200 Series IP Deskphones-Administration September 2013 91
Configure the provisioning server Downloadable WAV files It is possible to customize the ring tones on the IP Deskphone with SIP Software. Up to five special ring tones can be downloaded from the provisioning server and stored on the IP Deskphone. The end user can select which ring tone they would like to implement. In order to download these special files, the files must reside on the provisioning server and be specified in the SIP provisioning file.
Chapter 7: Configure the DHCP Server The Avaya 1200 Series 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 Net mask 1 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 Old Site Specific Options 128, 131, 144, 157, Options are supported, but not recommended 188, 191, 205, 219, for new installations. These options are 223 reclaimed according to RFC 3942.
Chapter 8: Install the IP Deskphone Complete instructions to install the Avaya 1200 Series IP Deskphone, including detailed figures and applicable warnings, are given in the Avaya IP Deskphones User Guides. The steps for installing the Avaya 1200 Series 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.
Install the IP Deskphone The following figure shows the connections on the IP Deskphone. Figure 11: IP Deskphone connections 98 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 9: Install the SIP software This chapter provides information on installing SIP software on a new 1200 Series IP Deskphone (1220 IP Deskphone and 1230 IP Deskphone). If the IP Deskphone already has SIP software installed, see Upgrade the SIP Software on the IP Deskphone on page 105. If the IP Deskphone has UNIStim software installed, see Convert UNIStim software to SIP software on the IP Deskphone on page 111. The 1200 Series IP Deskphones are shipped from the factory with only boot loader software.
Install the SIP software The following is an example of a 12xxBoot.cfg file for TFTP protocol. [FW] DOWNLOAD_MODE AUTO VERSION SIP12x004.04.09.00 FILENAME SIP12x004.04.09.00.bin PROTOCOL TFTP SERVER_IP 192.168.1.123 Downloading the 12xxBoot.cfg file There are two methods to download the 12xxBoot.cfg file to the IP Deskphone: • Automatic TFTP/FTP/HTTP 12xxBoot.cfg download on Bootup using DHCP. • Manual TFTP/FTP/HTTP 12xxBoot.cfg download. Related topics: Automatic TFTP/FTP/HTTP 12xxBoot.
Downloading the 12xxBoot.cfg file http://192.168.33.50 tftp://192.168.33.50 tftp://some.server.com ftp://my_login:my_psw@test.server.org 12xxBoot.cfg file download Assemble the components of the new IP Deskphone, as described in Install the IP Deskphone on page 97 or in the user guide of the appropriate IP Deskphone model. Plug in the IP Deskphone. The IP Deskphone retrieves its IP address and provisioning information from DHCP. The IP Deskphone reboots and then attempts to read the 12xxBoot.
Install the SIP software In a few seconds, the following simple non-graphic text menu on white background is displayed. 12x0 IP Phone Manual Configuration Avaya 3. Press the soft keys (1,2,3,4) in sequence from left to right. BootC goes to manual configuration and the following menu is displayed on the IP Deskphone screen. The End of Menu Apply Auto Cancel Note: If you miss this screen and the IP Deskphone begins to look for DHCP, unplug the IP Deskphone, and repeat Step 2. 4. Press the Auto soft key.
Downloading the 12xxBoot.cfg file • DEF GW := < IP Deskphone default gateway>, and then press the OK soft key. 9. Use the down arrow in the Navigation keys to scroll down and select 12. Provisioning Server. 12 Provisioning Server Man Cfg AllMan Cancel 10. Press the Man soft key to indicate a manual entry for the TFTP provisioning server, then press the Cfg soft key. 11. Press the OK soft key until Prov:0.0.0.0 is displayed. 12. Enter the IP address of the TFTP provisioning server where the 12xxBoot.
Install the SIP software 104 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 10: Upgrade and convert the IP Deskphone software Introduction This chapter describes how to upgrade an Avaya 1200 Series 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 (062AC5L ).
Upgrade and convert the IP Deskphone software 5. Press the gray arrow at the end of the Knowledge and Solution Engine box to obtain the . 6. From Search Results, select the appropriate version of the SIP software for the IP Deskphone; for example; SIP IP Phone 11230 Release SIP12x004.01.03.00.bin. 7. Place the selected software on the provisioning server. Modify the SIP provisioning file Use the following procedure to modify the SIP provisioning file, which exists on the provisioning server.
Upgrade to the minimum UNIStim Software SIP. To successfully convert the software from UNIStim to SIP, the UNIStim software version on your IP Deskphone must be 062AC5L or higher. Identify the current version of UNIStim software For a new Avaya 1200 Series IP Deskphone, follow Identify the current version of UNIStim software to determine the version number of the UNIStim software on an IP Deskphone.
Upgrade and convert the IP Deskphone software To make a selection, press the number associated with the menu item, or use the Navigation key cluster to scroll through the menu items. Press the Select key to select the highlighted menu item.
Upgrade to the minimum UNIStim Software 1. UFTP download initiated by the server if the server supports this method of upgrading UNIStim software. Refer to the appropriate documentation for your Call Server for instructions on using this method. 2. TFTP download on bootup. If necessary, use the following procedure to configure the TFTP server. Configuring the TFTP server 1.
Upgrade and convert the IP Deskphone software This can be the provisioning server as defined in the chapter Configure the provisioning server on page 39. 5. Select the Apply&Reset 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.
Convert UNIStim software to SIP software on the IP Deskphone This can be the provisioning server as defined in the chapter Configure the provisioning server on page 39. 6. Select the Apply&Reset context-sensitive soft key to save the settings 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.
Upgrade and convert the IP Deskphone software 3. Enter IP Deskphone type in the Knowledge and Solution Engine box. 4. Select SOFTWARE in the ALL TYPES scroll-down menu. 5. Press the gray arrow at the end of the Knowledge and Solution Engine box to obtain the Search Results. 6. From the Search Results, select the appropriate version of the SIP software for the IP Deskphone; for example, IP Phone 1230 Release SIP12x004.01.03.00.bin. 7. Place the selected software on the provisioning server.
Convert UNIStim software to SIP software on the IP Deskphone 3. After the new SIP software writing is finished, the blue LED stops flashing and the IP Deskphone displays [FW] Finished.... and then reboots. 4. The first time the SIP software boots, the SIP software performs a Flash File System conversion that takes 2.5 minutes.
Upgrade and convert the IP Deskphone software 114 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 11: Voice Quality Monitoring Feature overview Proactive Voice Quality Monitoring (PVQMon or VQMon) allows an Avaya 1200 Series IP Deskphone with SIP Software to report voice quality statistics to a server in the network. The IP Deskphone with SIP Software collects various voice quality statistics, for example, packet loss, and sends the voice quality statistics to the server at regular intervals during a call.
Voice Quality Monitoring 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.
End of call report Metric Description Listening R-factor Voice quality metric based on burst packet loss, transmission delay and burst loss. MIU Media Information Unit. MIU is a concept from VQMon. An MIU can be any size down to a 10 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.
Voice Quality Monitoring Alert interval report When the IP Deskphone detects that a voice quality metric has exceeded a threshold, the IP Deskphone initiates a timer which sends a message to the server every 5 seconds. When all voice quality metrics fall below the threshold values, the IP Deskphone stops sending VQMON Publish messages with the report. The alert interval report does not differ from the session interval reports or end-of-call reports.
Chapter 12: Device Settings on the IP Deskphone with SIP Software Important: An Avaya 1200 Series IP Deskphone with SIP Software displays different menus than an IP Deskphone with UNIStim software. Introduction This chapter describes how to configure the Device Settings parameters on the IP Deskphone with SIP Software. This includes items such as the IP address, the subnet mask, and the gateway IP address of the IP Deskphone.
Device Settings on the IP Deskphone with SIP Software • Voice VLAN: No VLAN, Manual • VLAN Filter • Ctrl Priority bits: Auto, 0–7 • Media Priority bits: Auto, 0–7 • Disable PC Port • PC Port Speed: Auto, 10BT, 100BT • PC Port Duplex: Auto, Force Full, Force Half • Disable Data 802.
Authorization The RADIUS server is the authentication server and performs the actual authentication of the supplicant. The following EAP methods are supported: • EAP-MDS on page 256 • EAP-TLS on page 257 • EAP-PEAP on page 257 The following options are available for the administrator: • When EAP-MD5 is selected, the administrator is prompted to enter ID1 and Password • When EAP-PEAP is selected, the administrator is prompted to enter ID1, ID2, and Password.
Device Settings on the IP Deskphone with SIP Software Password The Password is for use with the 802.1x (EAP) protocol. If the 802.1x (EAP) is not used, there is no prompt to enter the Password. 802.1ab Link Layer Discovery Protocol 802.1ab Link Layer Discovery Protocol (LLDP) is a standard for discovering the physical topology between neighboring devices. 802.
TLVs 1. Chassis ID 2. Port ID 3. Time To Live 4. End of LLDPPDU 5. Port Description 6. System Description 7. System Capabilities 8. Port VLAN ID 9. Port And Protocol VLAN ID 10. VLAN Name 11. Protocol Identity 12. MAC/PHY Configuration Status 13. Power Via MDI 14. Link Aggregation 15. Maximum Frame Size 16. LLDP-MED Capabilities 17. Network Policy 18. Extended Power-via MDI 19. Inventory Software Revision 20. Inventory Manufacturer Name 21.
Device Settings on the IP Deskphone with SIP Software 9. Network Policy 10.
TLVs TLV Fields Protocol identity = 0x888E—(802.1x Ethertype) 0x01—(Version field from 802.1x frame) 3. LLDP: Length = 2 Protocol identity = 0x88CC—(LLDP Ethertype) MAC/PHY Configuration/Status Auto-negotiation support/status = Bit 0 = 1 [Auto-negotiation supported] Bit 1 = 1 or 0, depending on the current auto-negotiation status, for example, either enabled or disabled.
Device Settings on the IP Deskphone with SIP Software TLV Fields Unknown Policy Flag (U)—1 only if the policy is unknown Tagged Flag (T)—configure accordingly Reserved (X)-0 VLAN ID—configure accordingly L2 Priority—configure accordingly DSCP Value—configure accordingly Location Identification Discovery Coordinate-based LCI–16 bytes Civic Address LCI I–variable length This format can have more than one address element and one address element can range from a minimum of 7 to 256 bytes.
NO DHCP mode 1. No DHCP (Manual configuration): All the Device Settings parameters are configured manually on the IP Deskphone with SIP Software. 2. Yes: The IP Deskphone with SIP Software is configured to get a standard set of Device Settings parameters from the DHCP server. NO DHCP mode No DHCP mode is also known as Manual Device Settings. In this mode, the IP Deskphone does not need a DHCP server because no DHCP requests are sent during startup.
Device Settings on the IP Deskphone with SIP Software Gateway Enter an IP address of the local gateway in the Gateway field. DNS IP1 and DNS IP2 Configure the Domain Name Servers (DNS) IP addresses DNS IP1 and DNS IP2. Ntwk Port Speed There are three options to provision the network port speed. • Auto – Link speed is auto negotiated with the network device and attached PC. • 10BT – Link speed is available for up to 10 Megabit Full Duplex on the network and the PC port.
Disable Voice 802.1Q Disable Voice 802.1Q If 802.1Q is disabled, standard Ethernet frames are transmitted. If 802.1Q is enabled, all frames transmitted by the Ethernet driver have the 802.1Q tag bytes inserted between the source MAC address and the protocol type field. Voice VLAN Configure the Voice VLAN. Table 15: Telephony Port (incoming) Voice VLAN Setting Result No VLAN (default setting) All telephony traffic that is transmitted on the telephony port is forwarded untagged.
Device Settings on the IP Deskphone with SIP Software VLAN Filter Setting Result the IP Deskphone validates the VLAN suggested by DHCP. Disabled The VLAN filter is disabled by default. If the VLAN filter is disabled, traffic is forwarded to the IP Deskphone port based only on a review of the MAC address of the packet. The IP Deskphone accepts traffic addressed to the MAC address of the IP Deskphone as well as any broadcast or multicast packets from any VLAN. Ctrl Priority bits 802.
Data Priority bits Table 17: PC Port (incoming traffic from PC) Data VLAN Result No VLAN All traffic received on the PC port is forwarded based on the MAC address. The packets are not modified in any way. Manual (value from 1 to 4094) All untagged packets received from the PC have an 802.1q header appended and the VLAN ID is configured to the value that is manually provisioned in this field. Any packet arriving on the PC port that is already tagged with matching VLAN ID is forwarded as is.
Device Settings on the IP Deskphone with SIP Software When enabled, all outgoing traffic to the PC has the VLAN tag removed. When disabled, packets are sent to the PC as is if Data VLAN is configured as No or if Data VLAN is enabled and the VLAN tag matched. Packets with different VLAN ID are discarded. Cached IP Leave unchecked to conform to the DHCP standard and to obtain an IP address from the DHCP server.
Provisioning Provisioning The next four menu items apply to configuring the provisioning parameters. Server URL Enter the numeric IP address, name, or URL of the provisioning server in the Server URL box. Protocol Select the protocol used to access the provisioning server, either TFTP, FTP, or HTTP. Device ID Enter the Device ID (User ID) used by the provisioning server for authentication of the IP Deskphone with SIP Software.
Device Settings on the IP Deskphone with SIP Software If the value for NAT traversal is set to None, the value of SIP_PING, if specified by the device configuration file for NAT_SIGNALLING, is used instead. NAT_SIGNALLING is required for networks that use STUN or SIP_PING for NAT traversal. NAT Media The IP Deskphone with SIP Software supports STUN for media path the NAT traversal. The NAT Media feature can be disabled by setting the NAT_Media field in Device Settings menu to NONE.
Configure the device settings 3. Diagnostics 4. Lock 2. To navigate in the Network menu, use the Navigation key cluster: Table 20: Using the Navigation key cluster to navigate in the Network 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 Menu items can also be accessed through the IP Deskphone keypad.
Device Settings on the IP Deskphone with SIP Software Press the Return context-sensitive soft key to exit the Device Settings menu without saving any changes. 6. Navigate to the first item in the Device Settings menu to configure EAP. Table 22: EAP configuration Enable 802.1x (EAP): □ Device ID: Password: A check mark appears in the check box if the item is active. 7. If the Enable 802.1x (EAP) check box is checked, fill in the Device ID and the Password. 8. Configure 802.
Configure the device settings 11. If DHCP is disabled, configure Net Mask and Gateway. Enter a subnet mask in the Net Mask field and enter the IP address of the local gateway in the Gateway field. Table 26: Net Mask and Gateway configuration Net Mask : 0.0.0.0 Gateway : 0.0.0.0 12. If DHCP is not Full DHCP, to configure the DNS enter the IP address of the local DNS servers DNS IP1 and DNS IP2. Table 27: DNS configuration DNS IP1 : 0.0.0.0 DNS IP2 : 0.0.0.0 13.
Device Settings on the IP Deskphone with SIP Software Auto Force Full Force Half 15. Disable Voice 802.1Q . Press the Select key to disable Voice 802.1Q. A check mark in the Disable Voice 802.1Q box indicates that Voice 802.1Q is disabled. Table 30: Voice 802.1Q configuration Disable Voice 802.1Q: □ 16. Configure Voice VLAN. Use the right arrow in the Navigation key cluster to highlight the Voice VLAN box. Press the Select key to access a list of Voice VLAN mode choices.
Configure the device settings Scroll through the list with the Up/Down arrows and select the appropriate parameter. Press the Select key to select the parameter. Table 33: Media Priority bits configuration Media Priority bits : Auto ▼ Auto Value from 0 to 7 20. Disable PC Port configuration. Press the Select key to turn off the PC port on the IP Deskphone. A check mark in the Disable PC Port box indicates the PC port is disabled.
Device Settings on the IP Deskphone with SIP Software • Force Half Scroll through the list with the Up/Down arrows and select the appropriate parameter. Press the Select key to select PC Port Duplex. Table 36: PC Port Duplex configuration PC Port Duplex : Auto ▼ Auto Force Full Force Half 23. Disable Data 802.1Q . Press the Select key to disable Data 802.1Q. A check mark in the Disable Data 802.1Q box indicates that Data 802.1Q is disabled. Table 37: Data 802.1Q configuration Disable Data 802.
Configure the device settings Table 39: Data Priority bits configuration Data Priority bits : Auto ▼ Auto Value from 0 to 7 26. Configure PC-Port Untag-All, which configures PC-Port VLAN Tag Stripping. Check the check box by pressing the Select key in the Navigation key cluster to enable this item. If the check box is not checked, tag stripping is disabled and the packet is sent to the PC port unmodified. If the check box is checked, tag stripping is enabled and the 802.
Device Settings on the IP Deskphone with SIP Software 29. Enter Provisioning Parameters: Server URL, Protocol, Device ID, and Password. The next four tables show menu items in the Device Settings menu that apply to configuring the Provisioning parameters. • Server URL: Enter the URL of the provisioning server in the Provisioning Server URL box. Provisioning Server URL: 0.0.0.0 • Protocol: Select either TFTP, FTP, or HTTP used for provisioning in the Protocol box.
Configure the device settings If this server is available on the network, enter the PVQMon IP address. Table 46: PVQMon IP configuration PVQMon IP : 0. 0. 0. 0 31. Configure the NAT Traversal Method. Use one of the following methods to traverse Network Address Translation (NAT) devices for the IP Deskphone with SIP Software. The next five tables show menu items in the Device Settings menu that apply to configuring the NAT Traversal Method.
Device Settings on the IP Deskphone with SIP Software • STUN S2 IP: Enter an IP address for the STUN S2 IP device. Table 51: STUN S2 IP configuration STUN S2 IP : 144 00. 00. 00. 00 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 13: 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.
Multiple Appearance Directory Number Figure 12: 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.
Communication Server 2000 and Communication Server 2100 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.
Multiple Appearance Directory Number Privacy A user can activate the privacy service by putting the current session on hold and dialing the privacy code. The CS 2000 connects the IP Deskphone to the Avaya Media Server (MS) to hear a confirmation for its request and terminates the session. The user takes the original session off hold. Privacy access codes The privacy access codes are: PRV, PRLA, PRLC.
Chapter 14: Multiuser The Multiuser feature allows multiple SIP user accounts to be in use on the IP Deskphone at the same time. Multiple users, each with their own account, can share a single IP Deskphone allowing each user to receive calls without logging off other users. One user can have multiple user accounts (for example, a work account and a personal account) active at the same time on the same IP Deskphone.
Multiuser Navigation • Configuration on page 150 • Initial logon on page 151 • Additional logons on page 152 • Automatic logon on page 152 • Logging off on page 153 • Primary account logout on page 153 • Secondary account logout on page 154 • Server failover on page 154 • Cable unplugged on page 154 • Line keys on page 155 • Making a call on page 156 • Receiving a call on page 156 • Being in a call on page 157 • Instant messages on page 158 • Menu features on page 158 • Modifying settings on page 158 • Pro
Initial logon prompt that requires you to enter an Authentication ID that is different from the Login ID. For example, CS 1000 requires an Authentication ID to find a corresponding TN and a Login ID to find a key; enabling PROMPT_AUTHNAME_ENABLE creates a prompt for the authentication ID. When you configure Multiuser, consider the following parameters: • MAX_LOGINS represents the number of user accounts that can log on at the same time. Configure MAX_LOGINS to any value greater than one; the default is 24.
Multiuser (one set for each user). If you exceed the limit of 24 sets of configurations, the IP Deskphone automatically deletes the least recently-used set, and a new account is registered. Additional logons The Login command in the System menu allows you to register additional accounts. If you log on as a secondary user, you cannot change the language selection. The following figure shows the secondary logon screens.
Logging off the IP Deskphone is switched off, the IP Deskphone automatically logs all users back on when you restart the IP Deskphone. • AUTOLOGIN_ENABLE USE_AUTOLOGIN_ID: You do not enter user credentials; the system administrator pre-configures the IP Deskophone using an IP Deskphone-specific file. The following example shows a SIP provisioning file: [USER_CONFIG] DOWNLOAD_MODE FORCED VERSION 000001 PROMPT NO IP Deskphone-specific configuration file AUTOLOGIN_ID_KEY01 8010@avaya.
Multiuser If you restart the IP Deskphone after you logged off the primary account, the logon screen appears on the IP Deskphone. Logging on a new primary account leads to automatic logon of the secondary accounts. The list of programmed feature keys is part of the IP Deskphone profile. Logging off one primary account and logging on a different account can change the set of feature keys.
Line keys the cable is reconnected, the IP Deskphone proceeds to reregister all accounts, starting with the primary account. Line keys Each registered user is associated to a separate line key. Each line key displays the name of the registered account and some basic state information for the account. The primary account is associated to the first bottom-right line key of the IP Deskphone.
Multiuser The icon for each line key reflects the state of the account associated with that line key. • If there is a call for the account, a IP Deskphone icon displays the state of the call, such as when the call is on hold or is ringing. • If there is more than one call, the state of the most active call is displayed. • Missed incoming calls and new voice mail messages for the account are indicated with an icon.
Being in a call Being in a call When a single call is active, the screen displays the local account in use and the remote user. If multiple calls are active, each call appears on a single line. The local account for the active call appears on the context line. Each line key reflects the most active call state of the account the line key is associated with. The active call is affected by operations such as transfer or call parking.
Multiuser Figure 19: 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. Menu features The menus displayed on the IP Deskphone are customized to match the service package of the active account that is accessing the menu.
Remembering settings after logout 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 with the account, and replaces the discarded set with the new set that is saved in the account profile. Programmable keys You cannot use a line key associated with a registered account for programmable features. The Program Key screen lists all the line keys associated to an account. If you select a line key associated to an account, an error message appears.
Address Books Figure 20: Example of the Inbox call details Call logs and IM logs provide many ways of initiating a call to the address identified by the selected entry, such as lifting the handset. In most cases, the primary account is used. However, if you press a line key to initiate the call, the call uses the account associated with the line key.
Multiuser The local address book is shared by all accounts that do not have a network-based address book. You can modify the local address book if the primary account does not have a networkbased address book. Changes to the network-based address book of the primary account are not reflected in the local address book. If you use the Friends view, you can always access and modify the address book of the primary account (local or network-based). There is no selection mode for the Friends view.
User status the IP Deskphone behaves as described in the preceding scenarios, except that there is no confirmation prompt displayed. The IP Deskphone performs the operation immediately, and a message appears to indicate what was done. The DND mode for each account is persistent. If you restart the IP Deskphone, or log off the account and log the account back on, the account maintains the original state.
Multiuser If you do not perform any Call forwarding or DND operations, you can press the single and all keys to switch one or all accounts between forwarding to key's target and not forwarding states. The Call Forward mode and target is persistent for each account. If you restart the IP Deskphone, or log off the account and log the account back on, the account maintains the original state.
Notifications 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. This includes events such as failure to retrieve a service package and availability of a new location list. These spontaneous notifications do not indicate which account is affected by the event. A message appears to indicate the affected account.
Multiuser 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.
Chapter 15: Features This chapter contains the following topics: • Customizable banner for login on page 167 • Speed Dial List on page 169 • Busy Lamp Field on page 174 • Roaming profiles on page 176 • SIP Domain DNS Lookup feature on page 184 • Server Profiles on page 185 Customizable banner for login SIP Software allows the IP Deskphone to display a customizable banner when you log on to the IP Deskphone.
Features The following table describes the function of the context-sensitive soft key for the Login Banner screen. Table 52: Context-sensitive soft key for the Login Banner screen Context-sensitive soft key Ok Action 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 53: Navigation Key Action Up and down arrows Allows you to scroll up and down the banner text.
Speed Dial List Key or action Result 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. Incoming call Incoming calls get a Do Not Disturb (DND) response while the banner is displayed.
Features The contents of the Speed Dial List can vary (context-sensitive) based on the current call state of the IP Deskphone and the type of Speed Dial List entry configured. Only entries in the Speed Dial List can be context-sensitive; not all speed dial keys or individual features keys are contextsensitive.
Speed Dial List Figure 23: Main feature key programming screen showing Speed Dial List provisioned on key 6 A feature key provisioned for use as a Speed Dial List has a similar appearance to all other programmed feature keys on the idle screen (or in-call screen). The label used for that key is provided through provisioning.
Features The following table describes the function of the context-sensitive soft keys for the Speed Dial List screen. Table 55: Context-sensitive soft keys for the Speed Dial List screen Context-sensitive soft key Action Dial Invokes the selected speed dial. Exit The screen is dismissed without invoking a Speed Dial List entry.
Speed Dial List If the auto retrieve behavior is enabled on a Speed Dial key (programmed keys) or Speed Dial List entry that is invoked, and a call is placed on hold to invoke the current key or entry, the IP Deskphone attempts to remove the call on hold after the key or entry call is complete. The following is a description of how the auto retrieve function operates. 1. A is talking to B when A invokes the Speed Dial List and selects an entry. 2.
Features Busy Lamp Field The Busy Lamp Field (BLF) is an alternate presence-monitoring mechanism for the IP Deskphone that allows presence functionality on proxies that support BLF. BLF is an icon state for a corresponding Speed Dial key on an IP phone; the icon state tells you if another extension connected to the same SIP server is busy. If configured, the IP Deskphone subscribes to a resource list available on the server and receives information about other extensions.
Busy Lamp Field Figure 26: Call states and corresponding Presence icons Resource List URI The SIP-specific event notification mechanism allows the subscriber to request to be notified of changes in the state of a particular resource. Users often subscribe to multiple resources; without an 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).
Features MAX_APPEARANCE. If initial value of the MAX_BLFCALLS parameter is greater than the value of MAX_APPEARANCE, the value of the MAX_BLFCALLS parameter is forcibly reduced. BLF Call Pickup is only supported for IP Office. Therefore, IP_OFFICE_ENABLE must equal YES for Call Pickup to work. Configuration flags for Busy Lamp Field The provisioning must provide a configuration flag, containing relevant URI, to the IP Deskphone in order to use the Busy Lamp Field (BLF).
Roaming profiles .cfg, where is the address of the primary user; for example lpg@macadamian.com.cfg. The USER_FILE_ENABLE device configuration file parameter is used to determine whether to download the user.cfg file on user login and to check for updates. Filemames to be downloaded are specified in a [files] section. An example of the syntax is provided below: [files] addressbook=abook.txt customkeys=keys.txt speeddiallist=sdl.
Features • index — index of the physical key on which the feature is made available. This uses the same numbering as on the IP Deskphone user interface (right hand keys, then left hand keys, then Expansion Module keys). • label — the text which appears next to the key on the IP Deskphone screen. • type — the feature programmed on the key.
Roaming profiles Section name Key Value example [audiocodecs] Description The priority-ordered list of codecs str-0 PCMU str-1 G729 str-0 3007@mycompan y.com The key consists of prefix “str“ and the sequence number 0,1… The value can be any supported codec. [autoanswer] [key] The list of allowed addresses from whom auto-answer requests should be accepted. Contains special section(s) for describing configuration for the programmable keys. icon 5 Icon number; codes are defined in the “Tab.
Features Section name Key Value example autoClearMissed Calls 0 backgroundImage 180 Description Determines if entering the inbox (without selecting each missed call) clears the "xx new calls” message Filename of image to use for the background (can be blank) backlightTimeout 60 Time to wait before dimming screen, in minutes banner Avaya Text to show on idle screen (can be blank) dateFmt 2 Display format for dates 2 –m/d/y, 3 – d/m/y timeFmt 0 Display format for time 0 – 12hrs (5:45pm), 1
Roaming profiles Section name Key Value example Description 0 = none publicScaHold 0 Specifies whether others can retrieve calls a user pus on hold Value = 0 or 1 screensvrActive 0 Specifies if screensaver is activated immediately on auto login Value = 0 or 1 screensvrDelay 10 Time to wait before displaying the screensaver, in minutes screensvrImage Filename of image to use for the screensaver (can be blank) screensvrMode 0 0=ssmDISABLE 1=ssmENABLE_NO_PASS 2=ssmENABLE_PASS screensvrText
Features 1. In non-IP Office mode, any keys defined as “feature” have no effect and are ignored. 2. If the “type” field is omitted, the key is considered as the “spdial” key by default. 3. If the [type] field has the incorrect paramete,r the [key] section is considered to be incorrect and is ignored (appropriate ECR record is registered in the ECR file).
Roaming profiles 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. The SDL key itself is provisioned using the device configuration file, not the custom keys file. The Speed Dial List file format is similar to Custom keys file format, except for the following: • Only keys of type spdial are supported; the "type=" attribute can be omitted. • The index attribute is ignored.
Features Default names Default names can also be provisioned in the Device Configuration file if per-user files are not required. Default names are overridden by names specified in the user.cfg file. • DEFAULT_ADDRESSBOOK_FILE • DEFAUT_SPEEDDIAL_LIST • DEFAUT_CUSTOMKEYS_FILE For more information about the Device Configuration file, see Feature configuration commands on page 55.
Server Profiles hostname is returned instead of the IP address. The hostname must point to an address record (A or AAAA record). SRV record example: _sip._tcp.example.com. 86400 IN SRV 0 5 5060 sipserver.example.com where: • sip = the desired service • tcp = the transport protocol • example.com = the configured domain name • 5060 = the port to be used • sipserver.example.
Features Table 58: Parameters not included in Server Profile configuration file SIP_DOMAIN1 SERVER_TCP_PORT2_2 CONFERENCE_URI1 SIP_DOMAIN2 SERVER_TLS_PORT2_2 ADHOC_ENABLED1 SIP_DOMAIN3 SERVER_PORT3_1 MAX_ADHOC_PORTS1 SIP_DOMAIN4 SERVER_TCP_PORT3_1 CONFERENCE_URI2 SIP_DOMAIN5 SERVER_TLS_PORT3_1 ADHOC_ENABLED2 SERVER_IP1_1 SERVER_PORT3_2 MAX_ADHOC_PORTS2 SERVER_IP1_2 SERVER_TCP_PORT3_2 CONFERENCE_URI3 SERVER_IP2_1 SERVER_TLS_PORT3_2 ADHOC_ENABLED3 SERVER_IP2_2 SERVER_PORT4_1 MAX_ADH
Server Profiles • 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 SFTP_READ_PATTERNS SESSION_TIMER_DEFAUL ENABLE_BT T_SE MLPP_NETWORK_DOMAI N SESSION_TIMER_MIN_SE PCPORT_ENABLE MLPP_PRECEDENCE_DO MAIN 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_PRE SENCE Managing Server Profile files To download a new Server Profile file, the Server Profile parameters must first be configured in the System
Chapter 16: Hotline service The Hotline service allows you to provision a SIP IP Deskphone to a Hotline Phone. From a Hotline Phone, you can automatically make a call to a designated number. A Hotline Phone is a dedicated IP Deskphone that has only one target. You cannot make a call to any other destinations; even emergency calls, such as E911 are not permitted.
Hotline service • MLPP • E911 call The display of each feature that is restricted on the Hotline Phone is blocked. Provisioning Hotline Service configuration is obtained from the Hotline Service Enable parameter from the service package or the device configuration file. The service package takes precedence over the device configuration file. Service Package You can turn Hotline Service, on or off, through the Service Package or the device configuration file.
Device configuration file Parameter name Description Default The Proxy server replaces the To field of INVITE request message with a real Hotline target when it receives an INVITE request from the Hotline Phone.
Hotline service 192 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 17: Session Timer Service The Session Timer for the Session Initiation Protocol (SIP) feature (RFC4028) allows the Avaya 1200 Series IP Deskphone to support a keep-alive mechanism for SIP sessions. SIP sessions are periodically refreshed by UPDATE requests (or re-INVITES for the IP Deskphones that do not support UPDATE). The UPDATE requests are sent during an active call to allow endpoints or proxies to determine the status of a SIP session.
Session Timer Service Provisioning The IP Deskphone uses the configuration parameters for the Session Timer Service to indicate if the Session Timer Service is available, and to configure the duration of the session timer. The following table describes the five configuration parameters in the device configuration file for Session Timer Service.
Provisioning Parameter name Description Default value the refresher is configured to UAS; value 2 indicates that the refresher is configured to UAC.
Session Timer Service 196 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 18: Emergency Services Overview You can use the Avaya 1200 Series IP Deskphone to make an emergency call to the Public Safety Answering Point (PSAP), from any screen, without a user logon. When you connect to the PSAP, the IP Deskphone conveys the caller's location information to the PSAP. If you are not logged on to the IP Deskphone and you pick up the handset or press the handsfree or headset button, the message "Emergency calls only" appears on the screen of the IP Deskphone.
Emergency Services Location information Effective Emergency services also rely on accurate location information. The IP Deskphone supports the inclusion of the x-nt-location header in SIP messages that provide location information to a Avaya Call Server. The location information is selected by the user during registration, and must be correctly provisioned at the Call Server level (see appropriate NTP specific to your Call Server).
Dialing plan configuration Table 61: 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.
Emergency Services Feature impact on configuration tasks 1. Configuring the SIP Proxy • The IP Deskphone must have an emergency user in order to make an emergency call without a user logon. • The IP Deskphone must have the necessary configurations values for automatic REGISTER of the emergency user (if you choose this implementation method). • You must add the emergency user to the proxy. 2.
Network Element • You must configure the Layer 2 switch or DHCP server. Network Element Configure the domain list and proxy set up • You must properly configure the domain list, and the active proxy must be correct, valid, and support current features. • You must properly configure the proxy to support current features. • The proxy must be able to transmit mixed MIME-types (for successful transferring of the location information).
Emergency Services • cannot receive an incoming call. • cannot auto-retrieve a parked call and auto-retrieval of parked calls is not displayed. • cannot disconnect the emergency call in most cases. Only an emergency center or operator can disconnect the emergency call. If the user attempts to disconnect after the call has been made, the IP Deskphone switches to loudspeaker. If the loudspeaker mode is already on, the connection remains.
Chapter 19: IP Deskphone restrictions Service package restrictions 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. If the Call Server does not support service packages, or if the Call Server restricts some of the features in the service package, functionality of some features is restricted.
IP Deskphone restrictions 204 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 20: NAT firewall traversal The objective of putting devices behind a Network Address Translator (NAT) is to protect the devices from external interruption and to extend the public IP address space. However, the shield to stop unsolicited incoming traffic also has the drawback of breaking a number of IP applications, including SIP. If a device is behind a NAT, transport addresses obtained are not publicly routable, and therefore, not useful in a number of multimedia applications.
NAT firewall traversal 206 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 21: Three-port switch and VLAN functionality System overview The Full VLAN support feature can create an IP Deskphone Voice VLAN and PC Data VLAN on the three-port switch manually or automatically (see Figure 27: Voice-VLAN and Data VLAN on page 208). If both Data and Voice VLANs are enabled on a three-port switch, only the frames with Data and Voice VLAN tagged go to the networks.
Three-port switch and VLAN functionality Figure 27: Voice-VLAN and Data VLAN Table 62: Port functions on the three-port switch when VLAN is enabled Ports Network Port (Port 0) 208 Voice VLAN enabled N/A Data VLAN enabled N/A SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
System overview Ports Voice VLAN enabled Data VLAN enabled Both Voice and Data VLAN enabled IP Deskpho ne Port (SMP) Receiving the frames with Voice VLAN tagged only. Sending the frames with Voice VLAN tagged. N/A Receiving the frames with Voice VLAN tagged only. Sending the frames with Voice VLAN tagged. PC Port (Port 1) N/A Tagging the incoming frame untagged and forwarding it to the network port.
Three-port switch and VLAN functionality 210 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 22: SIP messages supported by the IP Deskphone SIP methods The table below provides a list of SIP messages supported by the Avaya 1200 Series IP Deskphone. Table 63: SIP methods Method Supported? Comments INVITE Yes Mid-call re-invites for media changes also supported.
SIP messages supported by the IP Deskphone Method Supported? Comments UPDATE operations fail as described in RFC3311. The support of UPDATE messages is not a configurable feature.
2xx Response—Successful responses 2xx Response—Successful responses 2xx Response Send Receive 200 OK Yes Yes 202 Accepted Yes Yes Comments 3xx Response—Redirection responses 3xx Response Send 300 Multiple Choices No 301 Moved permanently 302 Moved temporarily 305 Use Proxy No Yes Yes 380 Alternate service No Receive Comments Yes When receiving this response, the IP Deskphone redirects the original request to next contact specified.
SIP messages supported by the IP Deskphone 3xx Response Send Receive Comments address in the Contact header field. 4xx Response—Request failure responses 4xx Response 400 Bad request Yes Receive Comments Yes The IP Deskphone generates a 400 Bad Request response for various failure conditions generally when a request is invalid, and a more specific error response does not apply.
4xx Response—Request failure responses 4xx Response 407 Proxy authentication required Send Receive Comments No Yes See 401. 408 Request timeout No Yes See default handling. 410 Gone Yes See Default error handling on page 217. No 413 Request entity too large No Yes See Default error handling on page 217. The IP Deskphone does not automatically retry if a retry-after header is present. 414 Request---URL too long No Yes See Default error handling on page 217.
SIP messages supported by the IP Deskphone 4xx Response 485 Ambiguous Send No Receive Comments Yes See Default error handling on page 217. The IP Deskphone does not attempt to retry the request. 486 Busy Here Yes Yes The IP Deskphone can respond with this if the user is on the IP Deskphone, and the IP Deskphone has reached its maximum number of allowed calls and cannot present the incoming call to the user.
6xx Response—Global responses 5xx Response Send Receive 504 Gateway timeout No Yes 505 Version Not Supported Yes Yes Comments See Default error handling on page 217. 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.
SIP messages supported by the IP Deskphone SIP header fields The following table contains the supported SIP headers.
SIP header fields Header field Supported? P-Charging-Function-Addresses Yes P-Charging-Vector Yes P-Media-Authorization Yes P-Preferred-Identity Yes P-Visited-Network-ID Yes Path Yes Priority Yes Privacy Yes Proxy-Authenticate Yes Proxy-Require Yes RAck Yes Reason Yes Record-Route Yes Refer-To Yes 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
SIP messages supported by the IP Deskphone Header field Supported? Via Yes Warning Yes WWW-Authenticate Yes Session description protocol usage SDP Headers Supported? v--Protocol version Yes o--Owner or creator and session identifier Yes s--Session name Yes t--Time description Yes c--Connection information Yes m--Media name and transport address Yes a--Media attribute lines Yes SDP and Call Hold The IP Deskphone can support sending and receiving of hold using the method specified by
SIP security authentication SIP security authentication Authentication Supported? Digest Authentication Yes Proxy-to-User Authentication Yes User-to-User Authentication No S/MIME No AKA No Comments The IP Deskphone responds to a 401, but never challenges incoming requests with a 401 response. SIP DTMF Digit transport Transport type Supported? RFC2833 Yes In-band tones Yes Out-of-band tones Yes (vnd.avaya.
SIP messages supported by the IP Deskphone Subscription type Supported Avaya Call Server specific ua-profile Partial Yes service-package Yes Yes network-redirectionreminder Yes Yes Supported instant messaging Message type 222 Supported? plain text Yes Avaya unencrypted Yes Avaya encrypted Yes SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 23: Audio codecs Overview The optional audio codecs feature allows you to select the audio compression or decompression algorithm (codec) used on the Avaya 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 Avaya 1200 Series IP Deskphone. When the user selects an audio codec, that codec is used for both incoming and outgoing calls.
Audio codecs VQMON Codec configuration You can enable the VQMON feature through the Device Configuration file to send an SIP Publish message with the VQMON report as text content, and use this report for QoS monitoring. Network layer for the SDP negotiations The following table contains static payload types and other parameters for the supported codecs.
Codec preference through Device Configuration to enable or disable AnnexB support by G.729 and AnnexA support by G.723.1. You can add a text descriptor to the technical name of the audio codec; these descriptors appear on the user interface of the IP Deskphone. You can specify, by name, the exact codecs to offer in the Device Configuration file. This grants the administrator full control over the audio settings used for inbound and outbound calls.
Audio codecs For example: AUDIO_CODEC1 PCMA standard a-law AUDIO_CODEC2 PCMU standard u-law AUDIO_CODEC3 G729 729 codec AUDIO_CODEC4 G722 wideband codec AUDIO_CODEC5 G723 high-compression codec would become AUDIO_CODEC1 AUDIO_CODEC2 AUDIO_CODEC3 AUDIO_CODEC4 AUDIO_CODEC5 If the ordered list of codecs is small and no matching codec is found during negotiations, the call drops, as the audio stream cannot be established. For backward compatibility with SIP Firmware Release 1.
Codecs preferences on the IP Deskphone Preferences menu on the IP Deskphone. On subsequent Device Configuration updates, at start time, or during other updates, the ordered codec list of the user is synchronized with the list in the Device Configuration file. This synchronization makes both lists equal. If the user creates an order that is different from the one in the Device Configuration file, the IP Deskphone appends it to the end of the list.
Audio codecs file, then the codec is added to the list of the supported codecs. Otherwise, the codec is rejected. • The IP Deskphone adds the last codecs, presented in the Device Configuration file, to the list of supported codecs. 228 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 24: Certificate-based authentication Certificate-based authentication overview Certificate-based authentication allows the administrator to ensure that the IP Deskphone is authorized to access the enterprise LAN environment.
Certificate-based authentication The supplicant can be authenticated to an authentication server using one of these EAP methods: - EAP-MD5 - EAP-PEAP - EAP-TLS • Device certificate management The administrator can install a device certificate on the IP Deskphone by using SCEP or PKCS#12 import file. The IP Deskphone can verify the imported device certificate by checking the availability of the IP Deskphone against the Certificate Trust List (CTL) stored in the IP Deskphone.
Root certificate installation • Serial number of the certificate • Digital signature of the issuer Root certificate installation The customer root certificate is a self-signed certificate (a self-issued certificate where the subject and issue fields contain identical DNs, and are not empty).
Certificate-based authentication section can be assigned to one of the IP Deskphone supported protocols, such as HTTP, TFTP, HTTPS and FTP. • After the configuration file is downloaded and parsed by the IP Deskphone, the [USER_KEYS] section is processed and the root certificate is downloaded to the IP Deskphone. • After the certificate file is downloaded, you must authenticate the contents of the certificate file before installing it on the IP Deskphone. There are two possible situations.
Device certificate installation openssl smime –sign –in unsigned_file –signer sign_cert_file –outform PEM –binary –inkey sign_cert_pk_file –out tmp_signature_file The first customer root certificate must either be signed by a Avaya Trusted Certificate or Fingerprint accepted. To control further signing of a customer root certificate, and prevent security risks, the following Security Policy parameter must be configured.
Certificate-based authentication Device certificate profiles You can determine the method used to install a device certificate on the IP Deskphone. Each device certificate installed on the IP Deskphone is attached to a Device Certificate Profile (DCP). The configuration of the profiles allows you to determine the method used to install a device certificate and provides you with some control over the device certificate attributes.
Device certificate profiles Name Type Value(s) Default PKCS#12 Required Description with this index is not used (regardless of the Source value). Purpose Int Bit flags –1 (ALL) ✔ Covers all feature usages plus special cases for All(=–1). Delete Int 0 = No 1 = Yes 0 ✔ Used to force a device certificate to be deleted. Automatically resets to 0 after a certificate is deleted. CAServerNam String e AdminCA1 ✘ AdminCA1 is a default for backward compatibility with previous UNIStim versions.
Certificate-based authentication Name Type Value(s) Default PKCS#12 Required Description backward compatibility. CN String "" ✘ Common Name O String "" ✘ Organization OU String "" ✘ Organizational Unit S String "" ✘ Province/State C String "" ✘ Country Key Usage Int 0x00a0 ✘ For example: Digital Signature + Key Encipherment. Default is TLS compatible. Extended Key Usage Int 2 (clientAuth) ✘ For example: clientAuth. Default is TLS client compatible.
Device certificate profiles Name Type Value(s) Default PKCS#12 Required Description Content from current hostname and domain name configurations. With the exception of the version, all the DCP configurations described in the preceding table apply to SCEP-requested device certificates. The PKCS#12 column identifies the limited set of parameter that apply to a DCP configured for PKCS#12.
Certificate-based authentication parameters. The Hostname and Domain Name parameters are part of the overall IP Deskphone configuration and are not configurable within each DCP. - If AutoCN is configured as 1 (True), then the CN is constructed as Hostname@Domainname. - If AutoCN is configured as 0 (False), then the CN is configured as the value of the CN parameter in the DCP. • Purpose The Purpose attribute uses bit masks to identify what features a particular device certificate is used for.
SCEP The following is an example of the provisioning file, system.prv, that shows some of the device certificate profile attributes that are provisioned when SCEP is used to install a device certificate. Figure 28: Example of the provisioning file, system.prv SCEP Simple Certificate Enrollment Protocol (SCEP) is a process used to obtain a certificate. This process occurs between the IP Deskphone that requires a certificate and a trusted CA that is responsible for providing certificates.
Certificate-based authentication 1. After the IP Deskphone starts up, the IP Deskphone automatically generates a private-public key pair for each Device Certificate Profile configured on the IP Deskphone for SCEP. 2. The IP Deskphone uses the SCEP GetCACert command to retrieve a customer root certificate from the CA server and prompts the administrator to validate the certificate fingerprint before the IP Deskphone stores the root certificate permanently on the IP Deskphone. 3.
Device Certificate Authentication Considerations for SCEP certificate must be appropriate to the type of authentication that the server uses. The Subject Common Name (CN), the full Subject Distinguised Name (DN), or the Subject Alternate Name (SAN) is used to determine if the entity has the necessary permissions.
Certificate-based authentication PKCS 12 download PKCS#12 is an industry standard for importing and exporting keys and their related certificates. On the IP Deskphone, this method is only used to import the IP Deskphone device certificate and private key. The IP Deskphone can download a PKCS#12 file from the provisioning server. The provisioning configuration file (for example, 11xxe.cfg), contains the [DEV_CERT] section where the FILENAME attribute points to the PKCS#12 file name.
Certificate Trust Line (certificate verification) Configure the DCP for the specified index for a PKCS#12 downloaded certificate, otherwise the file is rejected. By default, profile 1 is configured for SCEP and all other profiles are configured for PKCS#12. 2. The IP Deskphone checks the version in the [DEV_CERT] section against the version stored in the specified PROFILE. If the version in the specified profile is missing or is older, the device certificate file is downloaded. The profile index is 1. 3.
Certificate-based authentication The IP Deskphone uses CTL to verify the various network elements such as proxy servers and provisioning servers. For the IP Deskphone to trust any network element, the certificate of the IP Deskphone must be added to the CTL. The use of CTL is optional. If CTL is not installed on the IP Deskphone, the authentication of the network element reverts back to the default which is to authenticate the certificate chain to a root certificate trusted by the IP Deskphone.
Validating a certificate using the Certificate Trust List 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. Important: Do not insert additional characters between the Certificate and the Digital Signature. Otherwise, the validation fails. Do not change any information from the original file content that was used to create the signature.
Certificate-based authentication Figure 31: Example of a CTL file Certificate Administration The administrator can view and delete certificates. Because a certificate can be deleted, it is critical that the administrator password to access this function is protected and limited only to those individuals who absolutely require it. Certificate administration is accessed through the Diagnostics menu .
Certificates Administration main menu Figure 32: Diagnostics main menu The following table describes the function of the Navigation keys for the Diagnostics menu. Table 72: 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. Digital keys (number associated with option) Invokes an appropriate option. * Selects the first option Server Settings, but does not activate it.
Certificate-based authentication To access the Certificates Administration screen, from the Diagnostics menu, select Certificates Administration. Figure 33: Certificates administration main menu The following table describes the function of the Context-sensitive soft keys for the Certificates Administration screen. Table 73: Context-sensitive soft keys for the Certificates Administration screen Context-sensitive soft key Action Select Selects the required option.
Trusted Certificates screen Table 74: Context-sensitive soft keys for the Trusted Certificates screen Context-sensitive soft key View Action 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 Device Certificates screen The Device Certificates screen displays a list of subject Common Name (CN) of device certificates as shown in the following figure: Figure 36: Device Certificates screen The following table describes the function of the Context-sensitive soft keys for the Device Certificates screen.
CRL screen Figure 37: Device Certificate details 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. CRL screen The CRL screen displays a list of CA issued CRLs stored in the IP Deskphone, as shown in the following figure: Figure 38: CRL screen The following table describes the function of the Context-sensitive soft keys for the CRL screen.
Certificate-based authentication Context-sensitive soft key Action • CRL Issuer • Issued date • List of serial numbers that belong to the CRL associated with the revocation date. Back Returns you to the previous screen. The following figure is an example of the CRL Details screen for the CRL Issuer www.ca1.com. Figure 39: CRL details If you delete a Trusted Anchor Certificate, the CRL issued by the anchor is also deleted.
CTL screen The following table describes the function of the Context-sensitive soft keys for the CTL screen. Table 78: Context-sensitive soft keys for the CTL screen Context-sensitive soft key View Action Displays information on the selected certificate which includes the following: • Common Name CN) • Serial Number (SN#) • Expiry Date • Certificate Status (such as, OK or Expired) • Delete Displays a warning confirmation. Deletes the CTL. Back Returns you to the previous screen.
Certificate-based authentication Figure 42: Example of command output Important: The CTL file size must not exceed 20 Kbytes. EAP Authentication EAP-enabled networks allow the administrator to ensure that individual devices or users are authorized to access the enterprise's LAN environment. The following diagram shows the network architecture for 802.1x and EAP. Figure 43: 802.1x and EAP network architecture IEEE 802.
EAP Authentication the authentication server and controls the access to the network based on the authentication status of the supplicant. • an authentication server—typically a RADIUS server; performs the actual authentication of the supplicant.
Certificate-based authentication Table 79: EAP Provisioning Parameters Parameter Purpose Default Allowed EAP EAP mode DISABLED DISABLED/MD5/ PEAP EAPID1 Device ID1 Empty String (4 to 20 characters) EAPID2 Device ID2 Empty String (4 to 20 characters) EAPPWD Password Empty String (4 to 12 characters) EAP Authentication failures are logged using event 1033. The following is an example of a TLS authentication failure 1033 [Minor][FRI MAY 15 13:48:06 2009][10223][n:/fw/build/..
EAP-TLS 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 SCEP or SIP configuration file.
Certificate-based authentication Provisioning configuration file download Securely download provisioning configuration files through HTTPS. Provisioning configuration files download through HTTPS The IP Deskphone can contact a provisioning server and download an 12xxSIP.cfg file to identify additional files and protocols used. When a file is identified, and the protocol specified in the "protocol" parameter is HTTPS, the IP Deskphone contacts the target server and negotiates a TLS connection.
Security and error logs 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 device certificate to validate the identify of the IP Deskphone. The IP Deskphone must be preloaded with the root certificate used in signing the server certificate.
Certificate-based authentication Figure 45: Logs main menu When the user selects a log file, the screen displays each log item on a full screen, as shown in the following figure: Figure 46: Log item screen The following table describes the function of the Context-sensitive soft keys for the log item screen. Table 80: Context-sensitive soft keys for the log item screen Context-sensitive soft key 260 Action Next Navigates to the next log entry. Prev Navigates to the previous log entry.
Security policy file updates Security policy file updates The security policy file contains a set of rules for certificate-based authentication on the IP Deskphone. The rules include the following: • CERT_ADMIN_UI_ENABLE Determines if the Certificate Administration user interface is enabled on the IP Deskphone. The acceptable values are YES and NO; the default value is NO. • SECURITY_LOG_UI_ENABLE Determines if the Security Log user interface is enabled on the IP Deskphone.
Certificate-based authentication • 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 the option to accept or reject • FP_ENTERED If the resource file is not signed and if there are no customer certificates, then you must manually enter the Finger Print value and then select Accept. • SUBJ_ALT_NAME_CHECK_ENABLE Checks the Subject Alternative Attribute in the presented certificate.
Certificate Admin option in the user interface DWNLD_CFG_ACCEPT = VAL_ACCEPT AUTO_PRV_SIGNING = NO DWNLD_CFG_SIGNING = NO CERT_ADMIN_UI_ENABLE = YES SECURITY_LOG_UI_ENABLE = YES KEY_SIZE = KEY_SIZE_1024 KEY_ALGORITHM = KEY_ALG_RSA TLS_CIPHER = RSA_WITH_AES_256_CBC_SHA SUBJ_ALT_NAME_CHECK_ENABLE = NO FTP_PASSWORD = **** Certificate Admin option in the user interface The following procedure provides the steps to view the Certificate Admin option in the user interface.
Certificate-based authentication Device Certificate Installation SCEP and PKCS#12 are two methods used to install device certificates. If SCEP is used to install device certificates, see SCEP on page 239 for more information. The following describes the process of using PKCS#12 to install device certificates. 1. The administrator adds a [DEV_CERT] section to 12xxSIP.cfg to let the IP Deskphone import a PKCS#12 file.
CTL download Figure 48: PKCS12 password prompt Important: The password can be empty, but the use of an empty password is not recommended except under very controlled conditions. 4. After the password is validated, the IP Deskphone extracts the private key and device certificate from the PKCS#12 file. 5. The IP Deskphone validates the device certificate to ensure that the device certificate is signed by a trusted CA, is not revoked, and that the key size meets the minimum requirement. 6.
Certificate-based authentication Upgrade and rollback tasks The IP Deskphone loaded with secure software cannot downgrade to a previous insecure framework. SIP configuration file (12xxSIP.cfg) PKCS12 Import The [DEV_CERT] section is added to 12xxSIP.cfg to let the IP Deskphone import a PKCS#12 file.
CTL download CTL download The [CTL] section is added to 12xxSIP.cfg to allow the IP Deskphone to download a CTL file from a provisioning server. The following is an example of the format for the [CTL] section: [CTL] DOWNLOAD_MODE AUTO PROTOCOL HTTPS FILENAME ctl.pem Customer root certificate download The [USER_KEYS] section is added to 12xxSIP.cfg to allow the IP Deskphone to download a customer root certificate from a provisioning server.
Certificate-based authentication EAP_MD5_AUTH_FAILURE 0x1030 EAP_INVALID_DEVICE_CERTIFICATE 0x1031 EAP_INVALID_ROOT_CERTIFICATE 0x1032 EAP_TLS_AUTH_FAILURE 0x1033 EAP_PEAP_AUTH_FAILURE 0x1034 The following is a list of certificate-related events and failures logged in the Security Log.
Fault management behavior SLC_AVAYA_CERTIFICATE_EXPIRED_AUTH 0x1002 SLC_SERVICE_PROVIDER_CERTIFICATE_EXPIRED_ AUTH 0x1003 SLC_PROVIDER_CERTIFICATE_IN_AVAYA_KEYS_FI LE 0x1004 SLC_PKI_MGMT_INIT_FAILURE 0x1005 The following is the Security Policy parameter change event. SECURITY_POLICY_PARAM_CHANGE 0x1055 Any changes made to the security policy file has an entry in the security log file. For more information, seeSecurity policy file updates on page 261.
Certificate-based authentication 270 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 25: Security This section specifies the behavior of the following security features: • SIP over TLS • Connection persistence • SRTP • SFTP • SSH 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 IP Deskphone and the SIP proxy. Transport Layer Security (TLS) protects SIP signaling traffic.
Security are tried periodically based on random, but increasing time periods, in order to give the server adequate time to recover. SSH and secure file transfer The Secure Shell Handler (SSH) is a widely-used protocol for providing secure logon access to run commands remotely. To establish a connection, you must access the SSH-capable client, and know the user name and password that is configured on the IP Deskphone through the use of the provisioning system.
TCP/TLS operation overview • 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. • The user must provide a valid user ID and password when the User ID field is empty, and an application (SSH or SFTP) is selected.
Security both communicating parties. Both the server and the end point device certificates are "signed" by well-known trusted certificate authorities. • Server authentication occurs when a server has a certificate signed by a certificate authority. The certificate is only used for the client to validate the identity of the server it is connected to. After the TLS connection is established, the server can identify the IP Deskphone through a user name and password.
TCP/TLS operation overview Important: The IP Deskphone must have a device certificate loaded. If the device certificate is not loaded, the IP Deskphone fails to establish a TLS connection with the system. IP Deskphone security configuration The following table lists the various security parameters for the IP Deskphone. Table 81: Provisioning parameters summary Parameter Purpose Default Allowed Configures the TCP TCP: 5060 and TLS ports used TLS: 5061 when connecting to the SIP domain.
Security Parameter 276 Purpose Default Allowed REGISTER_RETRY_TIME 30 Min: 30 Max: 1800 REGISTER_RETRY_MAX TIME 1800 Min: 600 Max: 1800 KEEPALIVE_RETRIES 3 Min: 0 Max: 10 See Managing connection persistence on page 283. No BE-2MLines BE-2MLines BE-Cap Neg SecureOnly SRTP_ENABLED SRTP_MODE SRTP configuration values. SRTP_CIPHER_1 SRTP_CIPHER_2 Allows configuration of AES_CM_128 the preferred order for _HMAC_SHA SRTP cipher offers.
TCP/TLS operation overview Parameter Purpose Default Allowed parameter, the system resets. SFTP_WRITE_PATTERNS File extensions allowed to write (put) from IP Deskphone. .cfg,.dat "," separated values. See Note 1 and Note 2. 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.
Security Parameter Purpose Default Allowed and Port on the audio quality details screen. ADMIN_PASSWORD_EXP IRY Empty The date that the configured ADMIN_PWD is no longer valid, and a new password must be downloaded from the provisioning server. Timestamp Note: 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,.
TCP/TLS operation overview Manually configure the IP Deskphone for UDP and TCP After you enable the administration user interface, you can manually change network settings on the IP Deskphone. You can manually configure the IP Deskphone through the Server Settings menu. Note: To meet security requirements, the local administration user interface of the IP Deskphone can be disabled for deployed IP Deskphones.
Security Parameter name Description Default value incoming TLS requests. Boundaries Disabled: 0 (must be non-zero for a TLSonly option) Note: The configuration of the IP Deskphone for various protocols must be completed for outgoing and incoming connections. For a complete TLS-only option, the outgoing server UDP and TCP protocols must be configured as a non-zero value, and the incoming UDP and TCP listening ports must be configured as a non-zero value.
TCP/TLS operation overview Configuration Result Idle Screen Security Icon Display Default: UDP + TCP SIP is unsecured. No UDP only SIP is unsecured. No TCP only SIP is unsecured. No TLS only Connection is only established if SIP is secure. Yes UDP + TLS: unsupported Unsupported. Unsupported TCP + TLS Connection is established with either TCP or TLS.
Security Configuration Description Expected result Possible results configured period of time before attempting to reconnect. The IP Deskphone IP Deskphone: UDP Server: UDP + only has UDP TCP + TLS enabled for sending requests to the server. The IP Deskphone registers using UDP as the protocol. If the IP Deskphone is unable to contact the server, it waits a configured period of time before attempting to reconnect.
TCP/TLS operation overview Configuration Description Expected result Possible results of time before attempting to reconnect. IP Deskphone: UDP + TCP + TLS Server: UDP + TCP + TLS The IP Deskphone attempts to contact the server using TLS first, because TLS has higher priority than TCP and UDP. The IP Deskphone registers the same as if it was configured for TLS only. If the IP Deskphone is unable to connect to the server using TLS, it attempts to connect using TCP.
Security Figure 51: Incoming/Outgoing with connection reuse When using UDP, an IP Deskphone behind a firewall must periodically send a request to the server to maintain an open pinhole in the firewall so that the server can contact the IP Deskphone when sending requests. When using TCP/TLS and connection persistence, it is not necessary to send a SIP_PING to the server in order to keep a pinhole alive, and the keep-alive mechanism is reduced to a method which involves significantly less overhead.
SRTP Parameter name Description Default value Boundaries Keep-alive 30 This is a value, measured in seconds, that the IP Deskphone uses when a connection to the server is established using TCP or TLS. The IP Deskphone periodically sends a packet to the server, which contains a pair of CRLF, to ensure the server is responding. Min: 5 Max: 1800 Register Retry When a connection failure 30 occurs, this value in seconds is how long the IP Deskphone waits before attempting to reregister with the proxy.
Security The following table highlights the two cipher suites that are used and their related parameters. Table 85: SRTP properties Parameter AES_CM_128_HMA C_SHA1_80 AES_CM_128_HMAC_SHA1_32 Master key length 128 bits 128 bits Master salt length 112 bits 112 bits SRTP lifetime 2^48 packets 2^48 packets SRTCP lifetime 2^31 packets 2^31 packets Cipher AES Counter Mode AES Counter Mode Encryption key 128 bits 128 bits MAC HMAC-SHA1 HMAC-SHA1 SRTP auth.
SRTP Available SRTP configurations are provided in the following table. Table 86: 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. 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 The security icon indicates the security status of a call, and is useful for best-effort environments where there is a possibility of an unsecured call or where TLS is not used to communicate with the proxy.
Last successful or unsuccessful logon Figure 54: 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 55: 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.
Security Figure 56: 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 57: Login failure with time notification The following notification appears on the display screen to notify the user the last successful and unsuccessful log on attempts made. 290 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Enhanced administrative password security Figure 58: 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 59: Login and login failure with time notification Enhanced administrative password security The provisioning server can provide additional security associated with the administrative password.
Security stored on the IP Deskphone is not accepted. After this time, the administrative password must be changed in 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. 292 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 26: 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 Important IP Deskphone licensing information is located in the Keycode Retrieval System (KRS) User Guide. You must register for access to KRS. 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.
License file download • The license file is installed on the IP Deskphone through the provisioning server or TFTP server. • The IP Deskphone does not have an internal real-time clock. The time of day is obtained from the Call Server that the IP Deskphone is registered to on the network. • 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).
Licensing DOWNLOAD_MODE AUTO VERSION 4.00.xx.yy PROTOCOL TFTP FILENAME SIP 1230_03.02.xx.yy.bin ... [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 12character 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.
[LICENSING] section VERSION 000001 FILENAME ipctoken.cfg 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 phone from the provisioning server, it overwrites the existing license file and reboots the phone to activate the new license.
Licensing The following is an example of an 11xxe.cfg file that contains the [FW] section and the [LICENSING] section. [FW] DOWNLOAD_MODE AUTO VERSION VERSION 4.00.xx.yy FILENAME SIP 1140_e03.02.xx.yy.bin 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*.
Licensable features Figure 60: Licensing menu 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 The Basic Feature Set is 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 gets an additional token.
Licensing Figure 61: Licensing menu The Licensable Features list displays. Figure 62: 12xx Licensable Features allowed by license 300 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Node-locked license mode Figure 63: 12xx Licensable Features not allowed by license 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 64: Node-locked license mode — License information for time-based token (connected to non-Avaya 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. 302 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Node-locked license mode Figure 65: 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 66: 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 the extra line Tokens Required: 1. This line is displayed only when the IP Deskphone connects to an Avaya Server.
Invalid or no license file Figure 67: 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 68: 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. ; 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 Figure 70: License not available warning 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.
Alarms Figure 72: Evaluation period expiry 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 Licensing expiry threshold warning When the expiration date of the node-locked licence approaches,, a warning window is displayed on the IP Deskphone. The warning window indicates when the license will expire, and notifies you at the following predefined times: • 30 days before the license expires • 15 days before the license expires • 7 days before the license expires • 1 day before the license expires The following figure is an example of the license expiry threshold warning.
Licensed features • Image screensaver and lock • Standard font languages • Multiple calls per user • Server failover redundancy • Session timers • SNTP (time server) • Speed Dial List • Transfer to VM softkey • USB flash drive • Hotline The following extended features are available with a token or if the IP Deskphone is registered to a recognized Avaya server (Avaya, Avaya Communication Server 1000, or IP Office) then extended features are available without a token.
Licensing 312 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 27: PC Client Softphone interworking The interworking feature allows the user to access the functionality of the SIP IP Deskphone using a softphone client on their PC. On an incoming call, both the IP Deskphone and the PC Client Softphone ring. When the user answers the IP Deskphone, the softphone remains available for Instant Messages, video and other multimedia features.
PC Client Softphone interworking Answer-Mode Settings screen The Answer-Mode Settings screen is used to pre-grant authorization to request an automatic answer to potential callers or groups of callers.
Allow-Mode Settings screen Table 88: Context-sensitive soft keys for the Answer-Mode Settings screen Context-sensitive soft key Action Change Opens the screen for the selected option: Allow Mode, or Allow Addresses. Back Returns you to the Feature Options screen. The following table describes the outside actions on content for the Answer-Mode Settings screen. Table 89: Outside actions on content for the Answer-Mode Settings screen Key or action Result Goodbye Idle screen. Quit Idle screen.
PC Client Softphone interworking The following table describes the function of the Context-sensitive soft keys for the Allow-Mode Settings screen. Table 90: Context-sensitive soft keys for the Allow-Mode Settings screen Context-sensitive soft key Action Select Makes the current selection enabled. The selected user group is authorized for Answer-Mode. Back Returns you to the previous screen. The following table describes the outside actions on content for Allow-Mode Settings screen.
Allow Addresses screen • 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. To access the Allow Addresses screen, on the Preference menu, choose Feature Options, Answer-Mode Settings, and then Allow Addresses.
PC Client Softphone interworking The following table describes the function of the Context-sensitive soft keys for the Allow Addresses screen with no entries listed. Table 92: Context-sensitive soft keys for the Allow Addresses screen - with no entries listed Context-sensitive soft key Action Save Saves the entered domain or SIP address in a list and displays the list content. abc Changes from alphanumeric and numeric entry (abc to 123). Clear Erases all entered characters.
Automatically answering a call 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 313), the call is answered automatically. A "ring splash", or short ring tone, indicates to the user that the call was automatically answered.
PC Client Softphone interworking Table 95: PC Client Softphone configuration commands Configuration commands ENABLE_INTERWORKING Description The configuration values are YES and NO. The default value is NO. • If configured as YES, the interworking feature is enabled. • If configured as NO, the interworking feature is disabled. If interworking is enabled, the interface for pre-authorization is visible in the Feature Options menu.
Chapter 28: Maintenance Convert SIP Software to UNIStim Software The IP Deskphone can be ordered with UNIStim software installed or with SIP Software installed. If you have an IP Deskphone with UNIStim software, and you convert the software from UNIStim to 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.
Maintenance where xxx is the UNIStim version number appropriate for the hardware release of your IP Deskphone, for example, 062AC5L , and yyy.bin is the filename containing the version number, for example, SIP12x004.01.03.00.bin. 4. Power the IP Deskphone off and on. The IP Deskphone reboots and contacts the TFTP server upon bootup and downloads the new UNIStim software.
Reset Factory Settings support Table 96: Context-sensitive soft keys for Reset to Factory Setting Context-sensitive soft key Action Yes Activates Reset to Factory Setting. No Rejects Reset to Factory Setting, closes the confirmation screen, and returns to regular mode. Activating Reset to Factory Setting using SSH_PDT 1. Enter the PDT-command: >reset2factory The PDT displays the prompt: >Reset to Default... Are you sure? 2. Enter Y to accept. OR Enter N to decline.
Maintenance 324 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 29: Diagnostics and troubleshooting This chapter contains the following topics: • IP Deskphone diagnostics on page 325 • Local diagnostic tools on page 327 • How to access the Diagnostics menu on page 328 • IP Set and DHCP information on page 330 • Network Diagnostic Tools on page 332 • Ethernet Statistics on page 334 • IP Network Statistics on page 338 • Advanced Diag Tools on page 340 • Test key on page 342 • Logging Systems on page 344 • Problem Determination Tool (PDT) on page 345 • Diagnostic l
Diagnostics and troubleshooting If the display indicates that the server is unreachable and it continuously resets, some parameters must be configured. Things to consider when setting 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. • To record the entry and advance the initialization to the next parameter, press OK.
Local diagnostic tools There are four different boot loaders in the FLASH and application load. Various boot loaders are used to recover the IP Deskphone if a failure occurs. • If a conversion fails before anything is written to FLASH, the IP Deskphone reboots with the previous software load.
Diagnostics and troubleshooting Diagnostics option Description Ethernet Statistics Provides some Ethernet statistics for Network Interface and PC port. IP Network Statistics Provides IP Network statistics. Certificates Administration Supports administration of available certificates.
How to access the Diagnostics menu Figure 80: Network menu After you access the Network menu, the following options are available: • Server Settings • Device Settings • Diagnostics • Licensing • Lock Select 3. Diagnostics, or press Back to return to the Network menu.
Diagnostics and troubleshooting Figure 81: Diagnostics menu The following table describes the function of the Navigation keys for the Diagnostics screen. Table 98: 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 soft key. Digital keys (number associated with option) Invokes an appropriate option. * Selects the first option Server Settings, but does not activate it.
IP Set and DHCP information Figure 82: IP Set and DHCP Info 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 2. Primary Server: S1 PC Port is: ON 3. Software Version: 3.00.09.02 Hardware ID: xxxxxx 4. Set IP: xxx.xxx.xxx.xxx (could be in IPv4 or IPv6 format) 5. Sub-Mask: xxx.xxx.xxx.xxx (could be in IPv4 or IPv6 format) 6.
Diagnostics and troubleshooting S01 IP: xxx.xxx.xxx.xxx Port: 4100 Act: 1 Retries: 5 S02 IP: xxx.xxx.xxx.xxx Port: 4100 Act: 1 Retries: 5 S03: IP: xxx.xxx.xxx.xxx Port: 4100 Act: 1 Retries: 5 S04 IP: xxx.xxx.xxx.xxx Port: 4100 Act: 1 Retries: 5 11. Provisioning Server: xxx.xxx.xxx.xxx The following table describes the function of the Navigation key for the IP Set and DHCP Info screen. Table 99: Navigation Key Action Up and down arrows Use the up and down arrows to scroll the screen.
Network Diagnostic Tools Figure 83: Network Diagnostic Tools screen There are two configurable fields: • IP — enter an IP address. • Hops — number of hops used as a configurable parameter for tracert routine. The following services are available: • activate the ping routine • activate the tracert routine The following table describes the function of the context-sensitive soft keys for the Network Diagnostics tools screen.
Diagnostics and troubleshooting Table 101: Context-sensitive soft keys for the Network Diagnostic Tools screen Context-sensitive soft key Action Ping Activates the ping routine. Tracert Activates the tracert routine. Cancel Returns you to the Diagnostics menu. The following table describes the function of the Navigation keys for the Network Diagnostic Tools screen. Table 102: Navigation Key Action Up and down arrows Use the up and down arrows to scroll through a list of testing information.
Ethernet Statistics SIP Software for Avaya 1200 Series IP Deskphones-Administration September 2013 335
Diagnostics and troubleshooting Ethernet statistics example: 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. Multicast Packets Rx: 1 === 802.
Ethernet Statistics (PC Port) screen Table 104: Navigation Key Up and down arrows Action Use the up and down arrows to scroll through the list of statistics information. Ethernet Statistics (PC Port) screen The Ethernet Statistics (PC Port) screen displays Ethernet statistics for the PC Port. To view the PC Port Ethernet statistics, from the Ethernet Statistics screen, press the NI Port soft key.
Diagnostics and troubleshooting 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. 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 85: Use the up and down Navigation arrows to scroll through the list of IP Network Statistics information. 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.
Diagnostics and troubleshooting The following table describes the function of the Navigation keys for the IP Network Statistics screen. Table 108: Navigation Key Action Up and down arrows Use the up and down arrows to scroll through a list of statistics information.
Advanced Diag Tools Table 109: Context-sensitive soft keys for the Advanced Diag Tools screen Context-sensitive soft key Action Apply Invokes the selected service. Back Dismisses the dialog box and returns you to the Diagnostics menu. The following table describes the function of the navigation keys for the Advanced Diag Tools screen. Table 110: Navigation Key Action Up and down arrows Use the up and down arrows to scroll through a list of statistics information.
Diagnostics and troubleshooting 1. In Device Settings dialog, turn on PC Port 2. Press the following keys in order (dial the magic sequence): [mute] + [up] + [down] + [up] + [down] + [up] + [mute] + [7] on the IP Deskphone dial pad. 3. Connect your PC to the PC port of the IP Deskphone. Enabling Port Mirroring on the IP Deskphone through provisioning: To enable Port Mirroring feature on the IP Deskphone through provisioning, perform this procedure: 1. Open the Device Settings dialog. 2.
Test key Figure 87: 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 111: Context-sensitive soft keys for the Test key screen Context-sensitive soft key Quit Action Dismisses the Services menu. The following table describes the function of the Navigation key for the Test key screen.
Diagnostics and troubleshooting Logging Systems Logging Systems contains a subsystem for logging incoming and outgoing SIP packages for the IP Deskphone to the log file in FFS. You can enable or disable the SIP logging subsystem by selecting Yes (enable) or No (disable). To access the Logging Systems menu, press the Services key on the IP Deskphone, and then choose Logging Systems from the Services menu.
Problem Determination Tool (PDT) Context-sensitive soft key Back Action 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 114: Navigation Key Action Up and down arrows Use the up and down arrows to scroll the screen. Right and left arrows Navigates through the signs. Enter Switches the value of the selected sign from ON to OFF, and OFF to ON.
Diagnostics and troubleshooting • Stack Overflow Monitor • Traffic Monitor 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.
PDT commands PDT commands The Problem Determination Tool (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.
Diagnostics and troubleshooting • SSHID • SSHPWD . 4. Press the Services soft key and select 4.Check for Update. Press the YES soft key to update the IP Deskphone configuration. 5. Connect to the IP Deskphone by using any SSH client program. The PDT supports the following set of commands: Table 115: List of PDT commands # 1 Command prtlog >prtlog Description • Prints the content of the ECR-log file.
PDT commands # Command Description 6 printRecoveryLevel Prints recovery level 7 taskMonShow Prints a list of monitored tasks 8 "i" Prints all task information 9 ti Prints task information 10 memshow [level] Shows memory information 11 checkStack 12 tt Prints Task Trace 13 info Prints HardwareID, SoftwareID, MAC and BT address 14 prtcfg Prints content of the IP Deskphone configuration file, S
Diagnostics and troubleshooting # Command Description 27 sendevent <0xmmm <0xnnn> Simulates an UNIStim event. 28 lcdparam Sets up LCD parameters for the IP Deskphone 29 audio Loopbacks audio to handset/headset/ Handsfree 30 display Turns all LCD and LED on or off 31 keypress Turns all key presses on or off 32 clearlog >clearlog Clears content of the specified log file.
Device configuration file The command ( i ) displays the list of tasks with TID and STATUS fields. For every task that has a SUSPEND status in the list, enter the following commands: ti 0x. tt 0x checkStack 0x To print out a list of all supported commands and a short description of each, enter the "?" command when the PDT prompt is displayed, as shown in this example: PDT> ?.
Diagnostics and troubleshooting Component Flag Description 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. SIP_traffic monitor DOS_MAX_LIMIT Specifies how many packets past DOS_PACKET_RATE the IP Deskphone can receive before packets are dropped.
Diagnostic logs Diagnostic logs The IP Deskphone supports two types of log files: • ECR-log • SIP-log 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.
Diagnostics and troubleshooting The third section includes the supplementary information. The content depends on the flag in the calling function.
Diagnostic logs Figure 89: Example of the supplementary information in the ECR-log file SIP Software for Avaya 1200 Series IP Deskphones-Administration September 2013 355
Diagnostics and troubleshooting Figure 90: Example of the supplementary information in the ECR-log file (continued) Figure 91: Example of the ECR-log file on page 357 is an example of the ECR-log file output when the following PDT command is entered: PDT>prtlog 0 356 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Diagnostic logs Figure 91: Example of the ECR-log file SIP Software for Avaya 1200 Series IP Deskphones-Administration September 2013 357
Diagnostics and troubleshooting Figure 92: Example of the ECR-log file (continued) 358 SIP Software for Avaya 1200 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 text format.
Diagnostics and troubleshooting Figure 93: Example of the SIP-log file 360 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Diagnostic logs Figure 94: Example of the SIP-log file (continued) There are three ways to get SIP-logs from the IP Deskphone: 1. Connect to the phone through SSH • Online — connect to the phone through SSH and enter the PDT command dbgshell. The log messages are printed out during a call to the SSH console. • Offline— connect to the phone through SSH and enter the PDT command prtlog 1. The active SIP-log file is printed out to the SSH console. 2. Log files are stored on the IP Deskphone flash device.
Diagnostics and troubleshooting • Press the Auto soft key and check the SFTP Enable checkbox in the Auto Provisioning window. • Press the Config soft key to return to the Network Settings window • Check the Enable SSH checkbox. c. Add the following parameters to the device configuration file of the phone SSH YES SSHID SSH YES SSHID SSHPWD SFTP YES SFTP_READ_PATTERNS .txt,.zip,.log SFTP_WRITE_PATTERNS .txt,.zip,.
Configuration server logs Configuration server logs To view all logs related to the configuration server, go to: /usr/local/sipx/var/log/sipxbx/sipxconfig.log /usr/local/ sipx/var/log/sipxbx/sipxconfig.logins.log PC Client Softphone interworking with the IP Deskphone If the user does not have access to the pre-authorization configurations in the Feature Options menu, the feature is not enabled.
Diagnostics and troubleshooting 364 SIP Software for Avaya 1200 Series IP Deskphones-Administration Comments? infodev@avaya.
Index Numerics 1230 IP Deskphone with SIP Software illustration ..... 29 12xxBoot.cfg download ............................................ 100 12xxBoot.cfg file download, manual ......................... 101 12xxBoot.cfg file, downloading the ........................... 100 802.1ab Link Layer Discovery Protocol (LLDP) ........ 122 802.1x (EAP) authorization .......................................121 802.1x (EAP) device ID ............................................ 121 802.1x (EAP) password ..............
Downloading SIP Software from the Avaya Web site 111 Downloading the 12xxBoot.cfg file ........................... 100 Downloading the SIP software to the provisioning server ............................................................ 40 Downloading UNIStim software through TFTP on bootup .......................................................... 108 DRegex ...................................................................... 90 DRegex rules ..............................................................
Provisioning file example ............................................40 Provisioning file supported sections ........................... 40 Provisioning server ..................................................... 39 Provisioning the Device Settings parameters ........... 134 Provisioning updates .................................................. 39 PVQMon IP ...............................................................133 PVQMon IP configuration .........................................
