SIP Software for Avaya 1100 Series IP Deskphones-Administration SIP 3.1 NN43170-600, Standard 00.
© 2012 Avaya Inc. All Rights Reserved. Notice While reasonable efforts have been made to ensure that the information in this document is complete and accurate at the time of printing, Avaya assumes no liability for any errors. Avaya reserves the right to make changes and corrections to the information in this document without the obligation to notify any person or organization of such changes.
Contents Chapter 1: New in this release........................................................................................... 11 Features.................................................................................................................................................... 11 Security..................................................................................................................................................... 11 Revision history.........................................
Chapter 7: Configure the DHCP Server............................................................................. 93 Configure the DHCP server to support SIP IP Deskphone class identifier............................................... 93 Requested Device Settings parameters................................................................................................... 94 DHCP VLAN Auto Discovery...............................................................................................................
Feature dependencies and restrictions............................................................................................ 140 Configuration files............................................................................................................................. 141 Performance characteristics............................................................................................................. 141 Multiple Appearance Directory Number....................................................
TLVs................................................................................................................................................. 175 PC Client Softphone interworking............................................................................................................. 179 Pre-granting authorization for the Answer-Mode.............................................................................. 179 Automatically answering a call.....................................................
Installing a Security Policy file................................................................................................................... 239 Security policy logs and diagnostics......................................................................................................... 240 EAP Authentication................................................................................................................................... 240 EAP Re-authentication......................................
2xx Response—Successful responses..................................................................................................... 283 3xx Response—Redirection responses.................................................................................................... 283 4xx Response—Request failure responses.............................................................................................. 284 5xx Response—Server failure responses............................................................
SSH.................................................................................................................................................. 331 Index.....................................................................................................................................
SIP Software for Avaya 1100 Series IP Deskphones-Administration January 2012
Chapter 1: New in this release SIP Software for Avaya 1100 Series IP Deskphones- Administration , NN43170-600 is a new document for SIP Software Release 3.1. This document contains administration information for the Avaya 1120E IP Deskphone and Avaya 1140E IP Deskphone,. Features SIP Software Release 3.1 introduces support for: Security features Security SIP Software Release 3.
New in this release October 2010 12 Standard 00.51. This is a new document for Avaya 1100 Series IP Deskphones and is issued to support SIP Software Release 3.1. SIP Software for Avaya 1100 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 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://support.avaya.com/css/appmanager/public/ support. 14 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 3: Introduction to this guide Subject SIP Software for Avaya 1100 Series IP Deskphones — Administration, NN43170-600 describes how to install, configure, and provision the Avaya 1120E IP Deskphone and Avaya 1140E IP Deskphone for use on a SIP network. These IP Deskphones are collectively known as Avaya 1100 Series IP Deskphones. In this document, the Avaya 1100 Series IP Deskphones are referred to as IP Deskphones.
Introduction to this guide 16 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 DOD Department of Defense DRegex Digit Regular Expression DSCP Differentiated Services Code Point DSN Defense Switched Network EAP Extensible Authentication Protocol ECR Error Collection and Recovery EJBCA Enterprise Java Bean Certificate Authority ERE Extended Regular Expres
Acronyms MAC Media Access Control MADN Multiple Appearance Directory Number MAS Media Application Server MD5 Message Digest v5 MLLP Multi-Level Precedence and Pre-emption 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 Crypt
Introduction to this guide SIP Session Initiation Protocol SKS Special Key Sequence SMTP Simple Mail Transfer Protocol SOAP Simple Object Access Protocol SRTCP Secure Real-time Transport Control Protocol SRTP Secure Real-time Transport Protocol STUN Simple Traversal of UDP through NAT devices TCP Transport Control Protocol TFTP Trivial File Transport Protocol TLS Transport Level Security TPS Terminal Proxy Server TTL Time-to-live UDP User Datagram Protocol UFTP UNIStim File Trans
Chapter 4: Overview Introduction This chapter describes the hardware and software features of the Avaya 1100 Series IP Deskphones and provides a brief overview of Session Initiation Protocol (SIP). In this document, Avaya 1100 Series IP Deskphones will be referred to as IP Deskphones. SIP overview Session Initiation Protocol (SIP) is a signaling protocol used for establishing multimedia sessions in an Internet Protocol (IP) network.
Overview Important: Converting the software on an IP Deskphone from UNIStim software to SIP software overwrites the UNIStim software. The IP Deskphone cannot operate in both modes simultaneously. A switch from UNIStim to SIP software or SIP to UNIStim software requires a software reload.
Introduction Installation overview To install the Avaya 1100 Series IP Deskphones with SIP Software, three basic steps are required. 1. Configure the provisioning server and, optionally, the DHCP server. The function of the provisioning server is to provide configuration options to every IP Deskphone throughout the network. The DHCP server can be configured to provide basic network-configuration data or a more comprehensive set of network-configuration data for the IP Deskphone with SIP Software. 2.
Overview Figure 1: Installation of IP Deskphones with SIP Software, page 1 of 2 22 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Introduction Figure 2: Installation of IP Deskphones with SIP Software, page 2 of 2 SIP Software for Avaya 1100 Series IP Deskphones-Administration January 2012 23
Overview 24 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 5: Before installation Introduction This chapter features a checklist of tasks you must complete before you install SIP Software on the Avaya 1100 Series IP Deskphones. Preinstallation Complete the following checklist. Preinstallation checklist 1. Read and become familiar with your IP Deskphone User Guide. 2. Ensure there is one IP Deskphone boxed package for each IP Deskphone being installed. 3.
Before installation Table 2: External power supply parts list (order separately) CPC code PEC code Product description N0146475 NTYS17BAE6 IP Deskphone Global Power Supply (2000, 1100, 1200) (RoHS) N0089603 NTYS14AAE6 Standard IEC Cable - North America (RoHS) A0781922 NTTK15AA Standard IEC Cable – Australia / NZ (Note: RoHS not required) N0114986 NTTK16ABE6 Standard IEC Cable – Europe N0109787 NTTK17ABE6 Standard IEC Cable – Switzerland N0109881 NTTK18ABE6 Standard IEC Cable – UK N0109
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 99 for instructions on how to convert the software on an IP Deskphone from UNIStim to SIP.
Configure the provisioning server IP Deskphone, a new file transfer session starts for each file to be downloaded. The provisioning file (for example, 1140eSIP.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.
Create the SIP provisioning file on the provisioning server [LANGUAGE] DOWNLOAD_MODE_AUTO DELETE_FILES YES VERSION 000024 FILENAME French_d24lang FILENAME Portuguese_d24.lang FILENAME Czech_d24.lang FILENAME Russian_d24.lang Language files section [IMAGES] DOWNLOAD_MODE_FORCED VERSION 000003 FILENAME mountains.png FILENAME sunrise.png Images section [TONES] DOWNLOAD_MODE_AUTO DELETE_FILES YES VERSION 000003 FILENAME ring.
Configure the provisioning server Table 3: 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. • [IMAGE]—this section is used for downloading images for backgrounds and screensavers. • [TONES]— The IP Deskphone supports custom ringtone files. The tone files must be WAV files with the following specification: A-law or u-law (8.0 kHz, 8-bit, mono or 16.0 kHz, 16 bit mono).
Configure the provisioning server be entered in this field. For all other sections, VERSION is just a counter that can be incremented if it is necessary to download a new file version. Note: The version number of the firmware [FW] can be longer, up to 19characters, and must follow this format: SIP1120e03.02.16.00 SIP1140e03.02.16.00 Caution: The version number is stored permanently on the IP Deskphone until a higher version number is downloaded. However, if Forced option is in the 1xxxeSIP.
Create the SIP provisioning file on the provisioning server - NO – disables the prompt • PROTOCOL [TFTP | FTP | HTTP] [ HTTPS] defines the protocol used to download the file. The IP Deskphone with SIP Software supports TFTP, FTP, HTTP, and HTTPS protocols for file download. This command is optional. If it is not present, the default protocol TFTP is used. Important: When using the TFTP protocol to transfer the software image, the average round trip time must be < 75 ms.
Configure the provisioning server attempt to read the Provisioning file. A Soft Reset ( Srvcs, System, Reset Phone) does not cause the IP Deskphone to retrieve the Provisioning file. Setting the default language on the IP Deskphone to French To configure the default language on a new IP Deskphone, or an IP Deskphone that has not been logged into by an end user, include the following in the [DEVICE_CONFIG] and [LANGUAGE] sections of the 11xxeSIP.cfg configuration file.
Create the device configuration file on the provisioning server Figure 3: Sample device configuration file Parameters in the IP Deskphone configuration file are saved on the IP Deskphone. Removing a parameter from the IP Deskphone configuration file does not change the parameters saved on a configured IP Deskphone. If a parameter is configured only in the IP Deskphone-specific configuration file, removing the IP Deskphone-specific configuration file does not clear the setting.
Configure the provisioning server Configuration command type Feature configuration commands 36 Configuration commands SERVER_IP1_1 SERVER_IP1_2 SERVER_IP2_1 SERVER_IP2_2 SERVER_PORT4_1 SERVER_PORT4_2 SERVER_PORT5_1 SERVER_PORT5_2 SERVER_RETRIES1 SERVER_RETRIES2 SERVER_RETRIES3 SERVER_RETRIES4 SERVER_RETRIES5 SERVER_IP5_2 SERVER_PORT1_1 SERVER_PORT1_2 SERVER_PORT2_2 SERVER_PORT3_1 SERVER_PORT3_2 DNS_DOMAIN DEF_USERS DEF_USER1 DEF_USER2 DEF_USER3 DEF_USER4 DEF_USER5 UPDATE_USERS SIP_PING REG_REFRESH_INT
Create the device configuration file on the provisioning server Configuration command type Configuration commands MAX_LOGINS MAX_INBOX_ENTRIES MAX_OUTBOX_ENTRIES MAX_REJECTREASONS MAX_CALLSUBJECT MAX_PRESENCENOTE TIMEZONE_OFFSET FORCE_TIME_ZONE IM_MODE IM_NOTIFY DEF_DISPLAY_IM CALL_WAITING DISTINCTIVE_RINGING USE_RPORT TOVM_SOFTKEY_ENABLE TOVM_VOICEMAIL_ALIAS TOVM_VOICEMAIL_PARAM MAX_RING_TIME ENABLE_UPDATE E911_USERNAME E911_PASSWORD KEEP_ALIVE_TYPE CONN_KEEP_ALIVE AUTOLOGIN_ID_KEYxx AUTOLOGIN_PASSWD_K
Configure the provisioning server Configuration command type Configuration commands SET_RESP_REFRESHER MAX_ALLOWEDADDRESSE S PORT_MIRROR_ENABLE MEMCHECK_PERIOD DOS_PACKET_RATE DOS_MAX_LIMIT DOS_LOCK_TIME LOGSIP_ENABLE CUST_CERT_ACCEPT CERT_ADMIN_UI_ENABLE SEC_POLICY_ACCEPT SECURITY_LOG_UI_ENABL E KEY_SIZE KEY_ALGORITHM TLS_CIPHER SIGN_SIP_CONFIG_FILES FP_PRESENTED FP_ENTERED SUBJ_ALT_NAME_CHECK_ ENAB LE CERT_EXPIRE SECURITY_POLICY_PARA M_CHANGE AUTO_PRV_ACCEPT AUTO_PRV_SIGNING DWNLD_CFG_SIGNING FTP_PASSW
Create the device configuration file on the provisioning server Configuration command type Configuration commands ADMIN_PASSWORD_EXPIR Y ENABLE_LOCAL_ADMIN_UI HASHED_ADMIN_PASSWO RD Audio Codecs G729_ENABLE_ANNEXB G723_ENABLE_ANNEXA DEF_AUDIO_QUALITY AUDIO_CODEC1 AUDIO_CODEC2 AUDIO_CODEC3 Deskphone Recovery command RECOVERY_LEVEL AUDIO_CODEC4 AUDIO_CODEC5 AUDIO_CODEC6 AUDIO_CODEC7 Device configuration commands Important: The device configuration file uses the following syntax: • [ ] – mandatory fiel
Configure the provisioning server Server and network configuration commands SIP_DOMAIN[x] [domain_name] This parameter preconfigures the proxy domain name for all servers. The same configuration can be done through the domain configuration menu on the IP Deskphone. - x – the number of the SIP domain number from 1 to 5. - domain_name – the proxy domain name for all servers. Note: SIP_DOMAIN[x] is provisioned after user logout.
Server and network configuration commands DNS_DOMAIN [domain] This parameter is the DNS domain of the IP Deskphone. DEF_USERS[x] [user_name] This parameter allows you to enter the default user name for all domains. When the device configuration file gets downloaded, the default user name is used when logging in. - x – the domain number from 1 to 5. - user_name – the default user name. UPDATE_USERS [YES | NO] This parameter affects the default user names stored in the IP Deskphone.
Configure the provisioning server configuration file, the IP Deskphone must be rebooted for the change to take effect. - YES – enables pinging - NO – disables pinging REG_REFRESH_INTERVAL [seconds] This parameter allows the administrator to change the default re-registration time of the IP Deskphone. The default is 86400 seconds (or 24 hours). The minimum value is 300 and the maximum value is 86400.
Server and network configuration commands - YES – enables IPv6 stateless autoconfiguration (default). - NO – disables IPv6 stateless autoconfiguration. REGISTER_RETRY_TIME [seconds] This parameter configures in seconds how long the IP Deskphone waits before it attempts to reregister with the proxy server. The default value is 30 (seconds).
Configure the provisioning server - AES_CM_128_HMAC_SHA1_32 (default value) - AES_CM_128_HMAC_SHA1_80 - None SSH [YES | NO] This parameter configures the SSH server on the IP Deskphone. The default value is NO. - YES – configure the SSH server - NO – do not configure the SSH server (default) SFTP [YES | NO] This parameter configures the SFTP server on the IP Deskphone. The default value is NO.
Server and network configuration commands - SHA1 – algorithm is Secure HASH Algorithm 1 - MD5 – algorithm is Message-Digest algorithm 5 MKI_ENABLE [YES | NO] This parameter indicates whether to use the Master Key Identifier (MKI) or not. The default value is NO. - YES – MKI is configured - NO – MIK is not configured EAP [MD5 | TLS | PEAP | DISABLE] This parameter allows the administrator to ensure that individual devices are authorized to access the enterprise’s LAN environment.
Configure the provisioning server HOST_NAME [hostname] This parameter is the IP Deskphone host name. - minimum value – 4 characters - maximum value –12 characters SIP_UDP_PORT [1024 to 65535 | This parameter configures the listening port for incoming 0] UDP requests. The default value is 5060. - minimum value – 1024 - maximum value – 65535 - Disabled – 0 SIP_TCP_PORT [1024 to 65535 | This parameter configures the listening port for incoming 0] TCP requests. The default value is 5060.
Feature configuration commands TOVM_VOICEMAIL_PARA [string] This parameter customizes the parameter name of the SIP URI of the voice mail system. The default is mbid. SCA_APPEARANCES [x] This parameter configures the maximum number of appearances used for outgoing calls by the Shared Call Appearance (SCA) group. The valid range for this parameter is 2 to 24. The default value is 12. This is used with the Broadsoft proxy.
Configure the provisioning server - YES – turns on the distinctive ringing feature. This is the default option. - NO – turns off the distinctive ringing feature. USE_RPORT [YES | NO] - YES – allows the IP Deskphone to work from behind and/or in front of a symmetrical NAT with servers and/or clients that support RFC3581. - NO – disables implementation of support for RFC3581. This is the default option. EXP_MODULE_ENABLE [YES | NO] - YES – the IP Deskphone detects and enables an expansion module.
Feature configuration commands PROMPT_ON_LOCATION_OTHER [YES | NO] - YES – prompt the user to select new location if location “other” was previously selected. - NO – do not prompt the user to select new location if location “other” was previously selected. This is the default option. VMAIL [vmail_number] This parameter is the voice mail address, which can be the URI or the DN number of the voice mail server. This command takes a string as a parameter.
Configure the provisioning server - 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.
Feature configuration commands 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 set. AUTO_UPDATE_TIME [x] This parameter is the actual time in seconds, starting from midnight, before an automatic update occurs. Each IP Deskphone adds random numbers to the time specified by this command so every IP Deskphone does not try to access the provisioning server at the same time.
Configure the provisioning server subsequent messages are sent to the new address. - RFC3261 – the IP Deskphone assumes that, if during registration, a 301 (moved permanently) is received, the message contains a new registrar address. The IP Deskphone tries to register to the registrar using the existing proxy. ENABLE_PRACK [YES | NO] PRACK is utilized to make some SIP messages reliable and requires that an ACK be sent with many SIP messages.
Feature configuration commands - YES – enables Bluetooth. - NO – disables Bluetooth. The default is NO. Note: This applies to the Avaya 1100 Series IP Deskphones only. AudioCodec This parameter is a command that specifies the codecs that are available for the user to select. You can configure up to 15 codecs. - n – the codec number. The value is 1 to 15.
Configure the provisioning server - AUTH – only authenticates (username/password) (default). - AUTH_INT – authentication plus integrity checking (an MD5 hash of the entity is also computed and checked). BANNER [banner_text] This parameter preconfigures the banner on the IP Deskphone. The banner is displayed on the IP Deskphone when the phone is idle. Use a text string to configure the banner. For example, BANNER ABC Company configures the banner to ABC Company.
Feature configuration commands parameter. For example, TIMEZONE_OFFSET -25200 configures the time zone offset to MST, which is GMT-7 (-7*3600 = -25200 seconds).
Configure the provisioning server Location FORCE_TIME_ZONE [YES | NO] Time zone offset (seconds) (GMT+10:00) Canberra, Melbourne, Sydney 36000 (GMT+12:00) Auckland, Wellington 43200 This parameter allows you to force the timezone offset on each user's IP Deskphone. The default is NO. - YES – forces the IP Deskphone to use the TIMEZONE_OFFSET specified in the device configuration file. - NO – uses the value stored in the user preferences.
Feature configuration commands - YES – enables display of IMs. - NO – disables display of IMs. SELECT_LAST_INCOMING [YES | NO] This parameter determines which call is selected when there are multiple calls ringing (or active). The default value is NO. - YES – the selected call in the call list jumps to the most recent ringing call after it is added to the list. - NO–leaves the last selected call static as new calls come in or are dropped.
Configure the provisioning server MAX_CALLSUBJECT [x] This parameter restricts the maximum number of call subjects (Prefs, Feature Options, Call Subject) and takes a number as a parameter. The default limit is 20. x – the maximum number of call subject reasons. MAX_PRESENCENOTE [x] This parameter restricts the maximum number of presence notes and takes a number as a parameter. The default limit is 20. x – the maximum number of presence notes that an IP Deskphone can receive.
Feature configuration commands network address book is available, the IP Deskphone functions as if NETWORK mode has been selected. HOLD_TYPE [RFC2543 | RFC3261] This parameter selects the protocol to hold a call. The default setting is RFC3261. - RFC2543 – standard protocol of the Internet Engineering Task Force (IETF). - RFC3261 – standard protocol of the IETF. ENABLE_3WAY_CALL [YES | NO] This parameter enables or disables local telephonebased three-way calling for three-party conferences.
Configure the provisioning server SNTP_ENABLE [YES | NO] This parameter allows the IP Deskphone to obtain the time and date from an NTP server. The default is NO. The IP Deskphone updates the time once every 24 hours from the NTP server. If the IP Deskphone cannot contact the server, the IP Deskphone tries every 15 minutes up to a maximum of 6 attempts, and then hourly attempts are made. If SNTP_ENABLE is configured as NO, the IP Deskphone tries to retrieve the time and date from the SIP proxy server.
Feature configuration commands configuration value is enabled, the IP Deskphone plays an abbreviated ring tone to remind the user that a call has been forwarded. This configuration value only effects users when their user profile is first created, unless the FORCE_CFWD_NOTIFY flag is also used. The default setting is NO. - YES – a brief ring splash plays when a call is forwarded. - NO – the ring splash does not play.
Configure the provisioning server - YES – the call server supports ad hoc conferencing. - NO – the call server does not support ad hoc conferencing. MAX_ADHOC_PORTS1 [0–4] INTERCOM_PAGING [YES | NO] This parameter indicates the maximum number of users supported for ad hoc conferencing on the server. This value must be the same as the value configured on the server. When ENABLE_SERVICE_PACKAGE is enabled, the preceding parameters are ignored. The default value is 0.
Feature configuration commands - YES – enables the remote check for updates feature. - NO – the IP Deskphone does not act on the NOTIFY message from the proxy. SECURE _INCALL_DIGITS [YES | NO] This parameter shows the typed digits as asterisks when the user makes a call into the voice mail. When this feature is enabled, the most recently-pressed key is displayed but is overwritten by an asterisk (*) when the next key is pressed. The user has the option to Hide or Unhide the digits typed.
Configure the provisioning server E911_TXLOC [Register | Invite] This parameter is the variable that describes location information that must be sent with the REGISTER SIP message, or with the INVITE SIP message. - REGISTER – the location is sent in both the INVITE and the REGISTER message. - INVITE – the location is sent with the INVITE only.
Feature configuration commands - YES – enables the customizable banner login banner. - NO – disables the customizable banner login banner (default). SECURE_UI_ENABLE [YES| NO] This parameter disables access to the Phone Information details screen, and the context-sensitive soft key that invokes it. The values are YES and NO. The default value is NO. - YES – disables access to the Phone Information details screen and the context-sensitive soft key that invokes it.
Configure the provisioning server - YES – enables the UI for configuring and using the screensaver without a password. - NO – disables the UI for configuring and using the screensaver without a password (default). SCRNSVR_TEXT [text] This parameter configures the text displayed on the screensaver of newly created profiles when the screensaver/lock is active. Changes to this value through the Prefs context-sensitive soft key overwrites the value provided through provisioning.
Feature configuration commands specified file does not exist in the images folder of the IP Deskphone, no background image is used for the display. The default value is YES. - YES – configures the background image file for the display in newly created profile (default). - NO – does not configure the background image file for the display in newly created profile. BG_IMG_SELECT_ENABLE [YES| This parameter changes the selected background NO] image for the display.
Configure the provisioning server the speed dial list). This file is similar to the dialing plan file. It needs to be properly configured and uploaded to the IP Deskphone through provisioning. The IP Deskphone parses the file, and configures the feature key specified by SPEEDLIST_KEY_INDEX to hold the Speed Dial List. If the key defined for use by the Speed Dial List is already in use, the key is overwritten and the key is assigned speed dial list functionality.
Feature configuration commands - YES – allows the user to delete or copy WAV files on the IP Deskphone or USB drive through the file manager (default). - NO – does not allow the user to delete of copy WAV files on the IP Deskphone or USB drive through the file manager. FM_IMAGES_ENABLE [YES | NO] This parameter allows the user to act on JPG and PNG files using the file manager. The default value is YES. - YES – to act on JPG and PNG files using the file manager (default).
Configure the provisioning server - YES – enables the USB port - NO – disables the USB port (default). Note: If the default value is acceptable, the ENABLE_USB_PORT configuration command is not required to be in the device configuration file. If change is required, the ENABLE_USB_PORT configuration command must be placed in the device configuration file with the new value. USB_MOUSE [YES | NO[ This parameter enables or disables the USB mouse. The dafault is NO.
Feature configuration commands Note: If the default value is acceptable, the USB_HEADSET configuration command is not required to be in the device configuration file. If change is required, the USB_HEADSET configuration command must be placed in the device configuration file with the new value. Avaya recommends that you use the following headset types: - GNNetcom GN9350e - Plantronics CS-50 USB_MEMORY_STICK [YES | NO[ This parameter enables or disables the USB flash drive. The default value is NO.
Configure the provisioning server HOTLINE_URL This parameter is used as To field of INVITE message by the SIP IP Deskphone to notify the Proxy Server that this is a call from a Hotline Phone. The HOTLINE_URL is not a real URL of the Hotline target. The IP Deskphone has no idea about the Hotline target. 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.
Feature configuration commands PORT_MIRROR_ENABLE [YES| NO] This parameter enables or disables the Port Mirroring feature. The default value is NO. - YES – the Port Mirroring prompt in the Advanced Diag Tools dialog is enabled and can be modified. - NO – the Port Mirroring prompt in the Advanced Diag Tools dialog is disabled (dimmed) and cannot be modified.
Configure the provisioning server For more information, see Roaming profiles on page 147. DEFAULT_ADDRESSBOOK_FILE [filename] This parameter is the default filename used when downloading the provisioning files. Default names are overwritten by names specified in the user.cfg file. For more information, see Roaming profiles on page 147. DEFAULT_SPEEDDIALLIST_FILE [filename] This parameter is the default filename used when downloading the provisioning files.
Feature configuration commands DISABLE_SPKRPHN [YES | NO] This parameter disables the speakerphone for all non-911 calls. This is intended for DoD. The default value is NO. - YES– disables the speakerphone. - NO – enables the speakerphone . CALL_ORIGIN_BUSY [YES |NO] This parameter determines if the user is presented with an incoming call when entering the address of an outbound call. This is intended for DoD. The default value is NO. - YES– user is not presented with an incoming call .
Configure the provisioning server QoS and ToS commands DSCP_CONTROL [x] This parameter uses a value entered in decimal format between -1 and 63. If the value is -1, the DSCP value is picked up by the Service Package. The default value is 40. x –– a value from -1 to 63 indicating the DSCP value. 802.1P_CONTROL [x] This parameter uses 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.
QoS and ToS commands value is retrieved from the Service Package. The default value is 6. x ––a value from -1 to 7 indicating the 802.1P value. DSCP_MEDIA_FLASHOVERRIDE [x] This parameter uses a value entered in decimal format between -1 and 63 representing the DSCP value in the provisioning packets for flash override precedence and priority level voice call. If the value is -1, the DSCP value is retrieved from the Service Package. The default value is 41.
Configure the provisioning server value is retrieved from the Service Package. The default value is 18. x –– a value from -1 to 63 indicating the DSCP value. Tone configuration commands DIAL_TONE [frequency1 | This parameter selects the tone advising the caller that the frequency2 | on_time | exchange is ready to receive call information and invites the user off_time] to start sending call information. You can select the countryspecific tone. The default tone is the North American tone.
NAT configuration commands - 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. FASTBUSY_TONE This parameter selects the tone advising the caller that the [frequency1 | frequency2 telephone number is busy. It is fast in cadence or frequency. You | on_time | off_time] can select the country-specific tone. The default tone is the North American tone. - frequency1 – the frequency of tone 1.
Configure the provisioning server parameter SIP_PING in the device configuration file. - SIP_PING – an Avaya proprietary NAT traversal protocol. Note that SIP_PING only supports NAT traversal in the signaling port. - STUN – the most common NAT traversal method. NAT_MEDIA [NONE | STUN] This parameter indicates the type of protocol used for NAT traversal in the media ports. The default is NONE. - NONE – is the default and disables NAT_MEDIA.
VQMon configuration commands STUN_SERVER_PORT2[port_number] This parameter is the port number used corresponding to STUN_SERVER_IP2. The default port number is 3478. port_number– is the port number. VQMon configuration commands Important: Ensure you read How VQMon works on page 124 before configuring the VQMON parameters.
Configure the provisioning server VOCODER_FLAG_G723_ RATE_63 VOCODER_G729 VOCODER_G722 VOCODER_PCM16 VOCODER_PCM8 vqmonVocoderTypeUnkno wn LISTENING_R_WARN [xx] LISTENING_R_WARN = 70 (default if not configured and unknown type) LISTENING_R_EXCE = 60 This parameter is the threshold to send a report on Listening R less than [xx]. The default value is 70. Using 0 resets it to default based on far end VOCODER. xx – is an INTEGER value used as threshold.
VQMon configuration commands - YES – enables the sending of alert report based on jitter detection - NO – disables the sending of alert report based on jitter detection JITTER_WARN [xx] This parameter is the threshold to send a report on Inter-arrival Jitter greater than [xx]. 1 second is broken up into 65535 (0xffff hex) parts. [xx] / 65535 is the threshold in seconds. The default is 3276 (50 ms). Using 0 resets the threshold to default.
Configure the provisioning server - YES – enables periodic VQMon session reports. - NO – disables periodic VQMon session reports. SESSION_RPT_INT [xx] This parameter specifies the interval for the periodic VQMon session report in seconds. The minimum acceptable value is 60 seconds. The maximum acceptable value is 600 seconds. The default is 60 seconds. xx – is an INTEGER value in seconds.
Phone recovery command Phone recovery command RECOVERY_LEVEL [x] This parameter controls the phone recovery if the phone hits any Major or Critical error. Following values are used for setting the recovery level on the phone: - 0 - Phone never recovers from any error - 1 - Phone recovers from Major error - 2 - Phone recovers from Major and Critical errors Default is 255, which is equivalent to the recovery level of 2.
Configure the provisioning server AUTOLOGIN_AUTHID_KEY [xx] This parameter specifies the authentication name to be used for a specific key. Create the Dialing Plan file on the provisioning server If the IP Deskphone encounters a [DIALING_PLAN] section while parsing the 11xxeSIP.cfg configuration file, the IP Deskphone downloads the specified dialing plan configuration file. A dialing plan essentially describes the number and pattern of digits that a user dials to reach a particular telephone number.
Create the Dialing Plan file on the provisioning server An example of a dialing plan is provided below.
Configure the provisioning server Dialing function description Dialing plan If the IP Deskphone encounters a [DIALING_PLAN] section while parsing the 11xxeSIP.cfg configuration file, the IP Deskphone downloads the specified dialing plan configuration file. As most phone 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.
DRegex $4="com" $5="Avaya.com" $t=10000 (default timer is 10 seconds) $a=Avaya.com The second section of dialing plan contains the digit map. The digit map section has three subsections that are divided by a separator of two ampersands (&&). Figure 7: 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.
Configure the provisioning server Figure 8: DRegex rules Downloadable WAV files If the IP Deskphone encounters a [TONES] section while parsing the 11xxeSIP.cfg file, the IP Deskphone downloads the specified tones configuration file. 90 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
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.
Configure the provisioning server 92 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 7: Configure the DHCP Server The DHCP server requires special configuration in Full DHCP mode. The IP Deskphone with SIP Software obtains Device Settings parameters from specially-configured DHCP servers.
Configure the DHCP Server The unique DHCP configuration is required to allow the DHCP server to respond with a unique Option 66 parameter to the IP Deskphone with SIP Software. Note: The DHCP standard defines Option 66 as the bootp server address in a string. The meaning of the bootp server address is extended in Avaya IP Deskphone with SIP Software to include the provisioning server address.
DHCP VLAN Auto Discovery Parameter requested by the IP Deskphone Description DHCP server option Lease time Implementation varies according to DHCP server. 51 Renewal time Implementation varies according to DHCP server. 58 Rebinding interval Implementation varies according to DHCP server. 59 Provisioning server Used for delivering the 66 provisioning server IP address. This parameter can contain either IP address or a URL to the provisioning server or folder.
Configure the DHCP Server After multiple VLAN IDs are returned from the DHCP server, the IP Deskphone tries to connect to each of the VLANs, following the order in which VLAN IDs are specified in the DHCP option. The format of the field for DHCP VLAN Auto Discovery is: Type, length, and data, described in the following sections. Type (1 octet) To avoid the possibility of option types already being used by different vendors, there are fourteen options types supported by the IP Deskphone.
Chapter 8: Install the IP Deskphone Complete instructions to install the IP Deskphone, including detailed figures and applicable warnings, are given in the IP Deskphones User Guides. The steps for installing the IP Deskphone are summarized in the following procedure. Installing the IP Deskphone 1. Remove the stand cover. Pull upward on the center catch and remove the stand cover. The cable routing tracks are now accessible. 2. Connect the AC power adapter (optional).
Install the IP Deskphone tilt lever and continue to push the IP Deskphone towards the base until an audible click is heard. Ensure the IP Deskphone is securely locked in position. The following figure shows the connections on the IP Deskphone. Figure 9: IP Deskphone connections 98 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 9: Upgrade and convert the IP Deskphone software This chapter describes how to upgrade an IP Deskphone with UNIStim software to SIP Software. In order to upgrade an IP Deskphone with UNIStim software, first determine if you have the minimum UNIStim software release on the IP Deskphone (0625C39). If your IP Deskphone is installed with the minimum version of UNIStim software, proceed to the section Convert UNIStim software to SIP Software on the IP Deskphone on page 105.
Upgrade and convert the IP Deskphone software Modify the SIP provisioning file Use the following procedure to modify the SIP provisioning file, which exists on the provisioning server. Modifying the SIP provisioning file 1. Under the firmware [FW] section of the SIP Provisioning file, increase the VERSION number (for example SIP1140e03.02.16.00). 2. Under the firmware [FW] section of the SIP Provisioning file, modify the FILENAME of the new file you want to upload to the IP Deskphone. 3.
Upgrade to the minimum UNIStim Software • Avaya banner appears Following the Avaya banner, the software version appears in the display (F/W version). 2. Note the UNIStim software version number and write it down. Compare the version number to the minimum-required UNIStim software version (0625C39). UNIStim software version names contain numbers and letters.
Upgrade and convert the IP Deskphone software Key Action Left Closes menu Select key (center of cluster) Selects current menu item To close this menu, use the Quit key. 2. Select 2. Local Diagnostics in the Local Tools menu by pressing the key in the Navigation key cluster or by pressing the number 2. 3. Select IP Set and DHCP Information by pressing the Select key in the Navigation key cluster or by pressing the number . 4.
Upgrade to the minimum UNIStim Software Configuring the TFTP server 1. The IP Deskphone always executes the TFTP download at bootup if a TFTP IP address is configured on the IP Deskphone after being initiated by the telephony Call Server. 2. Go to the TFTP server and create the 11xxe.cfg provisioning file. The 11xxe.cfg provisioning file is a clear text file. Create the provisioning file as shown in the next table. Table 9: Sample 11xxe.
Upgrade and convert the IP Deskphone software After the software image is downloaded to the IP Deskphone, the display shows [FW] finished..., the blue LED stops flashing, and the IP Deskphone resets. The IP Deskphone registers to the TPS with the new software version. If the upgrade is unsuccessful, see the chapterDiagnostics and troubleshooting on page 293 in the section Download failures.
Convert UNIStim software to SIP Software on the IP Deskphone If the upgrade is unsuccessful, see the chapter Diagnostics and troubleshooting on page 293 in the section titled Download failures. Convert UNIStim software to SIP Software on the IP Deskphone The IP Deskphone can be ordered with UNIStim software installed or with SIP Software installed. If an IP Deskphone is installed with UNIStim software, it runs with SIP Software only if the software is converted from UNIStim to SIP.
Upgrade and convert the IP Deskphone software Perform the following procedure to convert the UNIStim software to SIP Software on the IP Deskphone. Converting UNIStim software to SIP Software using TFTP 1. Run the TFTP server (for example Tftpd32.exe). 2. Place software and configuration files in the folder of the TFTP server (for example 11xxe.img F/W file and 11xxe.cfg file) that contains the following lines: Table 11: Sample 11xxe.cfg configuration file [FW] DOWNLOAD_MODE AUTO VERSION 06C25D26.
Convert SIP Software to UNIStim 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. Determine the appropriate UNIStim version to match the hardware release number of your IP Deskphone. There are different versions of UNIStim software available for download. Which version you choose depends on the hardware release number of your particular IP Deskphone.
Upgrade and convert the IP Deskphone software 108 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 10: Provisioning the IP Deskphones The IP Deskphones support the following provisioning modes: • Manual provisioning • Automatic provisioning Manual provisioning The manual provisioning of IP Deskphone parameters overrides the configuration of parameters by any other provisioning source. Technicians can use manual provisioning to override system wide parameters for troubleshooting purposes or to provide special needs configurations for a small group of users.
Provisioning the IP Deskphones Configuration You can store common provisioning parameters in a managed central server, such as a DHCP,TFTP, or HTTP server. You can configure the IP Deskphone to automatically or manually obtain the provisioning parameters from the various provisioning sources. For automatic provisioning, the IP Deskphone receives the parameters from the provisioning server. You can switch between automatic provisioning to manual provisioning on the Auto Provisioning page.
Configuring parameters manually for the IP Deskphone Figure 10: Network menu The Configuration page appears when you select the Device Settings menu item. Any automatic provisioned parameters appear dimmed. The Device Settings menu shows the configuration parameters that are configured as Manual on the Auto Provisioning page. Use the Up and Down navigation keys to scroll through the main configuration options and the Right or Left navigation keys to scroll through the sub configuration options.
Provisioning the IP Deskphones • Press the AllMan soft key to change all parameters to be manually provisioned. • Use the dial pad to enter the number associated with the parameter, or use the navigation keys to scroll and highlight the specific parameter (up/down navigation takes you from group to group, while left/right navigation takes you from item to item). Press the Enter key to check the parameter, making it "Manual" provisioned. 3.
Auto Provisioning parameters Table 12: Keys and descriptions Key Description [] Check box, select or clear: Auto-checked, Manual-unchecked. Dial pad Enter number of index to jump to option Up Move up a group index Down Move down a group index Right Go to next item. Left Go to previous item. Enter Select or clear the check box for item or group. Config Return to manual configuration page. AllMan / AllAut Context-sensitive.
Provisioning the IP Deskphones STUN S1 IP [] STUN S2 IP [] Media Security [] SIP UDP Port [] SIP TCP Port [] SIP TLS Port [] Connection Timers [] Keep-Alive [] Register Retry [] Register Max Retry [] Login Notify [] Enable Bluetooth (1120E/1140 only) [ ] SSH-SFTP [] Enable SSH [] UserID [ ] Password [] Enable SFTP [] Enable FIPS [] Manual provisioning parameters Use the Device Settings menu to manually provision the IP Deskphones. Double-press the Services key.
Manual provisioning parameters Key Description Cancel Exit Device Settings without saving changes. In edit mode Up Scroll dialog up (highlight does not move). DownScroll dialog down (highlight does not move) Exits Edit mode, moves highlight up an item. Left Moves edit cursor to the left. Right Moves edit cursor to the right. Enter Exit edit mode. OK Exit edit mode. BkSpc Backspace: delete highlighted characters or character to the left Clear Clear input field.
Provisioning the IP Deskphones Config option Options or input Description TLS TLS encryption. ID 1 4 to 8 characters EAP ID. ID 2 4 to 8 characters EAP ID. Password 4 to 12 characters EAP password. Enable 802.1ab (LLDP) Checked LLDP enabled. Unchecked LLDP disabled. Checked IPv4 and IPv6 enabled (dualmode). Unchecked IPv6 disabled. Yes DHCP used. No Static IP and config used. IP address IPv4 and IPv6 IP address.
Manual provisioning parameters Config option Options or input Description Note: Maximum of 2 SIP proxy IP addresses per domain can be configured. CA Server IP address Certificate Server IP address. Domain Name 4 to 12 characters IP Deskphone domain name. Hostname 4 to 12 characters IP Deskphone host name. Ntwk Port Speed Auto Auto sense. 10BT Forced 10BT. 100BT Forced 100BT. Auto Auto negotiate. Force Full Forced full duplex. Force Half Forced half duplex. Checked 802.
Provisioning the IP Deskphones Config option Voice Control pBits Voice Media pBits Options or input Description Auto Use value from received LLDP Network Policy TLV, SIP, or default value of 1. 0 to 7 Force signalling related priority bits to chosen value. Auto Use value from received LLDP Network Policy TLV, SIP, or default value of 1. 0 to 7 Force media related priority bits to chosen value. Checked Enable automatic QoS provisioning by Avaya applications.
Manual provisioning parameters Config option Options or input Description forwards to the IP Deskphone PC port. Cached IP Ignore GARP Provisioning Unchecked Leave 802.1Q header on packets destined to the PC port. Checked Last IP Deskphone IP address info received is used if DHCP server not reached. Unchecked Must receive response to assign IP Deskphone IP address. Checked IP Deskphone ignores Gratuitous ARP requests. Unchecked IP Deskphone responds to Gratuitous ARP requests.
Provisioning the IP Deskphones Config option Options or input Description Note: Maximum of 1 PVQM server can be configured. NAT Traversal NAT Signal • None • STUN NAT Media • None NAT method for SIP signaling. Note: IPv4 mode only (IPv6 disabled). NAT method for media signaling. • STUN NAT TTL (sec) Value from 0 to 65535. STUN S1 IP IP address IP address of STUN S1 device. STUN S2 IP IP address IP address of STUN S2 device. Media Security Enable SRTP SRTP enabled.
Manual provisioning parameters Config option Options or input Description Failure Both Login Notify With Time Checked Unchecked Configuration values for login banner with time notification. Enable Bluetooth (1120E/ 1140 only) Checked Bluetooth is enabled. Unchecked Bluetooth is disabled. SSH-SFTP Checked SSH-SFTP is enabled. Unchecked SSH-SFTP is disabled. Checked SSH is enabled. Unchecked SSH is disabled.
Provisioning the IP Deskphones 122 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 11: Features This section describes the features that are supported on the IP Deskphone. Voice Quality Monitoring Feature overview Proactive Voice Quality Monitoring (PVQMon or VQMon) allows the IP Deskphone with SIP Software to report voice quality statistics to a server in the network. 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.
Features Server set-up The IP Deskphone with SIP Software works with Telchemy server software. The name of the software is SQmediator and is available through Telchemy (http://www.telchemy.com). The minimum version required is release 1.0. How VQMon works The IP Deskphone with SIP Software gathers statistics about the current call when VQMon is enabled. Statistics are also gathered regarding the quality metrics of the current call.
Voice Quality Monitoring Metric Description 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. MOS_LQ The VQMon listening quality MOS score calculated for a call channel.
Features 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 The Multiuser feature for CS 1000 requires that PROMPT_ENABLE_YES is configured to YES in the device configuration file. This prompts the end user to enter an authentication ID that is different from the login ID. An example of configuring SIP IP Deskphones to register with multiple users to 1 TN for Communication Server (CS) 1000 is provided below. Important: It is mandatory that you include the @domain.com in the LOGINID. AUTOLOGIN_ENABLE USE_AUTOLOGIN_ID AUTOLOGIN_ID_KEY01 2257@avaya.
Features 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. Figure 12: Example of secondary logon screens You can specify a Line Key for a new account. By default, the IP Deskphone selects the first unused key.
Multiuser Logging off The Logout command in the System submenu, prompts you to select an account, asks for confirmation, and then proceeds to log off the account. Logging off an account frees the corresponding Line key and does not require a password. Figure 13: Example of log off screens Primary account logout Logging off the primary account causes all other accounts to log off automatically and the IP Deskphone to display the logon screen.
Features Server failover If the connection to your account proxy is lost, the IP Deskphone notifies your account and periodically attempts to reconnect. Some features, such as incoming calls, remain accessible for other accounts, but other features are not available until connection is reestablished or you cancel the reconnection. Cancelling the connection to your account is the same as logging off. If you are using the primary account, the IP Deskphone returns you to the initial logon screen.
Multiuser Figure 14: IP Deskphone with Expansion Module and multiple accounts Pressing a line key brings up a dialing prompt, initiates a call to a preselected target, or answers an incoming call. See Making a call on page 131. At select account prompts, such as the Logout screen or User Settings screen, pressing a line key highlights the corresponding account. See Account selection on page 140. The icon for each line key reflects the state of the account associated with that line key.
Features • the caller the target sees is calling • the service-package-dependent features that are available Receiving a call When you receive an incoming call, the account that the call is intended for is displayed on the IP Deskphone. The line key of that account displays the icon for an incoming call. You cannot use a different account to answer the call. If you are receiving multiple calls at the same time, a list of all active and incoming calls appears.
Multiuser Figure 15: Example of the IP Deskphone with one call The following figure is an example of the IP Deskphone with multiple calls. Figure 16: Example of the IP Deskphone with multiple calls Instant messages You can only receive or send instant messages from the primary account. Incoming messages for secondary accounts are rejected, are not displayed on the screen, and are not added to the instant message logs.
Features Modifying settings Preferences, such as Voice Mail and IM settings, are available for each account. The main Preferences menu includes a User Settings entry. If you select User Settings, you are prompted to select a registered account. After you select a registered account, a menu appears that lets you modify the settings of the account you selected.
Multiuser Remembering settings after logout The IP Deskphone remembers up to 24 sets of configurations for each profile. If you configure settings for an account and you log off the account, the settings are restored after you log back onto the account (as either a primary account or a secondary account). If you log on an account that you did not save the settings in a profile for, the IP Deskphone creates a new set of default settings for that account.
Features Figure 17: 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 based 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. You can only monitor and view the presence information of Friends of the primary account in the Friends view.
Features 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. Call Forwarding After you select the Call Forward command from the Services menu, the IP Deskphone prompts you to specify the account that you want to place in Call Forward mode.
Multiuser 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. Presence After you select the Presence command from the Services menu, you are prompted to specify which presence state of the account you want to modify. The all option lets you set all accounts to the same presence in one operation.
Features 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. The following figure is an example of an account notification.
Multiple Appearance Directory Number 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. See Configuration files on page 141. Configuration files You can configure the parameter, MAX_LOGINS in the device configuration file.
Features The Multiple Appearance Directory Number (MADN) feature allows a Directory Number (DN) to appear on more than one IP Deskphone with SIP Software. The MADN with Single Call Arrangement (SCA) feature allows multiple IP Deskphones to appear as a single line to a caller. Any one of the IP Deskphone phones in a group with MADN can initiate or answer a call, but only one call can be active at any given time.
Speed Dial List It is possible to display all of the screensaver images that have been uploaded into the IP Deskphone in a slideshow format, whereby an image displays momentarily and then the next image displays. Different groups can of images can display independently. In order for this feature to work the files must be named with the following syntax ss [x] [image_name].png , where x specifies the number of the slide group and image_name specifies the name of the image. For example: • ss01clouds.
Features Invocation of the Speed Dial List is similar to any other feature key invocation. The Speed Dial List key causes a full screen list to appear on the IP Deskphone and the user can automatically dial one of the offered choices. 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.
Speed Dial List Figure 19: 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 17: 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.
Roaming profiles 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 addressbook=abook.txt customkeys=keys.txt speeddiallist=sdl.txt For more information about the device configuration file, see Feature configuration commands on page 46. Address book file The Address book file represents each contact [contact] and each group [group] (name only). A contact provides attributes to specify nickname, SIP address, group and whether it is a friend. An example of the syntax is provided below: [version] id=12345 [contact] nickname=lpg address=lpg@macadamian.
Roaming profiles • retrieve – for spdial key. Optional. This key is configured to Yes, the autoretrieve mode is enabled. • state – for presence keys. Mandatory. The state to apply when the key is pressed; CONNECTED or UNAVAILABLE. • note – for presence keys. Optional. The note to configure when the presence is changed; arbitrary text. An example of the syntax is provided below: [key] index=2 label=label1 target=lpgp@macmcs.madadamian.
Features • Changes made on the IP Deskphone cannot be uploaded to the Call Server. • The user cannot edit the downloaded Speed Dial List. • Profiles are downloaded for the primary user only. • If a file is downloaded that places a custom key on a key that is already in use as a user’s login Line key, the Line key takes precedence. The custom key is restored if the user logs off.
Customizable banner for login Figure 22: Login Banner The following table describes the function of the context-sensitive soft key for the Login Banner screen. Table 19: 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.
Features Key or action Result Services Press once, no action. Press twice invokes the Network menu. Quit No action. Headset Brings up the dial prompt (in case the user wants to place an emergency call). Hold No action. Dialpad No action. Handsfree Brings up the dial prompt (in case the user wants to place an emergency call). Off Hook Brings up the dial prompt (in case the user wants to place an emergency call). Mute No action. Volume up and volume down No action.
Busy Lamp Field Busy Lamp Field The Busy Lamp Field (BLF) is an alternate presence monitoring mechanism for the IP Deskphone that allows presence functionality on proxies supporting BLF, such as SCS proxy. The IP Deskphone subscribes to receive presence information for watched users through notifications. The BLF mechanism allows the user to subscribe to the proxy and receive the presence state list for all the users it is configured to watch.
Features Important: Only one USB headset and USB memory stick are supported. Both narrow band and wideband audio are supported. Important: During software upgrade, the IP Deskphone goes into the Do Not Disturb (DND). The IP Deskphone cannot receive any incoming calls, or make outgoing calls, until the software upgrade is complete and the IP Deskphone restarts. USB port behavior By default, the Avaya 1100 Series IP Deskphone starts with the USB port and all the supported USB devices enabled.
Universal Serial Bus Device support Commands Parameters Remarks other USB device configuration commands are ignored. USB_MOUSE [LOCK|UNLOCK] — USB_KEYBOARD [LOCK|UNLOCK] — USB_HEADSET [LOCK|UNLOCK} — USB_MEMORY_STICK [LOCK|UNLOCK] — To manually override the USB device setting on a particular IP Deskphone, in the USB Lock menu, use the USB_LOCK_OVERRIDE command.
Features Figure 24: USB Devices information screen — USB Port disabled If the USB Port is enabled, the USB Devices screen displays information on all USB devices attached, even if the device is locked. USB enumeration is independent of the device driver status. An unsupported device can still be enumerated if it is attached to the IP Deskphone. To ensure that the user is aware of the USB lock status, the USB device information is followed by status information on supported devices.
Universal Serial Bus Device support USB lock Although the USB port allows the IP Deskphone to extend peripheral support without hardware changes, the customer is required to lock the USB port in compliance with the corporate security policy. The lock can be applied on the USB port to disable all USB devices, or it can be applied on individual types of USB devices. USB Locks preference menu You can override the system configurations on the IP Deskphone through the USB Locks screen.
Features Table 23: USB Locks screen options USB Locks options USB Locks Override Description • Enables or disables the USB lock configurations from the device configuration file. • If USB Locks Override is not checked, the remaining items on the list appear dimmed and the configurations from the device configuration file are used.
Universal Serial Bus Device support Important: Although a locked USB device is not functional, it still appears in the USB menu. The following table describes the function of the Context-sensitive soft keys for the USB Locks screen. Table 24: Context-sensitive soft keys for the USB Locks screen Context-sensitive soft key Apply Action Applies and saves changes; quits the USB Locks screen and returns you to the previous screen.
Features Figure 27: Warning screen USB flash drive SIP Software supports a standard USB flash drive for the IP Deskphone. File system support is restricted to FAT file system with a long file name (Microsoft VFAT). The file system supports a USB memory stick with 8G or less. USB headsets USB headsets are supported Avaya IP Deskphone 1100 Series IP Deskphones. The Avaya IP Deskphone 1100 Series IP Deskphones support Wideband audio on USB headsets. Note: Both narrowband and Wideband audio are supported.
Hotline service Important: You cannot place calls if the server is unavailable during an upgrade. Making a Hotline call A call to a Hotline target is automatically placed when an off-hook condition occurs, or when you press digits during idle on-hook, and then lift the handset. Hotline Service allows only one hotline user to login to the Hotline Phone. The Multiuser Login feature is restricted to one user only.
Features Service Package You can turn Hotline Service, on or off, through the Service Package or the device configuration file. If the Hotline Service Enable parameter from the service package is configured as true, the Hotline Service is enabled (available) from the service package. Device configuration file The IP Deskphone uses the configuration parameters for the Hotline Service to indicate if Hotline Service is available and if a hotline call is in progress.
Session Timer Service The Session Timer Service contains the following elements: • Session-Expires header • Min-SE header • response message (422—Session interval too small) • tag (timer) for existing headers The SIP IP Deskphone generates, processes and handles the SIP messages that include the preceding elements. Session-Expires header The SIP Session-Expires header delivers the Session-Expires interval and provides information about the entity performing the refreshes.
Features Parameter name Description Default value Timer Service for the IP Deskphone is enabled, and the behavior of the IP Deskphone complies with RFC4028. If configured as No, the Session Timer Service is disabled. SESSION_TIMER_DEFAULT_SE Indicates the default session 1800 expiration in seconds.
Emergency Services You can use the Avaya 1100 Series IP Deskphone to make an emergency call to the Public Safety Answering Point (PSAP), from any screen, without a user being logged on. When you connect to the PSAP, the IP Deskphone conveys the caller’s location information to the PSAP, if the network supports this feature.
Features happens. The call is still connected and can only be disconnected by the emergency operator. Emergency calls originate on the IP Deskphone and are completed by the Call Server. The Call Server communicates with the emergency network or emergency systems for routing, call control, and location information. Although the IP Deskphone allows the user to enter location information, this location information is not used by all Call Servers.
Emergency Services 1. The first part contains one or more patterns. The patterns are used to match against the dialed number. Multiple patterns are separated by the | character. 2. The second part contains the resulting string used in the dial step. 3. The third part defines the parameters used by the UA to trigger specific dialing actions. The following parameters are defined in the third part and are separated by the | character if both are used.
Features configured with the same password, otherwise the emergency call fails. E911_TXLOC The variable that describes location information that must be sent with the REGISTER SIP message, or with the INVITE SIP message. Important: You must add a set of numbers (regular expressions) marked as "emergency" to the IP Deskphone dialing plan. Only these numbers are allowed for emergency calls that do not require logon.
Emergency Services • You can only dial these numbers if there is no user log on (or the IP Deskphone is blocked). • You must add the emergency number to the dialing plan. The emergency flag is mandatory. For more information on the format for dialing plan rules, see Dialing plan configuration on page 166. 4. Configuring the domain list and proxy. • You must properly configure the domain list, and the active proxy must be correct, valid, and support current features.
Features • the increase and decrease volume keys remain functional. • the feature keys are visible and all except the speed-dial keys are functional. 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.
Three-port switch and VLAN functionality must support RFC3581. This feature is enabled or disabled through the USE_RPORT parameter in the device configuration file. Note: RFC3581 does not address NAT traversal for media or voice. Three-port switch and VLAN functionality System overview The Full VLAN support feature can create telephone Voice-VLAN and PC Data-VLAN on the three-port switch of the IP Deskphone manually and automatically (see Figure 28: Voice-VLAN and Data VLAN on page 172).
Features Figure 28: Voice-VLAN and Data VLAN Table 28: Port functions on the three-port switch when VLAN is enabled Ports 172 Voice VLAN enabled Data VLAN enabled Both Voice and Data VLAN enabled Network Port (Port 0) N/A N/A N/A 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.
802.1x (EAP) Port-based network access control Ports Voice VLAN enabled Data VLAN enabled Both Voice and Data VLAN enabled Replacing the incoming frame tagged with VLAN other than DataVLAN and forwarding it to network port. Sending all kinds of frames. other than Data-VLAN and forwarding it to network port. Sending all kinds of frames. VLAN configuration can be done either manually or through DHCP. See Provisioning IP Deskphone parameters on page 110 for more detail on configuring VLANs. 802.
Features • When EAP-TLS is selected, the administrator is prompted to enter ID1. • When Disabled mode is selected, the existing IDs and Passwords are erased. Authorization If 802.1x is configured and the IP Deskphone is physically connected to the network, the IP Deskphone (supplicant) initiates 802.1x authentication by contacting the Layer 2/3 switch (authenticator). The IP Deskphone also initiates 802.
802.1ab Link Layer Discovery Protocol 802.1ab Link Layer Discovery Protocol (LLDP) provides the following functionality: • Periodic transmission of advertisements containing device information, device capabilities, and media specific configuration information to neighbors attached to the same network. • Reception of LLDP advertisements from its neighbors. • Implementation of behavioral requirements specified by Link Layer Discovery Protocol Media Endpoint Discovery (LLDP-MED).
Features 19. Inventory Software Revision 20. Inventory Manufacturer Name 21. Inventory Model Name Receive direction The IP Deskphone expects to receive the following TLVs: 1. Chassis ID 2. Port ID 3. Time To Live 4. End of LLDPPDU 5. System Capabilities 6. VLAN Name 7. MAC/PHY Configuration Status 8. LLDP-MED Capabilities 9. Network Policy 10.
802.1ab Link Layer Discovery Protocol TLV Fields If you disable the PC Ethernet port, the advertised enabled capabilities configured to Telephone only. Port VLAN ID PVID = 0 The IP Deskphone does not support port-based VLAN operation. Port And Protocol PPVID = 0 VLAN ID Port and Protocol VLAN is not supported and not enabled. VLAN Name Protocol Identity VLAN name field is configured to “data” and “voice”. 1. STP: Protocol identity = the first 8 bytes of an STP PDU starting with the Ethertype field.
Features TLV Fields Link Aggregation Aggregation status = 0; the link is not capable of being aggregated, and currently is not in aggregation. Aggregated Port ID = 0 Maximum frame size The MAC/PHY supports an extension of the basic MAC frame format for Tagged MAC frames. The maximum frame size is configured to 1522.
PC Client Softphone interworking PC Client Softphone interworking The interworking feature allows the user to access the functionality of the SIP Avaya 1110 Series IP Deskphone using a softphone client on their PC. On an incoming call, both the IP Deskphone and the PC Client Softphone ring.
Features The Answer-Mode Settings screen has the following two independent configurations: • Allow Mode: [Current Setting] • Allow Addresses For the Allow Mode option, the current setting can be one of the following choices: • Disabled • Friends • Directory—includes all Friends • Public—includes all users For the Allow Addresses option, the user can edit a listing by adding domain names or SIP addresses up to a maximum defined in the device configuration.
PC Client Softphone interworking Figure 30: Allow-Mode Settings screen Allow Addresses screen The Allow Addresses screen is used to pre-grant authorization to request an automatic answer to a list of user-entered domains and SIP addresses. If the user selects the Allow Addresses option in the Answer-Mode Settings screen, the user is presented with an interface for entering a list of strings.
Features 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 Allow Addresses. If there are no domains in the list, the following screen appears.
Multi-Level Precedence and Preemption A "ring splash", or short ring tone, indicates to the user that the call was automatically answered. The subject is "Auto-Answered", and the microphone is muted (the user can deactivate the mute status by pressing the Mute key on the IP Deskphone). The following image is an example of a notification indicating an auto-answered call.
Features server. For information on configuring the MLPP service, see Avaya Aura ™ Application Server 5300 Using the Provisioning Client (NN42040-112). To enable MLPP, DOD_ENABLE must be configured as YES in the device configuration file. Precedence Precedence enables an IP Deskphone user to specify the precedence level of each call that is placed.
Multi-Level Precedence and Preemption The following is the order of call preemption: 1. The lowest precedence call 2. If there are multiple calls on the same precedence level, then the following order is used a. Any outgoing call that is unanswered b. the oldest incoming call that is unanswered c. the oldest held call Call Origination Busy When Call Origination Busy is enabled, incoming calls are prevented from disturbing the IP Deskphone user when in the process of making an outbound call.
Features . To answer any call except from Emergency 911, the user must go off-hook. MLPP tones Unique tones are played when MLPP is enabled. Precedence Ringback Tone: A precedence ringback tone is played when the calling party makes a precedence call. This tone is only played after the call has been confirmed by the server. Precedence alerting tone: A precedence alerting tone is played to alert the called party that a precedence call is arriving. This tone is delivered through the speaker.
Multi-Level Precedence and Preemption Feature Interaction with MLPP Do Not Disturb Incoming call with a Routine precedence level is rejected when Do Not Disturb is enabled on the IP Deskphone. Incoming call with a precedence level higher than Routine is presented even when Do Not Disturb is enabled on the IP Deskphone. Multiuser When MLPP is enabled, only one user can be logged on to the IP Deskphone. If an MLPP user is logged on to the IP Deskphone, other user logons are blocked.
Features Parameter 188 Description Default MLPP_PRECEDENCE_DOMAIN [x] The local precedence domain of the user to be added to the INVITE message of outgoing calls. 000000 MAX_APPEARANCE [x] The maximum number of call appearances a single user can have. 2 CALL_WAITING_TONE [0|1] Configures the call waiting tone. 0 – single buzz tone 1 – periodic two-beep tone. 0 DISABLE_SPKRPHN [YES | NO] Disables the speakerphone for all non-911 calls.
Chapter 12: IP Deskphone restrictions Service package restrictions A limited number of Call Servers support the service package. The service package is a means of providing configuration settings to the IP Deskphone. Individual features and feature restrictions are sent to the IP Deskphone as a part of the service package every time a particular user logs on to the IP Deskphone.
IP Deskphone restrictions 190 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 13: 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 Avaya 1100 Series 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 Parameter Password Description Default value The password None that must be entered when connecting to the IP Deskphone through SSH, SFTP. Boundaries Non-null string Maximum: 49 characters UI Properties for Device Settings SSH and SFTP parameters are as follows: • The User ID field is empty and the Password field displays "****" when both SSH and SFTP are disabled and applied. • The user can enable SSH or SFTP.
Security How the IP Deskphone uses TLS Transport Level Security (TLS) is a protocol for establishing a secure connection between two end-points. After a connection is established using TCP, TLS negotiates the cryptographic parameters used to secure the traffic that is sent over that connection. TLS, Public Key Cryptography, and X.509 certificates provide either mutual or server authentication.
TCP/TLS operation overview Certificate requirements For the IP Deskphone to validate that the server certificate provided by the TLS-enabled proxy matches the connected address, the certificate must contain the IP Addresses of the IP Deskphone. The server certificate has a Subject Alternative Name field, which contains the IPv4 and IPv6 IP addresses that correspond with the proxy. For example: subjectAltName=IP:192.168.100.
Security Parameter Purpose Default Allowed SERVER_TLS_POR T1_1 SERVER_TLS_POR T1_2 SERVER_TLS_POR T2_1 SERVER_TLS_POR T2_2 SERVER_TLS_POR T3_1 SERVER_TLS_POR T3_2 SERVER_TLS_POR T4_1 SERVER_TLS_POR T4_2 SERVER_TLS_POR T5_1 SERVER_TLS_POR T5_2 196 SIP_UDP_PORT SIP_TCP_PORT SIP_TLS_PORT Configures the local UDP: 5060 SIP listening ports.
TCP/TLS operation overview Parameter Purpose Default LOGIN_NOTIFY_TI ME Configures whether or not the time at which the login success or failure occurred appears. SSH Configuration of the NO SSH server on the IP Deskphone. The parameter must remain consistent with the current UNIStim design. YES, NO SFTP Configuration of the SFTP server on the IP Deskphone. The parameter must be added, but can remain consistent with SSH.
Security Parameter Purpose Default Allowed HASH_ALGORITHM Hash algorithm. SHA1 SHA1, MD5 MKI_ENABLE NO YES, NO Use Master Key Identifier (MKI) or not. ADMIN_UI_ENABLE Configure the YES availability of the local administration User Interface on the IP Deskphone.
TCP/TLS operation overview Note: SFTP writes can only be made to the sftpWr folder. You are only allowed to write a file that is 10%, or less, of the available space on the folder.If a file size greater than 10% is written, a write failure occurs, and the system logs the following event:1042[Minor][TUE JAN 02 19:08:18 2007][353][i:/fw/build/../util/sshapp/sftpS erver.c:691] File (./sftpWr/lf.wrl) too large to write.
Security Table 31: Listening port parameters Parameter name Description Default value Boundaries SIP UDP Port The listening port on 5060 the IP Deskphone for incoming UDP requests. Min: 1024 Max: 65535Disabled: 0 SIP TCP Port The listening port on 5060 the IP Deskphone for incoming TCP requests. Min: 1024 Max: 65535Disabled: 0 SIP TLS Port The listening port on 0 the IP Deskphone for incoming TLS requests.
TCP/TLS operation overview Figure 34: Security icon enabled Note: Connecting to the server requires that the IP Deskphone uses, at a minimum, TLS_RSA_WITH_AES_128_CBC_SHA, and as an objective, TLS_RSA_WITH_AES_256_CBC_SHA. Because this is a server-specific configuration, the IP Deskphone must be prepared to handle both. There is no difference in screen indication, regardless of the type of cipher used.
Security Unsupported configurations cannot be saved. If the configurations are unsupported, the IP Deskphone displays an error message. The following is an example of an error message for unsupported configurations:Unsupported: UDP + TLSUnsupported: No protocols enabled. Registration behavior based on configuration settings The following table describes the behavior of the IP Deskphone when the IP Deskphone is configured to communicate with a server using specific protocols.
TCP/TLS operation overview Configura tion Description Expected result Possible results e: TLS only Server: UDP + TCP + TLS sending requests to the server. The IP Deskphone must have a device certificate installed if the server is configured for mutual authentication. TLS. If a device certificate is provisioned, and the server is configured for mutual authentication, then the IP Deskphone provides a certificate during the TLS handshake. Otherwise, server-only authentication is used.
Security Note: The server must be configured with the appropriate protocols enabled for the success condition to be realized. Failure results are possible if the server configuration is changed to disallow protocols. Managing connection persistence The IP Deskphone attempts to establish and maintain a persistent connection with the proxy when TCP and TLS are active protocols. After this connection is established, the IP Deskphone sends all outgoing connections over this persistent connection.
TCP/TLS operation overview Figure 36: Connection reuse and a firewall Table 33: Connection timers definitions and allowed values Parameter name Description Default value Boundaries OS Keepalive only Selecting this value Not causes the OS TCP checked Keep-alive functions to be used instead of the CRLF ping/pong mechanism.
Security Parameter name Description Default value Boundaries waits for the next registration retry attempt. This value, measured in seconds, is the maximum value that the IP Deskphone waits in between retry attempts SRTP Secure Real-time Transport Protocol (SRTP) encrypts the Real-time Transport Protocol (RTP) traffic between two end-points to achieve full security for the media path.
SRTP Parameter AES_CM_128_HMAC_ SHA1_80 AES_CM_128_HMAC_SHA1_32 SRTCP lifetime 2^31 packets 2^31 packets Cipher AES Counter Mode AES Counter Mode Encryption 128 bits key 128 bits MAC HMAC-SHA1 HMAC-SHA1 SRTP auth. tag 80 bits 32 bits SRTCP auth. tag 80 bits 80 bits SRTP auth. key len. 160 bits 160 bits SRTCP auth. key len. 160 bits 160 bits Call security is identified by the presence of the security icon present during an active call, as shown in the following example.
Security Table 35: Configuration effects on media security display Configuration Result Media Security Icon Display (during active call) Default: UDP + TCP, no SRTP SIP is unsecured; media is unsecured. No UDP + TCP. Best-Effort SRTP SIP is unsecured; media is No encrypted, but due to transmission of crypto parameters in clear text, the media cannot be considered secure.
Last successful or unsuccessful logon The figures shown below provide examples of the IP Deskphone display screen based on the configuration of the IP Deskphone and whether Login Notify is enabled or not. The following notification appears on the display screen when the user login ID or password is incorrect and log in fails. Note: The server recognizes account login failure thresholds. After a configurable number of failures, the server temporarily disallows login attempts for an account.
Security Figure 39: 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. Figure 40: 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. 210 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Last successful or unsuccessful logon Figure 41: 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. Figure 42: 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.
Security Figure 43: Login and login failure with time notification Enhanced administrative password security The provisioning server can provide additional security associated with the administrative password. The provisioning server provides the password to the IP Deskphone in the form of an SHA1 or MD5 hash instead of the plain text password. This removes the need to store the password on the IP Deskphone by using the existing ADMIN_PASSWORD provisioning parameter.
Enhanced administrative password security Password protected screensaver A user-defined password can enable a password protected screensaver on the IP Deskphone. A user-defined password is not secure because the user-defined password does not have any special rules for complexity.
Security 214 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 14: Audio codecs The optional audio codecs feature allows you to select the audio compression or decompression algorithm (codec) used on the IP Deskphone. You provision codecs using the Device Configuration file, and then the user can select from the provisioned codecs using the Audio menu on the IP Deskphone. This feature supports wideband audio performance, where wideband is defined as the frequency range between 150 and 6800 Hz.
Audio codecs Table 37: Static payload types and other parameters for the supported codecs for the IP Deskphone Codec Payload type SDP encoding name Clock rate (HZ) Bit rate (kbps) ptime (milisec) Channels G.711 a-law 8 PCMA 8000 20 1 G.711 u-law 0 PCMU 8000 20 1 G.711 a-law 8 PCMA 8000 30 1 G.711 u-law 0 PCMU 8000 30 1 G.729A + 40ms ptime 18 G729 8000 20 1 G.729B 18 G.722 9 G.723.1 4 G.723.1A 4 8000 8 20 1 G722 8000 48 20 1 G723 8000 5.3 6.
Audio codecs Codecs Description Expanded support of the existing G.729a codec with Annex allows for two byte Silence Insertion Descriptor (SID) frame for CNG. G.711 a-law PCMA G.711 mu-law PCMU G.729 Expanded supported of the existing G.729a codec with AnnexB (G.729b) allows for Comfort Noise Generation (CNG).
Audio codecs Codec Payload type SDP encoding name Clock rate (HZ) Bit rate (kbps) ptime (milisec) Channels 6.3 G.723.1A 4 8000 5.3 6.3 30 1 The annexes selection for G.729 and G.723.1 are not available to the user and the administrator is responsible for enabling or disabling annexes using the Device Configuration parameters.
Codec preference selection on the IP Deskphone If you remove all codecs from the allowed list, the IP Deskphone resets to the default list of codecs. 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.
Audio codecs The following table shows examples of the list of codecs provided by Device Configuration, user configuration, and resulting list of codecs that the system uses for presentation and codec negotiation purposes.
Chapter 15: Certificate-based authentication Certificates based authentication Certificate-based authentication allows the administrator to ensure that the IP Deskphone is authorized to access the enterprise LAN environment and to connect securely to SIP proxy and provisioning servers. Certificates bind an identity to a pair of electronic keys that are used to encrypt and sign digital information, and make it possible to verify someone’s claim that they have the right to use a given key.
Certificate-based authentication mark events, such as Certificate Addition and Deletion. The administrator is to view security and error logs from the user interface, as well. The administrator is able to define the Security policy on the IP Deskphone using Security Policy file. The security policy file contains a set of rules that dictates certificate based authentication on the IP Deskphone, such as the size of the public and private keys used on the certificates.
Trusted root certificate installation must be installed on the IP Deskphone and stored in the IP Deskphone trusted store for the following reasons: • to verify the identity of the various servers that the IP Deskphone can attempt to establish secure connections with, such as TLS and HTTPS • to authenticate the signatures on software and configuration files that are downloaded onto the IP Deskphone.
Certificate-based authentication Note: In the descriptions above, there is reference to the certificate file containing a single customer root certificate. While this is the most common usage, the file can actually contain more than one certificate, where the PEM encoding for each is appended in the file with a blank line between each. If the file’s authenticity is successfully verified, all entities in the file are installed on the IP Deskphone.
Installing a device certificate using PKCS12 The following sections describe the process used to install a device certificate on the IP Deskphone. • 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 [DEV_CERT] section is added to the configuration file 11xxeSIP.cfg to download PKCS#12 file from a provisioning server.
Certificate-based authentication • VERSION attribute determines if the file should be downloaded by comparing this VERSION with the VERSION stored in the corresponding device certificate profile. 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. 3.
Certificate Trust List Validating a certificate using the Certified Trust List The high level sequence of procedures for validating a certificate using the Certificate Trust List is as follows: 1. Create the CTL file including start date, expire date, and a list of certificates concatenated together in PEM format so that the entire file can be signed by a trusted entity.
Certificate-based authentication - the CTL is expired; the CTL is deleted and an event is logged in the security log. 4. After the IP Deskphone starts a TLS channel with a server (EAP or TLS) and receives a server certificate, the IP Deskphone validates the certificate by checking the availability of the certificate in the CTL and decides whether to trust the certificate or not. If the server certificate is not in the CTL, the server certificate is rejected and a TLS channel is not established.
Certificate Trust List events PROTOCOL HTTPS FILENAME ctl.pem.sig The filename attribute points to the signed CTL file. Note: The CTL file size must not exceed 20 Kbytes Certificate Trust List events The following provides a list of events related to the Certificate Trust List (CTL) file. CTL Expiry:0020[Information][WED OCT 26 03:02:54 2011][270][n:/fw/ build/../util/pki/pki_mgmt.c:3726] - CTL Expired.
Certificate-based authentication Figure 44: Diagnostics main menu Certificates Administration main menu The certificates administration screen displays the following options: • Trusted Certificates • Device Certificates • CTL To access the Certificates Administration screen from the Network screen, select Device Settings > Diagnostics > Certificate Administration.
Certificate Administration Table 42: Context-sensitive soft keys for the Certificates Administration screen Context-sensitive soft key Action Select Selects the required option. Back Returns you to the Diagnostics menu. Note: CRL is not supported.
Certificate-based authentication Context-sensitive soft key Action • Expiry Date • Certificate Status (such as OK or Expired) Back Returns you to the previous screen. Figure 47: Trusted Certificates 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 Phone displays a warning confirmation screen.
Certificate Administration Figure 48: Device Certificates screen The administrator can delete the certificate in the details screen by using the Delete contextsensitive soft key. Deletion does not happen automatically; the IP Deskphone displays a warning confirmation screen. The following table describes the function of the context-sensitive soft keys for the Device Certificates screen.
Certificate-based authentication The administrator can delete the certificate in the "Detailed Mode" by using the Delete contextsensitive soft key. Deletion does not happen automatically; the IP Deskphone displays a warning confirmation screen. CTL screen The CTL screen displays a list of subject Common Names (CN) of the CTL certificates as shown in the following figure: Figure 50: CTL certificate screen The following table describes the function of the context-sensitive soft keys for the CTL screen.
Security Policy Figure 51: CTL Certificate details screen You can use the PDT shell command to view an installed CTL. The following is an example command with the output of the command. Figure 52: Example of command output Important: The CTL file size must not exceed 20 Kbytes. Security Policy The security policy file contains a set of rules or parameters that dictate certificate-based authentication on the IP Deskphone.
Certificate-based authentication CERT_ADMIN_UI_ENABLE NOSECURITY_LOG_UI_ENABLE NOKEY_SIZE 1024KEY_ALGORITHM KEY_ALG_RSATLS_CIPHER RSA_WITH _AES_256_CBC_SHA Security policy parameters The security policy file parameters and the excepted and default values are as follows: CERT_ADMIN_UI_ENABLE This parameter determines if the Certificate Administration user interface is enabled on the IP Deskphone.
Security policy parameters - RSA_WITH_AES_128_CBC_SHA - RSA_WITH_AES_256_CBC_SHA (default) SIGN_SIP_CONFIG_FILES This parameter overrides the file signing of a file, such as the device configuration file and the dial plan file. You cannot override the file signing of the Security Policy and Customer Certificates. The acceptable values are as follows: - YES – Signing is required. - NO – No authentication check is performed (default).
Certificate-based authentication Finger Print display with accept or reject options (default). - VAL_MANUAL_B – 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. CERT_EXPIRE This parameter is the Certificate Expiration Policy. Acceptable values for this parameter are as follows: - DELETE_CERT –A certificate is deleted when expired. A security log entry is added.
Installing a Security Policy file SECURITY_POLICY_PARAM_CHANGE This Parameter defines if configuration files (11xxeSIP.cfg) are forced to be signed if there is a customer certificate installed. This parameter has no effect if there are no installed customer certificates. Acceptable values for this parameter are as follows: - YES– If there is a customer certificate installed, the downloaded file must be signed and fully authenticated.
Certificate-based authentication If the authentication of the file is successful, the security policy file parameters is accepted on the IP Deskphone. Example [SEC_POLICY] DOWNLOAD_MODE_FORCED PROTCOL HTTP FILENAME SecPolicy.txt.sig Security policy logs and diagnostics Changes made to the security policy file have an entry in the security log file. For example, SECURITY_POLICY_PARAM_CHANGE 0x1055. The security log file stores only the non-sensitive information.
EAP Authentication Figure 53: 802.1x and EAP network architecture IEEE 802.1x defines three roles: • a supplicant—an entity that requires access to the network for use of its services. • an authenticator—the network entry point to which the supplicant physically connects, typically a Layer 2 switch. The authenticator acts as a proxy between the supplicant and the authentication server and controls the access to the network based on the authentication status of the supplicant.
Certificate-based authentication The administrator can do the following: • When MD5 is selected, the administrator is prompted to enter ID1 and Password. • When PEAP is selected, the administrator is prompted to enter ID1, ID2 and Password. If the administrator enters only ID1, then ID2 has the same value of ID1. • When TLS is selected, the administrator is prompted to enter ID1. Note: Before using EAP-TLS a device certificate must be installed.
EAP Re-authentication IP Deskphone fails to authenticate to the RADIUS server, the IP Deskphone displays a EAP Authenticate-Fail message, and the IP Deskphone cannot access the network. 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.
Certificate-based authentication EAP events EAP Authentication failures are logged using event 1033. An example of a TLS authentication failure is as follows: 1033 [Minor][FRI MAY 15 13:48:06 2009][10223][n:/fw/build/../bsp/ vxWorks/common/dot1x/Supplicant/moceap_tls.c:147] - EAP-TLS Failed to Authenticate Provisioning configuration files download through HTTPS HTTPS can be used to securely download provisioning configuration files on the IP Deskphone using the following process. 1.
Mutual Authentication provisioning server and must be loaded in a secure manner before the IP Deskphone establishes the HTTPS connection with the provisioning server. There is no mechanism for getting a user name and password on the IP Deskphone in a secure "no-touch" manner; the IP Deskphone must be deployed to a secure network where the TFTP download of insecure files is not transmitted over an insecure network.
Certificate-based authentication 1. Security Log 2. Error Log Figure 55: 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 56: Log item screen The following table describes the function of the context-sensitive soft keys for the log item screen. Table 48: Context-sensitive soft keys for the log item screen Context-sensitive soft key Action Next Navigates to the next log entry.
Fault management behavior EAP_MD5_AUTH_FAILURE 0x1030 EAP_INVALID_DEVICE_CERTIFICATE 0x1031EAP_INVALID_ROOT_CERTIFICATE 0x1032EAP_TLS_AUTH_FAILURE 0x1033EAP_PEAP_AUTH_FAILURE 0x1034 The following is a list of certificate-related events and failures logged in the Security Log.
Certificate-based authentication A list of authentication failure messages that appear on the IP Deskphone screen when a failure occurs during the operation of the IP Deskphone is as follows: • EAP Authenticate-Fail – occurs when the IP Deskphone fails to authenticate to an authentication server; the message applies for the three EAP methods: EAP-MD5, EAPPEAP, and EAP-TLS.
File signing Note: The above commands are examples of commands that create the files signing_req.pem, signing_key.pem and signing_cert.pem with 365 days lifespan. You can change these names and the lifespan days. File signing A file is signed by appending a digital signature, which is created using a Signing Certificate.
Certificate-based authentication - o Certificates • • Public Signing Certificate • • Private Key for the Signing Certificate Important: • The signing certificate and associated private key must be exported from the Certificate Management system. Some Certificate Management systems (for example, Microsoft CA Server) restrict the ability to export the private key. You must take care when you generate certificates to ensure that you properly configure the ability to export.
Signing scripts REM Clean up del %tmp_signature_file% You can use other Certificate Management systems if the system includes the ability to generate a detached signature.
Certificate-based authentication 252 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 16: Licensing A license is a "right to use" granted by Avaya, that the customer purchases to enable the features on the IP Deskphone. A license contains at least one entitlement and can contain more than one entitlement. A license usually has an expiry date and is keyed for a specific license server. An entitlement is the most basic component of a license and represents a single instance of a right to a particular feature or capability.
Licensing 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 2. At the bottom of the Web page under Related Links, click KRS Site. The Keycode Retrieval System (KRS) Web page displays. 3.
Characteristics of the licensing framework Figure 57: Licensing framework interactions and components Characteristics of the licensing framework The following list describes the characteristics of the licensing framework on the IP Deskphone. • The embedded server relies on a real time clock to calculate when a token expires • The embedded server (node-locked) enables the license server to execute on the IP Deskphone. The IP Deskphone obtains tokens by calling the server locally.
Licensing • The system ID is the MAC of the IP Deskphone. • • When the IP Deskphone is connected to an Avaya server, the IP Deskphone gets an additional token. License file download Use the following procedure to download the license file from the provisioning or TFTP server. Downloading a license file 1. Configure the IP Deskphone with a provisioning IP address so it can access a provisioning server.
[LICENSING] section downloads the license file, renames the license file as ipclient.lic , and saves the licensing file in the IP Deskphone Security File System (SFS). [LICENSING] section The IP Deskphone config file must include a [LICENSING] section to enable the IP Deskphone to download the licence file. The [LICENSING] section specifies a wild card filename which uses the IP Deskphone MAC address as the filename with the cfg prefix and suffix.
Licensing [LICENSING] VERSION 000001 FILENAME ipctoken*.cfg License information for the IP Deskphone The Licensing information screen provides information on Embedded Mode, status and other licensing information. To access the licensing feature, press the Globe key twice. Select Prefs > Network > Licensing and select 1. Licensing Info. Enter admin password (if prompted). Figure 58: License Info Licensable Features Licensable features are divided into three groups. 1. Basic Feature Set 2.
Licensable Features Basic Features are always enabled on the IP Deskphone. Enabling the Enhanced Feature Set requires an additional token. Enabling the Advanced d Feature Set requires two tokens. When connected to an Avaya Server, the IP Deskphone gets an additional token. This means that the Enhanced Feature Set is available when the IP Deskphone connects to an Avaya Server.
Licensing Figure 60: Licensable features 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.
Node-locked license mode Figure 61: 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.
Licensing Figure 62: 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.
Node-locked license mode Figure 63: 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.
Licensing Figure 64: 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 • Licensed expired • Released Invalid or no license file The following figure is an example of an invalid or no license file. 264 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Evaluation period Figure 65: License information — Invalid or no license file Evaluation period When the IP Deskphone arrives from the fac tory, 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.
Licensing 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.
License expiry warning Figure 67: 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.
Licensing The following figure is an example of a warning window indicating that the evaluation license period is expired. Figure 69: 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 expiry threshold warning Licensing expiry threshold warning When the expiration date of the node-locked licence approaches,, a warning window is displayed on the IP Deskphone.
Licensing • 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, CS 1000, or IP Office) then extended features are available without a token.
Licensed features • DoD Network • FIPS Certified SIP Software for Avaya 1100 Series IP Deskphones-Administration January 2012 271
Licensing 272 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 17: Internet Protocol version 6 Internet Protocol version 6 (IPv6) is a network layer for packet-switched internetworks and is the successor of IPv4. IPv6 provides larger address space, which allows greater flexibility in assigning addresses. The extended address length used within IPv6 eliminates the need to use Network Address Translation to avoid address exhaustion to simplify the aspects of address assignment and renumbering when changing providers.
Internet Protocol version 6 Table 50: Hexadecimal key sequence Key Sequence 0 0 1 1 2 2abc 3 3def 4 4 5 5 6 6 7 7 8 8 9 9 * . The dot (.) is entered by pressing the asterisk (*) twice. Table 51: Alphanumeric key sequence Key 274 Sequence 0 0+=<>$%&@~^ 1 1 _ - . ! : /\ \ ` ? ! ( ) , ; 2 2abcABC 3 3defDEF 4 4ghiGHI 5 5jklJKL 6 6mnoMNO 7 7pqrsPQRS 8 8tuvTUV 9 9wxyzWXYZ * * SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
IPv6 address format IPv6 address format When an IPv6 address is entered different but equivalent formats can be used for the same address. For example, the following addresses are all equivalent: 2001:0db8:0000:0000:0000:0000:1428:57ab 2001:0db8:0000:0000:0000::1428:57ab 2001:0db8:0:0:0:0:1428:57ab 2001:0db8:0:0::1428:57ab 2001:0db8::1428:57ab 2001:db8::1428:57ab Any of the above formats can be entered.
Internet Protocol version 6 IPv6 Stateless address autoconfiguration The IP Deskphone supports stateless address autoconfiguration as defined by RFC 2463 and RFC 2461. Stateless and stateful (DHCPv6) address autoconfiguration can be used simultaneously. For example, the IP Deskphone IP address can be obtained by stateless address autoconfiguration and configuration information can be obtained by stateful (DHCPv6) address autoconfiguration.
Internet Control Message Protocol for IPv6 If the DHCPv6 server is configured with SIP proxy IPv4–mapped address, the IP Deskphone registers with its IPv4 address. If the DHCPv6 server is configured with SIP proxy IPv4-mapped and IPv6 addresses, the DHCPv6 client calls the destination address selection algorithm and select the address based on the configured preference. If PREFER_IPV6 is configured to YES, the IP Deskphone selects the IPv6 address of the highest precedence.
Internet Protocol version 6 # # In this example, some clients receive different parameters than others.
Configuring the DHCP server } } SIP Software for Avaya 1100 Series IP Deskphones-Administration January 2012 279
Internet Protocol version 6 280 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 18: SIP messages supported by the IP Deskphone SIP methods The table below provides a list of SIP messages supported by the IP Deskphone. Table 52: 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 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 Send Receive Comments 408 Request timeout No Yes See default handling. 410 Gone Yes See default handling. No 413 Request entity too large No Yes See default handling. The IP Deskphone does not automatically retry if a retry-after header is present. 414 Request---URL too long No Yes See default handling. Yes The IP Deskphone can send this response when an incorrect content-type is detected for a request.
SIP messages supported by the IP Deskphone 4xx Response Send Receive Comments maximum number of allowed calls and cannot present the incoming call to the user. When this message is received by the IP Deskphone an error is displayed and a busy tone is played. 487 Request Canceled Yes Yes See default handling. 488 Not Acceptable Yes Yes The response is used by the IP Deskphone when a failed media negotiation occurs.
6xx Response—Global responses 6xx Response—Global responses 6xx Response 600 Busy Everywhere Send Yes Receive Comments Yes The IP Deskphone can send this response when the IGNORE setting is configured to NETWORK, and the user chooses to ignore an incoming call. When received, this response falls through the default handling. 603 Decline Yes Yes The IP Deskphone can send this response when the user declines an incoming call. An optional reason can be supplied.
SIP messages supported by the IP Deskphone Header field 288 Supported? Accept-Encoding Yes Accept-Language Yes Alert-Info Yes Allow Yes Allow-Events Yes Authentication-Info Yes Authorization Yes Call-Id Yes Call-Info Yes Contact Yes Content-Disposition Yes Content-Encoding Yes Content-Length Yes Content-Type Yes Cseq Yes Date Yes Expires Yes Error-Info Yes Max-Forwards Yes Mime-Version Yes Organization Yes P-Access-Network-Info Yes P-Asserted-Identity Yes P-
SIP header fields Header field Supported? 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 Subject Yes Supported Yes Timestamp Yes To Yes Unsupported Yes User-Agent Yes Via Yes Warning Yes WWW-Authenticate Yes SIP Software for
SIP messages supported by the IP Deskphone 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 RFC2543 and RFC3261/3264.
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 292 Supported? plain text Yes Avaya unencrypted Yes Avaya encrypted Yes SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Chapter 19: Diagnostics and troubleshooting This chapter contains the following topics: • IP Deskphone diagnostics on page 293 • Local diagnostic tools on page 295 • How to access the Diagnostics menu on page 296 • IP Set and DHCP information on page 298 • Network Diagnostics tools on page 300 • Ethernet Statistics on page 303 • IP Network Statistics on page 306 • USB Devices on page 307 • Advanced Diag Tools on page 308 • Test key on page 310 • Logging System on page 313 • Problem Determination Tool (PDT)
Diagnostics and troubleshooting Server unreachable after the IP Deskphone is powered up If the display indicates that the server is unreachable and it continuously resets, some parameters must be configured. Things to consider when 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 Software Conversion Failures 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 UNIStim 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. USB Devices Provides information about USB devices attached to the IP Deskphone . Certificates Administration Supports administration of available certificates.
How to access the Diagnostics menu Figure 72: Network menu After you access the Network menu, the following options are available: • 1. Server Settings • 2. Device Settings • 3. Diagnostics • 4. Disable screensaver • 5. Licensing • 6. Lock Select Diagnostics, or press Back to return to the Network menu.
Diagnostics and troubleshooting Figure 73: Diagnostics menu screen The following table describes the function of the Navigation keys for the Diagnostics screen. Table 54: 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.
IP Set and DHCP information Figure 74: IP Set and DHCP information screen The following is an example of the information that appears: 1. Configuration Network Data Valid: Yes MAC Address Stored: Yes Perform DHCP: No Voice VLAN Enable: No Voice VLAN Config: No VLAN Voice VLAN Discovered: No Primary Server: S1 PC Port is: ON 2. Software Version: 3.00.09.02 Hardware ID: xxxxxx 3. Set IP: xxx.xxx.xxx.xxx (could be in IPv4 or IPv6 format) 4. Sub-Mask: xxx.xxx.xxx.xxx (could be in IPv4 or IPv6 format) 5.
Diagnostics and troubleshooting The following table describes the function of the Navigation key for the IP Set and DHCP Information screen. Table 56: Navigation Key Action Return Press the Return context-sensitive soft key to cancel this screen and return to the Diagnostics menu. Network Diagnostics tools The Network Diagnostics Tools menu provides access to ping and tracert testing routines. To access the Network Diagnostics Tools screen, from the Diagnostics menu, choose Network Diagnostics Tools.
Network Diagnostics tools Figure 75: Network Diagnostics Tools screen The screen contains the following configurable fields: • IP—The user can enter an IP address. • Hops—The number of hops used as a configurable parameter for tracert routine. • Packet Size—Size of the network packet used by the ping routine. • Ping—The number of ping packages.
Diagnostics and troubleshooting The following table describes the function of the Navigation keys for the Network Diagnostics Tools screen. Table 58: Navigation Key Action Up and down arrows Use the up and down arrows to scroll through a list of testing information. Left and right arrows Use the left and right arrows to move through the configurable fields. Enter Use the Enter key to enter the editing mode for the active configurable field.
Ethernet Statistics Table 59: Context-sensitive soft keys for the Network Diagnostics (Config) screen Context-sensitive soft key Action Apply Applies settings, dismisses the screen, and returns you to the Network Diagnostics menu. Back Returns you to the Diagnostics menu. The following table describes the function of the Navigation keys for the Network Diagnostics tools (Config) screen.
Diagnostics and troubleshooting Figure 77: Ethernet Statistics (NI Port) screen The following is an example of Ethernet Statistics for the IP Deskphone: 1. NI Link Status: Up 2. Duplex Mode: Full 3. Network Speed: 1000Mb 4. Auto Sense/Negotiate Auto-Negotiate Capability: Yes Auto-Negotiate Completed: Yes 5. Port VLAN Priority: 0 6. Port VLAN ID: 0 7. Packet Collision: 0 8. CRC Errors: 1 9. Frame Errors: 1 A. Unicast Packets Tx: 1 B. Unicast Packets Rx: 1 C. Broadcast Packets Rx: 1 D.
Ethernet Statistics Table 62: Navigation Key Up and down arrows Action Use the up and down arrows to scroll through a list of statistics information. Ethernet Statistics (PC Port) screen The Ethernet Statistics (PC Port) screen displays ethernet statistics for the PC port. To access the PC Port from the Ethernet Statistics screen, press the NI Port context-sensitive soft key.
Diagnostics and troubleshooting Table 63: Context-sensitive soft keys for the Ethernet Statistics (PC Port) screen Context-sensitive soft key Action Reset Resets statistics values. PC Port Switches to the NI Port Ethernet statistics. Back Returns you to the Diagnostics menu. The following table describes the function of the Navigation keys for the Ethernet Statistics (PC Port) screen.
USB Devices 1. Packet Sent: 0 2. Packet Received: 0 3. Incoming Packets Error: 0 4. Outgoing Packets Error: 0 5. Incoming Pkt Discarded: 0 6. Outgoing Pkt Discarded: 0 7. Unknown Protos: 0 8. Last ICMP Type/Code: 1 The following table describes the function of the context-sensitive soft keys for the IP Network Statistics screen. Table 65: Context-sensitive soft keys for the IP Network Statistics screen Context-sensitive soft key Action Reset Resets statistics values.
Diagnostics and troubleshooting Figure 80: USB Devices screen Important: The USB Devices screen contains a list of the USB devices attached to the IP Deskphone. The following table describes the function of the context-sensitive soft keys for the USB Devices screen. Table 67: Context-sensitive soft keys for the USB Devices screen Context-sensitive soft key Back Action Returns you to the Diagnostics menu. The following table describes the function of the Navigation keys for the USB Devices screen.
Advanced Diag Tools To access the Advanced Diag Tools screen from the Diagnostics menu, choose Advanced Diag Tools. The following screen appears: Figure 81: Advanced Diag Tools screen The following table describes the function of the context-sensitive soft keys for the Advanced Diag Tools screen. Table 69: Context-sensitive soft keys for the Advanced Diag Tools screen Context-sensitive soft key Action Apply Invokes the selected service.
Diagnostics and troubleshooting Port Mirroring The Port Mirroring field behavior depends on the device configuration flag defined by the administrator. A device configuration file parameter manages the PC Port Mirroring option: PORT_MIRROR_ENABLE [YES | No] The command determines whether or not the option can be managed: • If PORT_MIRROR_ENABLE is Yes, then you can activate or deactivate the option. The Port Mirroring prompt in the Advanced Diag Tools menu is enabled and can be modified.
Reset Factory Settings support 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 71: 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 For example, the MAC-address, A1B2C3D4E5F6 can be translated to 212223343536 . Therefore, the SKS would be **73639212223343536## . After the proper sequence is entered on the IP Deskphone, the confirmation screen appears. 3. Press the Yes context-sensitive soft key to reset to factory setting. Or Press the No context-sensitive soft key to close the confirmation screen and return to regular mode.
Logging System • If the MAC-address is incorrect, the IP Deskphone displays: >Incorrect MAC-address. Action is rejected . Return to Step 1. Logging System Logging System contains a subsystem for logging incoming and outgoing SIP packages to the log file in FFS, for the IP Deskphone. You can enable or disable the SIP logging subsystem by selecting the check box for ON (enable) or deselecting the check box for OFF (disable).
Diagnostics and troubleshooting Table 74: Context-sensitive soft keys for the Logging Systems screen Context-sensitive soft key Action Apply Applies the setting and returns to the parent screen. Back Dismisses the setting and returns you to the parent screen. The following table describes the function of the Navigation keys for the Logging Systems screen. Table 75: Navigation Key Action Up and down arrows Use the up and down arrows to scroll the screen.
ECR Watchdog Error Logging framework The Error logging framework saves error-related information in the ECR Log file and is the base object used by all the other monitoring services listed as follows: • ECR Watchdog • Task Monitor • CPU Load Monitor • 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).
Diagnostics and troubleshooting Stack Overflow Monitor The Stack Overflow Monitor tracks the stack of all tasks in the real-time mode, detects the stack overflow or corruption, and logs the task trace. Traffic Monitor The Traffic Monitor monitors incoming and outgoing IP and SIP traffic and registers events in the ECR-log file when the traffic exceeds predefined thresholds. The Traffic Monitor also registers the content of the incoming and outgoing SIP packages.
The PDT commands Command Description clearLogFile Clears a content of the ECR-log file setLogLevel Configures log level, where the loglevel is in the range 0...3: • If loglevel == 0—logging disabled • If loglevel == 1—logging only Critical errors • If loglevel == 2—logging Critical and Major errors • If loglevel >=3—logging any type of errors printLogLevel Print log level setRecoveryLevel Sets up recovery level, where the reclevel is in the range 0...3.
Diagnostics and troubleshooting Command Description tracert [max hops] Traceroute to any host (tracert) netinfo Print common network information routeshow Display host and network routing tables and stats arp Display entries in the system ARP table listcerts List all trusted certificates printcert Display certificate details sipapp Start or stop the SIP application sendunistim
PDT for USB flash drive Command Description ifShow Displays IPv4 interface. ping Sends ICMPv6 Echo Request messages and records the receipt of ICMPv6 Echo Reply messages. With ping, the IP Deskphone can detect network or host communication failures and troubleshoot common IPv6 connectivity problems. Link-Local and Global addresses, as well as other node names, can be pinged.
Diagnostics and troubleshooting Shell Commands usbcd [dirname] Description Changes the directory to [dirname] relative to the current directory. The following is a sample display on the command usbFsShow in the PDT, on a 1G Kingston DataTraveler 2.0 flash drive. Figure 84: PDT output on usbFsShow command Update PDT device configuration information The PDT device configuration is updated with USB port lock information.
Device configuration file Figure 85: USB Device information from PDT Device configuration file The following table describes the configuration commands in the device configuration file for alarms, logs and diagnostics. Table 78: Alarms, logs and diagnostics configuration commands Component Flag Description PC Port Mirroring parameter PORT_MIRROR_ENAB Determines whether the option which can be modified in the LE can be managed or not. Advanced Diag Tools dialog. • If PORT_MIRROR_ENABLE is See 2.2.1.
Diagnostics and troubleshooting Component Flag Description monitor wakes up (after start-up or the last memory check attempt). The values are 1800 (0.5 hrs) to 86400 (24 hrs). The default value is 86400 (24 hrs). SIP-traffic monitor DOS_PACKET_RATE Determines the maximum number of packets per second that is allowed. 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 • ECR_LOG_SUM_TASK_INFO:– log summary of each task TCB (i) • ECR_LOG_MEM_INFO: –log memory usage information (memShow) The following is an example of the supplementary information in the ECR-log file: Figure 86: Example of the supplementary information in the ECR-log file 324 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Diagnostic Logs Figure 87: Example of the supplementary information in the ECR-log file (continued) The following is an example of the ECR-log file.
Diagnostics and troubleshooting Figure 88: Example of the ECR-log file 326 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Diagnostic Logs Figure 89: Example of the ECR-log file (continued) SIP Software for Avaya 1100 Series IP Deskphones-Administration January 2012 327
Diagnostics and troubleshooting SIP-log file The SIP-log file registers incoming and outgoing SIP-packages, and each package is logged as a record. There are two sections: • The first section requires mandatory information for each record including: - type of the package (incoming or outgoing) - time stamp - software version • The second section contains the content of the package in the text format. The following is an example of the SIP-log file.
Diagnostic Logs Figure 90: Example of the SIP-log file SIP Software for Avaya 1100 Series IP Deskphones-Administration January 2012 329
Diagnostics and troubleshooting Figure 91: Example of the SIP-log file (continued) PC Client Softphone interworking If the user does not have access to the pre-authorization configurations in the Feature Options menu, the feature is not enabled. You must verify the device configurations and enable the interworking feature so that the user can access the pre-grant authorization configuration and the IP Deskphone can auto-answer calls from authorized users or user groups.
Logging and errors SSH If a logon failure for SSH Authentication occurs, the following event is posted in the security log:1040[Minor][TUE JAN 02 20:12:14 2007][4189][i:/fw/buil d/../util/ sshapp/sshServer.
Diagnostics and troubleshooting 332 SIP Software for Avaya 1100 Series IP Deskphones-Administration Comments? infodev@avaya.
Index Numerics 802.1ab Link Layer Discovery Protocol (LLDP) ........ 174 802.1x (EAP) authorization .......................................174 802.1x (EAP) device ID ............................................174 802.1x (EAP) password ............................................174 A Automatic provisioning at a preconfigured time .........27 Automatic provisioning at power-up ...........................27 Avaya IP Deskphones parts list ..................................25 C Call Origination Busy ........
L Licensable features ..................................................258 Local Diagnostic Tools ..............................................295 M MADN ................................................................141, 142 Mandatory keywords in the provisioning file ............... 28 Media security ............................................................11 MLPP ........................................................................183 Multi-Level Precedence and Preemption ..................
Upgrade the SIP Software ..........................................99 Upgrade the UNIStim software version ....................102 Upgrade to the minimum UNIStim Software .............100 USB headsets ...........................................................160 VQMon - how it works ..............................................124 VQMon configuration commands ...............................81 VQMon set-up ..........................................................123 V Voice-VLAN and Data VLAN ..........
