Implementing End-to-End SIP Vol 1: Endpoint Deployment December 2013 Issue 2 © 2011 Avaya Inc. All Rights Reserved. Notices While reasonable efforts have been made to ensure that the information in this document is complete and accurate at the time of printing, Avaya assumes no liability for any errors. Avaya reserves the right to make changes and corrections to the information in this document without the obligation to notify any person or organization of such changes. Documentation disclaimer ―Documentation‖ means information published by Avaya in varying mediums which may include product information, operating instructions and performance specifications that Avaya generally makes available to users of its products. Documentation does not include marketing materials. Avaya shall not be responsible for any modifications, additions, or deletions to the original published version of documentation unless such modifications, additions, or deletions were performed by Avaya. End User agrees to indemnify and hold harmless Avaya, Avaya's agents, servants and employees against all claims, lawsuits, demands and judgments arising out of, or in connection with, subsequent modifications, additions or deletions to this documentation, to the extent made by End User. Link disclaimer Avaya is not responsible for the contents or reliability of any linked Web sites referenced within this site or documentation provided by Avaya. Avaya is not responsible for the accuracy of any information, statement or content provided on these sites and does not necessarily endorse the products, services, or information described or offered within them. Avaya does not guarantee that these links will work all the time and has no control over the availability of the linked pages. Warranty Avaya provides a limited warranty on its Hardware and Software (―Product(s)‖). Refer to your sales agreement to establish the terms of the limited warranty. In addition, Avaya‘s standard warranty language, as well as information regarding support for this Product while under warranty is available to Avaya customers and other parties through the Avaya Support Web site: http://www.avaya.com/support. Please note that if you acquired the Product(s) from an authorized Avaya reseller outside of the United States and Canada, the warranty is provided to you by said Avaya reseller and not by Avaya. Copyright Except where expressly stated otherwise, no use should be made of materials on this site, the Documentation, Software, or Hardware provided by Avaya. All content on this site, the documentation and the Product provided by Avaya including the selection, arrangement and design of the content is owned either by Avaya or its licensors and is protected by copyright and other intellectual property laws including the sui generis rights relating to the protection of databases. You may not modify, copy, reproduce, republish, upload, post, transmit or distribute in any way any content, in whole or in part, including any code and software unless expressly authorized by Avaya. Unauthorized reproduction, transmission, dissemination, storage, and or use without the express written consent of Avaya can be a criminal, as well as a civil offense under the applicable law. Open Source Attribution The Product utilizes open source and third-party software. For copyright notifications and license text of third-party open source components, please see the file named Avaya/Gateway/LegalNotices.txt in the directory in which you have installed the software. Trademarks Avaya, Avaya Aura, and one-X are either registered trademarks or trademarks of Avaya Inc. All non-Avaya trademarks are the property of their respective owners. Downloading Documentation For the most current versions of Documentation, see the Avaya Support Web site: http:// support.avaya.com. Contact Avaya Support Avaya provides a telephone number for you to use to report problems or to ask questions about your Product. The support telephone number is 1-800-242-2121 in the United States. For additional support telephone numbers, see the Avaya Web site: http://support.avaya.com. ii Contents Contents ........................................................................................................................................ iii Introduction ................................................................................................................................... 7 Purpose .................................................................................................................................. 7 Intended audience .................................................................................................................. 7 Avaya Aura® SIP overview ..................................................................................................... 8 Required components ............................................................................................................. 8 High-level end-to-end SIP deployment process .................................................................... 10 Related resources ................................................................................................................. 11 Avaya documentation ........................................................................................................................ 11 General references ............................................................................................................................ 12 Useful links ......................................................................................................................................... 12 Training .............................................................................................................................................. 13 Document updates ................................................................................................................ 14 Send us your comments ....................................................................................................... 14 Checklist for configuring SIP endpoints ................................................................................... 15 Task #1: Collect Configuration Data ........................................................................................ 17 Data for System Manager ..................................................................................................... 17 Data for the telephone set ..................................................................................................... 19 Data for DHCP (Option 242 Parameters) .............................................................................. 19 Data for HTTP(S) Fileserver ................................................................................................. 20 Task #2: Confirm System Component Administration ........................................................... 21 System Manager ................................................................................................................... 21 SMGR Access and permissions ........................................................................................................ 21 Routing Configuration ........................................................................................................................ 21 Inventory Management ...................................................................................................................... 22 Session Manager .................................................................................................................. 22 Communication Manager ...................................................................................................... 23 Task #3: Download the Latest Endpoint Software .................................................................. 24 Downloading 96xx and 96x1 software ................................................................................... 25 Downloading ADVD Software ............................................................................................................ 27 Downloading Avaya Flare® Experience for Windows ....................................................................... 29 Downloading Avaya Flare® Experience for iPad® ............................................................................ 31 Downloading Avaya one-X® Communicator Client software ............................................................ 33 iii Downloading Avaya B179 SIP Conference Phone software ............................................................. 34 Task #4: Administer the Fileserver ........................................................................................... 36 Install software files on the fileserver ..................................................................................... 36 Install or update the 46xxsettings.txt file on the fileserver...................................................... 36 Configure 96xx and 96x1 Sets to be SIP Endpoints .............................................................. 37 SIG Parameter Considerations for 96xx Phones ............................................................................... 37 SIG Parameter Considerations for 96x1 Phones ............................................................................... 38 Configure the 46xxsettings.txt file for SIP Endpoint Features ................................................ 39 Task #5: Administer the DHCP Server .................................................................................... 42 Task #6: Administer User in System Manager ........................................................................ 44 Task Overview ................................................................................................................................... 44 Accessing the System Manager administration interface .................................................................. 44 Configuring User Profile – Identity ..................................................................................................... 45 Configuring User Profile - Communication Profile ............................................................................. 45 Configuring User Communication Address ........................................................................................ 46 Configuring User Session Manager Profile ........................................................................................ 46 Configuring User Endpoint Profile ..................................................................................................... 47 Configuring User Messaging Profile (optional) .................................................................................. 48 Configuring User Profile – Membership (optional) ............................................................................. 49 Configuring User Profile – Contacts (optional, but required for Presence) ....................................... 49 Saving CM translations ...................................................................................................................... 50 Task #7: Unpack and Assemble the Endpoint ......................................................................... 51 Task #8: Connect the Endpoint to the Network ....................................................................... 53 96xx and 96x1 Endpoints First LAN Connection ................................................................... 53 ADVD First LAN Connection ................................................................................................. 53 Avaya one-X® Communicator First LAN Connection ............................................................ 54 Avaya Flare® Experience for Windows First LAN Connection .............................................. 54 Avaya Flare® Experience for iPad® Devices First LAN Connection ...................................... 55 Avaya B179 SIP Conference Phone First LAN Connection ................................................... 55 Task #9: Change Endpoint’s Signaling Type from H.323 to SIP ........................................... 55 SIP-Only Endpoints: No Change Required ........................................................................... 55 Avaya one-X® Communicator: Settings Change ................................................................... 56 96xx Phones: Changing the SIG Parameter .......................................................................... 56 96x1 Phones: Changing the SIG Parameter ......................................................................... 56 Task #10: Confirm Software Update ........................................................................................ 57 96xx and 96x1 SIP Software Confirmation ............................................................................ 57 Avaya one-X® Communicator Software Release Confirmation ............................................. 58 iv Avaya Desktop Video Device with the Flare® Experience Software Release Confirmation ... 58 Avaya Flare® Experience for Windows Software Release Confirmation ............................... 58 Avaya Flare® Experience for iPad® Software Revision Confirmation ................................... 58 Avaya B179 SIP Conference Phone Software Release Confirmation: ................................... 58 Task #11: Login and confirm feature subscription ................................................................. 59 Task #12: Testing call and feature operation ........................................................................... 59 Point-to-point call .................................................................................................................. 59 Lamp/Button/Display confirmation ......................................................................................... 61 Network Parameter confirmation ........................................................................................... 61 Appendix A: Verifying administration .................................................................................... 63 General ................................................................................................................................. 63 Session Manager .................................................................................................................. 63 Communication Manager ...................................................................................................... 64 Appendix B: Administration best practices ............................................................................ 66 Administration best practices ................................................................................................ 66 Endpoint best practices ......................................................................................................... 67 Appendix C: Administration guidance and detailed descriptions ......................................... 71 Administering endpoint TLS/TCP .......................................................................................... 71 For TLS ports ..................................................................................................................................... 71 For TCP ports..................................................................................................................................... 72 Changing the protocol ........................................................................................................................ 73 Upgrading software on the telephone .................................................................................... 73 Migrating existing H.323 endpoints to SIP software .............................................................. 75 Pre-administer the users-to-be-migrated in System Manager ........................................................... 75 Migrating the endpoints from H.323 to SIP ........................................................................................ 76 Using SIP and H.323 endpoints in a mixed environment ....................................................... 77 Appendix D: Troubleshooting ................................................................................................... 80 Before calling Avaya support ................................................................................................ 80 Troubleshooting tips .............................................................................................................. 80 Appendix E - Signing up for PCN/PSN notifications .............................................................. 84 Appendix F: Signaling and Dial Plans ...................................................................................... 85 Appendix G: Proper Selection of 46xxsettings.txt Values ....................................................... 86 What is the 46xxsettings.txt Role During the Phone Boot Sequence? ................................... 86 v Where do Phone Configuration Parameters Come From? .................................................... 86 Which Configuration Source Takes Priority? ......................................................................... 87 46xxsettings.txt Default File .................................................................................................. 87 Minimum Settings to Get SIP Phones Working ..................................................................... 88 Appendix H: Session Manager’s Personal Profile Manager (PPM) ...................................... 89 What is the Personal Profile Manager? ................................................................................. 89 What is the purpose of the PPM? .......................................................................................... 89 Personal Profile Manager Architecture .................................................................................. 90 Personal Profile Manager (PPM) flow ................................................................................... 91 Appendix I: Acronyms and Terms ............................................................................................ 93 vi Introduction Purpose This document demonstrates the quickest and easiest way to deploy SIP endpoints during Avaya Aura® installation and have SIP endpoints and basic call features work as designed. It also covers verifying that critical initial administration was done correctly and provides information on setting up the endpoints. This document does not cover all the installation and configuration of the Avaya Aura® solution, but rather focuses on administering users. Intended audience This document is intended for implementation engineers responsible for end-to-end SIP deployment, including customers, partners and Avaya associates. 7 Avaya Aura® SIP overview The Avaya Aura® SIP solution is a rich, highly interoperable set of SIP components that take enterprise communications architecture to the next level. At the core of the solution is the Avaya Aura® Session Manager providing SIP interoperability, centralized numbering plan, SIP normalization, SIP routing, and many other SIP services to create a secure and easy to manage enterprise backbone network. At the access layer of the solution are the SIP endpoints working seamlessly with the Avaya Aura® core to provide world class enterprise services. Below is a typical SIP configuration used to define the configuration steps for successfully deploying a SIP solution. Required components For a properly operational SIP endpoint, an enterprise needs the following components: System Manager (SMGR), Release 6.3.5 - At least one SMGR must be installed with the latest service pack, configured, and connected to the network. SMGR provides the central administration interface used to configure the Session Manager and Communication Manager components. The SMGR‘s WebLM License Server is frequently configured to provide license services to the other solution components. Session Manager (SM), Release 6.3.5 - One or more Session Managers are installed with the latest service pack, configured, and connected to the network. Session Manager serves as the SIP registrar and outbound proxy for the endpoints, and it routes 8 SIP messages during call setup, modification, and teardown. Session Manager also contains the Personal Profile Manager (PPM), which provides for backup and restore of endpoint-resident data like contacts, endpoint parameters, etc. Communication Manager (CM), Release 6.3.3 – At least one Communication Manager is installed with the latest service pack, configured, and connected to the network. Communication Manager handles call origination and termination for endpoints, implements a rich set of telephony features, and participates in call routing in concert with Session Manager. DHCP Server - A DHCP server is installed, configured, and connected to the network, and the DHCP scope(s) are administered as needed. The customer may provide the DHCP server, or may activate the DHCP server resident in an Avaya Aura® Utility Services server, if one is available in the system. Endpoints get their IP address from the DHCP server during the initial connection to the network. The endpoints also use the fileserver FQDN/IP address specified in a DHCP option string to communicate with the fileserver for software updates and to retrieve the settings file that automatically configures the endpoint parameters. HTTP Server – An HTTP server (fileserver) is installed, configured, and connected to the network. The telephone upgrade script, settings file, and latest release of software are properly configured and loaded onto the HTTP server. The endpoints contact the HTTP server to download their settings file and to check for (and download) new software updates. SIP Endpoints - All of the SIP telephones are physically installed and are running the latest SIP software. In this document, SIP endpoints include the following: o Avaya one-X® Communicator (―softphone‖) o Avaya SIP one-X™ Deskphones (―hardphone‖) o Avaya B179 SIP Conference Phone o The Avaya Flare® Experience for Windows and iPad® o The Avaya A175 Desktop Video Device with the Flare® Experience (―ADVD‖) There are currently 2 different generations of Avaya SIP hardphones, each running different versions of SIP software. These endpoints are collectively called out in this document as 96xx or 96x1, and the specific models map as follows: [96xx] 9620, 9620C, 9620L, 9630, 9630G, 9640, 9640G, 9650, and 9650C [96x1] 9601, 9608, 9611G, 9621G and 9641G The 96xx hardphones use 2.6.x SIP software releases, and the 96x1 hardphones use 6.3.x SIP software releases. Both generations of SIP hardphones can also be configured as H.323 hardphones, by loading H.323 software instead of SIP software. This document focuses on SIP deployments, but some customers will deploy both H.323 and SIP versions in the same environment, and we‘ll consider the special requirements of such environments. 9 High-level end-to-end SIP deployment process The SIP endpoint deployment sequence consists of four high-level activities: 1. Collect the configuration data required to install the endpoints on the system. 2. Perform user administration in System Manager, the DHCP server, and the fileserver. As a first step in this administration, confirm that the System Manager, Session Manager, and Communication Manager core administration required to support your SIP endpoints has already been properly performed, and address any misconfiguration. 3. Unpack, assemble, and connect each endpoint to the LAN. Perform manual endpoint administration (See Task #9: Change Endpoint’s Signaling Type from H.323 to SIP). Confirm that each endpoint successfully registers to the system, that you can login on the endpoint, and that all the expected feature controls and displays subsequently appear on the endpoint. 4. Using System Manager, administer two users for testing purposes. Log those users into two networked SIP endpoints, and verify that they can call each other and that buttons, indicators, and displays on the endpoints function correctly. 10