implementing avaya aura ® session manager

Implementing Avaya Aura® SessionManager

Release 6.3Issue 2

May 2013

© 2013 Avaya Inc.

All Rights Reserved.

Notice

While reasonable efforts have been made to ensure that theinformation in this document is complete and accurate at the time ofprinting, Avaya assumes no liability for any errors. Avaya reserves theright to make changes and corrections to the information in thisdocument without the obligation to notify any person or organization ofsuch changes.

Documentation disclaimer

“Documentation” means information published by Avaya in varyingmediums which may include product information, operating instructionsand performance specifications that Avaya generally makes availableto users of its products. Documentation does not include marketingmaterials. Avaya shall not be responsible for any modifications,additions, or deletions to the original published version ofdocumentation unless such modifications, additions, or deletions wereperformed by Avaya. End User agrees to indemnify and hold harmlessAvaya, 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 linkedwebsites referenced within this site or documentation provided byAvaya. Avaya is not responsible for the accuracy of any information,statement or content provided on these sites and does not necessarilyendorse the products, services, or information described or offeredwithin them. Avaya does not guarantee that these links will work all thetime 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 ofthe limited warranty. In addition, Avaya’s standard warranty language,as well as information regarding support for this Product while underwarranty is available to Avaya customers and other parties through theAvaya Support website: http://support.avaya.com. Please note that ifyou acquired the Product(s) from an authorized Avaya reseller outsideof the United States and Canada, the warranty is provided to you bysaid Avaya reseller and not by Avaya. “Software” means computerprograms in object code, provided by Avaya or an Avaya ChannelPartner, whether as stand-alone products or pre-installed on hardwareproducts, and any upgrades, updates, bug fixes, or modified versions.

Licenses

THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYAWEBSITE, HTTP://SUPPORT.AVAYA.COM/LICENSEINFO AREAPPLICABLE TO ANYONE WHO DOWNLOADS, USES AND/ORINSTALLS AVAYA SOFTWARE, PURCHASED FROM AVAYA INC.,ANY AVAYA AFFILIATE, OR AN AUTHORIZED AVAYA RESELLER(AS APPLICABLE) UNDER A COMMERCIAL AGREEMENT WITHAVAYA OR AN AUTHORIZED AVAYA RESELLER. UNLESSOTHERWISE AGREED TO BY AVAYA IN WRITING, AVAYA DOESNOT EXTEND THIS LICENSE IF THE SOFTWARE WAS OBTAINEDFROM ANYONE OTHER THAN AVAYA, AN AVAYA AFFILIATE ORAN AVAYA AUTHORIZED RESELLER; AVAYA RESERVES THERIGHT TO TAKE LEGAL ACTION AGAINST YOU AND ANYONEELSE USING OR SELLING THE SOFTWARE WITHOUT A LICENSE.BY INSTALLING, DOWNLOADING OR USING THE SOFTWARE, ORAUTHORIZING OTHERS TO DO SO, YOU, ON BEHALF OFYOURSELF AND THE ENTITY FOR WHOM YOU ARE INSTALLING,DOWNLOADING OR USING THE SOFTWARE (HEREINAFTERREFERRED TO INTERCHANGEABLY AS “YOU” AND “END USER”),AGREE TO THESE TERMS AND CONDITIONS AND CREATE ABINDING CONTRACT BETWEEN YOU AND AVAYA INC. OR THEAPPLICABLE AVAYA AFFILIATE (“AVAYA”).

Avaya grants you a license within the scope of the license typesdescribed below, with the exception of Heritage Nortel Software, forwhich the scope of the license is detailed below. Where the orderdocumentation does not expressly identify a license type, theapplicable license will be a Designated System License. The applicablenumber of licenses and units of capacity for which the license is grantedwill be one (1), unless a different number of licenses or units of capacityis specified in the documentation or other materials available to you.“Designated Processor” means a single stand-alone computing device.“Server” means a Designated Processor that hosts a softwareapplication to be accessed by multiple users.

Concurrent User License

Concurrent User License (CU). End User may install and use theSoftware on multiple Designated Processors or one or more Servers,so long as only the licensed number of Units are accessing and usingthe Software at any given time. A “Unit” means the unit on which Avaya,at its sole discretion, bases the pricing of its licenses and can be,without limitation, an agent, port or user, an e-mail or voice mail accountin the name of a person or corporate function (e.g., webmaster orhelpdesk), or a directory entry in the administrative database utilizedby the Software that permits one user to interface with the Software.Units may be linked to a specific, identified Server.

Copyright

Except where expressly stated otherwise, no use should be made ofmaterials on this site, the Documentation, Software, or hardwareprovided by Avaya. All content on this site, the documentation and theProduct provided by Avaya including the selection, arrangement anddesign of the content is owned either by Avaya or its licensors and isprotected by copyright and other intellectual property laws including thesui generis rights relating to the protection of databases. You may notmodify, copy, reproduce, republish, upload, post, transmit or distributein any way any content, in whole or in part, including any code andsoftware unless expressly authorized by Avaya. Unauthorizedreproduction, transmission, dissemination, storage, and or use withoutthe express written consent of Avaya can be a criminal, as well as acivil offense under the applicable law.

Third Party Components

“Third Party Components” mean certain software programs or portionsthereof included in the Software that may contain software (includingopen source software) distributed under third party agreements (“ThirdParty Components”), which contain terms regarding the rights to usecertain portions of the Software (“Third Party Terms”). Informationregarding distributed Linux OS source code (for those Products thathave distributed Linux OS source code) and identifying the copyrightholders of the Third Party Components and the Third Party Terms thatapply is available in the Documentation or on Avaya’s website at: http://support.avaya.com/Copyright. You agree to the Third Party Terms forany such Third Party Components.

Preventing Toll Fraud

“Toll Fraud” is the unauthorized use of your telecommunicationssystem by an unauthorized party (for example, a person who is not acorporate employee, agent, subcontractor, or is not working on yourcompany's behalf). Be aware that there can be a risk of Toll Fraudassociated with your system and that, if Toll Fraud occurs, it can resultin substantial additional charges for your telecommunications services.

Avaya Toll Fraud intervention

If you suspect that you are being victimized by Toll Fraud and you needtechnical assistance or support, call Technical Service Center TollFraud Intervention Hotline at +1-800-643-2353 for the United Statesand Canada. For additional support telephone numbers, see the AvayaSupport website: http://support.avaya.com. Suspected securityvulnerabilities with Avaya products should be reported to Avaya bysending mail to: [email protected].

2 Implementing Avaya Aura® Session Manager Release 6.3 May 2013Comments? [email protected]

http://support.avaya.com/

http://www.avaya.com/support/LicenseInfo

http://support.avaya.com/Copyright

http://support.avaya.com/Copyright

http://support.avaya.com

mailto:[email protected]?subject=Implementing Avaya Aura® Session Manager Release 6.3

Trademarks

Avaya® and Avaya Aura® are registered trademarks of Avaya Inc. inthe United States of America and/or other jurisdictions.

All non-Avaya trademarks are the property of their respective owners.Linux® is the registered trademark of Linus Torvalds in the U.S. andother countries.

Downloading Documentation

For the most current versions of Documentation, see the AvayaSupport website: http://support.avaya.com.

Contact Avaya Support

See the Avaya Support website: http://support.avaya.com for productnotices and articles, or to report a problem with your Avaya product.For a list of support telephone numbers and contact addresses, go tothe Avaya Support website: http://support.avaya.com, scroll to thebottom of the page, and select Contact Avaya Support.

Implementing Avaya Aura® Session Manager Release 6.3 May 2013 3




Contents

Chapter 1: Introduction...................................................................................................... 7Purpose..................................................................................................................................................... 7Intended audience.................................................................................................................................... 7Document changes since last issue.......................................................................................................... 7Related resources..................................................................................................................................... 7

Documentation................................................................................................................................. 7Training............................................................................................................................................ 8Avaya Mentor videos........................................................................................................................ 9

Support...................................................................................................................................................... 9Warranty.................................................................................................................................................... 9

Chapter 2: Session Manager installation overview......................................................... 11Remote access......................................................................................................................................... 11OS-level logins for Session Manager........................................................................................................ 12Upgrades to Session Manager................................................................................................................. 13Installing Session Manager in a geographic redundancy enabled system............................................... 13

High-level steps for the installation................................................................................................... 14Geographic Redundancy system verification................................................................................... 15

Chapter 3: Session Manager preinstallation.................................................................... 17Prerequisites for installing Session Manager............................................................................................ 17Registering for PLDS................................................................................................................................ 18Downloading software from PLDS............................................................................................................ 18Writing the ISO image to a DVD............................................................................................................... 19

Chapter 4: Installing Session Manager............................................................................. 21Ethernet port labels by server type........................................................................................................... 21Session Manager installation checklist..................................................................................................... 21Configuring the laptop for direct connection to the server........................................................................ 23Disabling proxy servers in Microsoft Internet Explorer.............................................................................. 24Disabling proxy servers in Mozilla Firefox................................................................................................. 25Connecting a laptop to the server............................................................................................................. 26Activating entitlements.............................................................................................................................. 26Enrolling a password (Enrollment Password)........................................................................................... 27Authentication files for Session Manager.................................................................................................. 28Starting the AFS application..................................................................................................................... 29Creating an authentication file for a Session Manager............................................................................. 29Installing an authentication file.................................................................................................................. 30Configuring Session Manager with SMnetSetup...................................................................................... 31Alarming Configuration.............................................................................................................................. 32

Network Management Systems Destinations................................................................................... 32Activating and Managing the Session Manager serviceability agent............................................... 33

Chapter 5: Session Manager administration.................................................................... 35Introduction............................................................................................................................................... 35Session Manager administration checklist................................................................................................ 35Adding domain names for Session Manager............................................................................................ 36Adding Session Manager as a SIP entity.................................................................................................. 36


Administering Session Manager............................................................................................................... 37Chapter 6: Testing the installation.................................................................................... 39

Checking the Session Manager service state........................................................................................... 39Testing the System Manager and Session Manager installation.............................................................. 39Generating a test alarm............................................................................................................................. 41Verifying Data Replication to Session Manager........................................................................................ 41

Chapter 7: Session Manager redundancy........................................................................ 43Configuring Session Manager redundancy on the same System Manager.............................................. 43

Chapter 8: Survivable Remote Session Manager............................................................ 45Prerequisites............................................................................................................................................. 45Survivable Remote Session Manager....................................................................................................... 45Installation overview.................................................................................................................................. 46Survivable remote installation checklist.................................................................................................... 46Survivable Remote SAT administration checklist...................................................................................... 49

Adding a Survivable Remote server................................................................................................. 49Validating gateway recovery rule..................................................................................................... 50Validating the minimum time of network stability.............................................................................. 50

Survivable Remote Session Manager administration checklist................................................................ 51Adding a Survivable Remote server as a SIP entity......................................................................... 52Creating entity links.......................................................................................................................... 52Checking the connections................................................................................................................ 53Administering a survivable remote server........................................................................................ 53

Verifying survivable remote information.................................................................................................... 55Verifying avaya-lsp-fs administration........................................................................................................ 55Verifying survivable server registration..................................................................................................... 56Testing calls.............................................................................................................................................. 57

Chapter 9: Troubleshooting............................................................................................... 59Server has no power................................................................................................................................. 59Unable to access Service State................................................................................................................ 59Issues with replica group state.................................................................................................................. 60

Troubleshooting steps...................................................................................................................... 60Survivable server fails to sync with main server....................................................................................... 61

Branch Session Manager fails to completely install......................................................................... 61Troubleshooting steps...................................................................................................................... 61

Appendix A: Worksheets.................................................................................................... 63Session Manager configuration information worksheet............................................................................ 63Session Manager Entity information worksheet........................................................................................ 64Survivable Remote configuration information worksheet.......................................................................... 65

Appendix B: Available media............................................................................................. 67Appendix C: Interoperability with Avaya products.......................................................... 69Appendix D: Supported hardware and Port Matrix.......................................................... 71Appendix E: CDR record format........................................................................................ 73Appendix F: PCN and PSN notifications........................................................................... 79

PCN and PSN notifications....................................................................................................................... 79Viewing PCNs and PSNs.......................................................................................................................... 79Signing up for PCNs and PSNs................................................................................................................ 80

Index..................................................................................................................................... 81

6 Implementing Avaya Aura® Session Manager Release 6.3 May 2013

Chapter 1: Introduction

PurposeThis document contains the installation and initial administration information for AvayaAura® Session Manager Release 6.3.

Intended audienceThe primary audience for this document is anyone who is involved with installing and verifyingAvaya Aura® Session Manager.

Document changes since last issueNo documentation changes have been made to this document since the last issue.

Related resources

DocumentationThe following table contains information about additional Session Manager-relateddocumentation available on the Avaya support website.

Name of Book Details

Administering Avaya Aura®

Session ManagerDescribes how to administer Session Manager, usingSystem Manager.


Implementing Avaya Aura®

Session ManagerProvides the installation and initial administrationinformation for Session Manager.

Maintaining and TroubleshootingAvaya Aura® Session Manager

Contains information for troubleshooting SessionManager, resolving alarms, and replacing hardware.Also contains alarm codes and event IDdescriptions.

Administering Avaya Aura®

Communication Manager ServerOptions

Provides information for administeringCommunication Manager as feature server orevolution server and the associated Session Manageradministration.

Implementing Avaya Aura®

Communication ManagerProvides information on installing the appropriateCommunication Manager template, including BranchSession Manager, on the server.

Avaya Aura® Session Managerusing VMware® in the VirtualizedEnvironment Deployment Guide

Provides information on installation, configuration,initial administration and troubleshooting for SessionManager on VMware.

Upgrading Avaya Aura® SessionManager

Describes how to upgrade Session Manager to a newsoftware release.

Installing Service Packs For AvayaAura® Session Manager

Describes how to install service packs on SessionManager.

Security Design for Avaya Aura®

Session ManagerContains information on making Session Managersecure on the network.

Avaya Aura® Session ManagerCase Studies

Provides case studies that walk users throughcommon administration scenarios.

Installing the Avaya S8800 Serverfor Avaya Aura® CommunicationManager

Contains information on installing the S8800 server inthe rack.

Installing the Avaya S8510 ServerFamily and Its Components

Contains information on installing the S8510 server inthe rack.

Installing the Dell™ PowerEdge™

R610 ServerContains information on installing the Dell™PowerEdge™ R610 server in the rack.

Installing the HP ProLiant DL360G7 Server

Contains information on installing the HP ProLiantDL360 G7 server in the rack.

TrainingThe following courses are available on https://www.avaya-learning.com. To search for thecourse, in the Search field, enter the course code and click Go .

Introduction


https://www.avaya-learning.com


Course code Course title5U00104W Session Manager 6.2 Delta Overview

5U00105W Avaya Aura® Session Manager Overview

ATU00171OEN Session Manager General Overview

ATC00175OEN Session Manager Rack and Stack

ATU00170OEN Session Manager Technical Overview

ATC01840OEN Survivable Remote Session Manager Administration

Avaya Mentor videosAvaya Mentor is an Avaya-run channel on YouTube that includes technical content on how toinstall, configure, and troubleshoot Avaya products.

Go to http://www.youtube.com/AvayaMentor and perform one of the following actions:

• Enter a key word or key words in the Search Channel to search for a specific productor topic.

• Scroll down Playlists, and click the name of a topic to see the available list of videosposted on the site.

SupportVisit the Avaya Support website at http://support.avaya.com for the most up-to-datedocumentation, product notices, and knowledge articles. You can also search for releasenotes, downloads, and resolutions to issues. Use the online service request system to createa service request. Chat with live agents to get answers to questions, or request an agent toconnect you to a support team if an issue requires additional expertise.

WarrantyAvaya provides a 90-day limited warranty on Session Manager. See the sales agreement orother applicable documentation for more information about the terms of the limited warranty.In addition, see the standard warranty and details about Session Manager support during thewarranty period on the Avaya Support website at https://support.avaya.com under Help &Policies> Policies & Legal > Maintenance and Warranty Information. See also Help &Policies > Policies & Legal > License Terms.

Support


http://www.youtube.com/AvayaMentor


https://support.avaya.com

Introduction



Chapter 2: Session Manager installationoverview

Avaya Aura® System Manager Release 6.3 manages up to 10 core Session Manager instances. You canset up and administer the Session Managers concurrently.

You can install the Session Manager 6.3 application on the following servers: HP DL360G7 and Dell R610.The servers HP DL360G7 or Dell R610 are shipped with all of the required components and softwareapplications installed. Avaya has issued End of Sale notices for both S8800 and S8510 servers. For detailsand effective dates of these End of Sale notices, see the Avaya Support website at http://support.avaya.com/. This installation document includes references specific to S8800 and S8510 becausethe Session Manager 6.3 application can be installed on the S8800 and S8510 servers under somecircumstances such as software re-installation. You can connect the server to the customer network andthe System Manager server using CAT5 Ethernet cables provided by the customer. Remote access tothe server is supported only through the network. The system does not support modem access.

Starting with Session Manager Release 6.0, the PCI hardware version of the SM100 security module isa software module running on the Session Manager server. The SM100 PCI hardware version is not used.The software version of the Security Module uses the Eth2 network interface for SIP traffic.

Note:Ensure that customers have the Linux operating system Kickstart DVD and the Session ManagerSoftware DVD on the site to handle advanced installation issues or catastrophic failure or both.Download the software from PLDS.

Ensure that System Manager is installed and operating on the customer network before starting theSession Manager installation.

You can install and configure the Mid-size Enterprise Session Manager using the Midsize EnterpriseTemplate 6.2. For more information, see Installing and Configuring Avaya Aura® Solution for MidsizeEnterprise on the Avaya Support website.

Remote accessSecure Access Link (SAL) uses the existing Internet connectivity of the customer for remotesupport and alarming. All communication from the customer environment is sent by SecureHypertext Transfer Protocol Secure (HTTPS). SAL requires upload bandwidth, for example,from customer to Avaya or Avaya Partner, of at least 90 Kbs with round trip latency no greaterthan 150 ms.




Business Partners without SAL Concentrator must provide their own IP-based connectivity, forexample, B2B VPN connection, to deliver remote services.

OS-level logins for Session ManagerThe following is a list of logins which are created during the Session Manager softwareinstallation:

• craft: An Avaya services login that you can use to gain access to the system remotelyfor troubleshooting purposes.

• sroot: An Avaya services root permission login that you can use to gain access to thesystem remotely for troubleshooting purposes. You cannot gain access to the sroot logindirectly from a login prompt except at the server console.

• customer: A login that the SMnetSetup script creates. The default name of thecustomer login is cust. The customer must ensure the security of this login-in account.The customer login can run tools on the Session Manager server which do not requireroot access.

• CDR_User: A restricted shell login for the Call Detail Recording (CDR) feature that collectscall data from the Session Manager server. This login is restricted to sftp access only.

• asset: A login created during the installation of the Security Module software. By default,access to the system using this login is disabled.

• spirit: A login created by the Secure Access Link remote alarming and remote accessmodule for Avaya services.

• postgres: A login created by the installation of the Session Manager softwarePostgresSQL database system. Access to the system using this login is disabled.

• init : An Avaya services login that accesses the system remotely for troubleshootingpurposes.

• inads: An Avaya services login that accesses the system remotely for troubleshootingpurposes.

• rasaccess: An Avaya services login that accesses the system remotely fortroubleshooting purposes.

• jboss: A login created for running the management jboss and is not a login account.

• wsuser: A login created for running WebSphere and is not a login account.

Warning:As of Session Manager 6.2 release, the sroot and craft logins are secured using AccessSecurity Gateway challenge and response mechanisms in order to prevent unauthorizedaccess to Session Manager servers by non-Avaya services personnel. Using the customerlogin account, you can execute most of the maintenance and troubleshooting commandsand root access is not required for standard maintenance and support purposes. For details,see PSN.

Session Manager installation overview


https://downloads.avaya.com/css/P8/documents/100169866


Upgrades to Session ManagerTo upgrade to a new software release for Session Manager, see Upgrading Avaya Aura®

Session Manager on the Avaya support Web site at http://www.avaya.com/support.

To install service packs for Session Manager, see Installing Service Packs on Avaya Aura®

Session Manager on the Avaya support Web site at http://www.avaya.com/support. BranchSession Manager (BSM) upgrade involves upgrading of the Communication ManagerSurvivable Remote templates as outlined in the document Upgrading Avaya Aura® SessionManager.

Note:Upgrade System Manager before starting the upgrade process on Session Managers.

Installing Session Manager in a geographic redundancyenabled system

Before you beginIn a Geographic Redundancy-enabled system, ensure that the two standalone SystemManager servers that you designate as primary and secondary servers are installed and:

• Contain the same hardware, HP ProLiant DL360 G7 or Dell™ PowerEdge™ R610server.

• Meet the following requirements:

- Must have the same hardware configuration.- Must contain the same version of System Manager software that includes the

template, service packs, and patches.- Must contain the same version of the System Platform software that includes service

packs.- Must be able to communicate with each other over the network.- Must have synchronized network time.

For System Manager Installation details, see Implementing Avaya Aura® System Manager andAvaya Aura® System Manager using VMware® in the Virtualized Environment DeploymentGuide.

For the initial administration related procedures and to understand the overall setup of theGeographic Redundancy-enabled system, see the chapter Session Manager in a

Upgrades to Session Manager


http://www.avaya.com/support


geographically redundant System Manager environment in the book Administering AvayaAura® Session Manager.

High-level steps for the installationProcedure

1. Install the primary System Manager with System Manager 6.3 as a standaloneSystem Manager or upgrade a standalone System Manager to System Manager6.3.

2. Install the secondary System Manager.

3. Configure System Managers for the Geographic Redundancy operation.

4. Replicate the primary System Manager data to the secondary System Manager.

5. Install Session Manager 6.3 or upgrade an existing Session Manager to SessionManager 6.3.See Session Manager configuration information worksheet in Appendix A:Worksheets.

6. Synchronize System Manager data with the Communication Manager system.

ResultThe post installation system updates are as follows:

1. Above mentioned steps enables trust to be established between the SystemManager and Session Manager in the normal manner.

2. The system performs the first set of replications including the FQDN and IPaddresses of both System Managers.

3. Session Manager detects two sets of FQDNs and IP addresses of both SystemManagers and automatically reconfigures as per the Geographic Redundancymode.

4. Session Manager queries both System Manager servers and determines themaster.

5. After the Session Manager automatically reconfigures, the system operates in theSunny Day Geographic Redundancy mode.

Note:For installing Session Manager 6.3 and pre-Session Manager 6.3 when the primary SystemManager is off the network and the secondary System Manager is active, you can installaccording to the following method:

• For Session Manager release 6.3, if installed when the primary is unavailable and thesecondary is active, run the script dnat_failover.sh MASTER_SMGR_IP, where




MASTER_SMGR_IP is the secondary System Manager IP address. Next, run the scriptinitTM.

• For Session Manager of pre-6.3 release, re-configure the Session Manager instancesto be managed by the secondary System Manager by running the following command:

changeMgmtIP. See Maintaining and troubleshooting Avaya Aura® SessionManager for details.

With this command, you can change the IP address of the System Manager that managesthese Session Manager instances.

Geographic Redundancy system verificationAbout this taskPerform this verification procedure after the system installation or upgrade.

Procedure

1. In the secondary System Manager, verify that the primary is running in the Activemode.

2. In the primary System Manager, verify that the secondary is running in the Standbymode.

Installing Session Manager in a geographic redundancy enabled system


Chapter 3: Session Manager preinstallation

Prerequisites for installing Session ManagerBefore you install Session Manager, ensure that you meet the following prerequisites:

• The System Manager template must be installed and operating. Beginning from Release6.3, you can install System Manager in the following environment:

- Geographic Redundancy. In this mode, you install System Manager as primarySystem Manager server and secondary System Manager server.

- non-Geographic Redundancy. In this mode you install System Manager asstandalone System Manager server.

To install the System Manager template, see Implementing Avaya Aura® SystemManager on the Avaya support Web site, http://www.avaya.com/support.

• License activation code: You must have a license activation code (LAC) before you installSession Manager. The LAC email recipients are identified during the order placementprocess.

• Obtain the Virtual FQDN of System Manager.

• Network ports: The document Avaya Aura® Session Manager: Port Matrix identifies whichnetwork ports must be open in firewalls. This document is available to Avaya customers,associates, and business partners who can use the InSite Knowledge ManagementDatabase at http://www.avaya.com/support

• Access to the PLDS Web site: If you do not have access to the Product License DeliverySystem (PLDS) Web site, see Avaya Access FAQ for details.

• Register for PLDS

• Download software from PLDS

• Write the ISO image to DVD or CD

Note:The PLDS download ID for the source RPMs ISO image (RHEL source code used bySession Manager) is SM000000041.




http://support.avaya.com/css/P8/documents/100078296

Registering for PLDSProcedure

1. Go to the Avaya Product Licensing and Delivery System (PLDS) Web site at https://plds.avaya.com.The PLDS Web site redirects you to the Avaya single sign-on (SSO) Web page.

2. Log in to SSO with your SSO ID and password.The PLDS registration page is displayed.

3. If you are registering:

• as an Avaya Partner, enter the Partner Link ID. If you do not know your PartnerLink ID, send an e-mail to [email protected].

• as a customer, enter one of the following:

- Company Sold-To

- Ship-To number

- License authorization code (LAC)

4. Click Submit.Avaya will send you the PLDS access confirmation within one business day.

Downloading software from PLDSAbout this task

Note:You can download product software from http://support.avaya.com also.

Procedure

1. Type http://plds.avaya.com in your Web browser to go to the Avaya PLDSwebsite.

2. Enter your Login ID and password to log on to the PLDS Web site.

3. On the Home page, select Assets.

4. Select View Downloads.

5. Search for the available downloads using one of the following methods:

Session Manager preinstallation


https://plds.avaya.com

https://plds.avaya.com


http://plds.avaya.com


• By actual download name

• By selecting an application type from the drop-down list

• By download type

• By clicking Search Downloads

6. Click the download icon from the appropriate download.

7. When the system displays the confirmation box, select Click to download yourfile now.

8. If you receive an error message, click on the message, install Active X, and continuewith the download.

9. When the system displays the security warning, click Install.When the installation is complete, PLDS displays the downloads again with acheckmark next to the downloads that are completed successfully.

Writing the ISO image to a DVDBefore you begin

1. Download any required software from PLDS.2. Verify that the md5 checksum of the downloaded ISO image matches the md5

checksum that is displayed for the ISO image on the PLDS Web site.

About this taskIf you are writing to a DVD, you require a computer or a server that has a DVD writer and asoftware that can write ISO images to DVD.

Important:When the ISO image is being written to the DVD, do not run other resource-intensiveapplications on the computer. Any application that uses the hard disk intensively can causea buffer underrun or other errors, which can render the DVD useless.

Procedure

Write the ISO image of the installer to a DVD.

Writing the ISO image to a DVD


Session Manager preinstallation



Chapter 4: Installing Session Manager

About this taskTo install Session Manager, perform the following steps:

• Enter networking and related information. For more information, see Worksheets on page 63.• Install the Session Manager server.• Administer Session Manager.• Test the installation.

You can install the Session Manager application on the HP DL360G7 and Dell R610 servers. Theseservers are shipped with all of the required components and software applications.

Ethernet port labels by server type

Server Eth0 (Management Interface) Eth2 (Security Module)

S8800 1 3

HP DL360 G7 1 3

Dell R610 Gb1 Gb3

S8510 GB1 GB3

Session Manager installation checklistYou need a copy of this checklist for each Session Manager that you will install.

The customer must have the Linux operating system Kickstart DVD and the Session ManagerSoftware CD on the site to address advanced installation issues and catastrophic failures. Thesoftware is available for download from PLDS. See the section Session ManagerPreinstallation for details.

Note:Session Manager and System Manager host names might contain letters, numbers, andhyphens. You cannot enter underscores.


# Installation action Link to installation description

1 Complete the Session Managerconfiguration information worksheetand verify that the information iscorrect.

Session Manager configurationinformation worksheet on page 63

2 Complete the Session Manager entityinformation worksheet and verify thatthe information is correct.

Session Manager Entity informationworksheet on page 64

3 Configure the laptop for directconnection to the server which isrequired for the initial configuration.

Configuring the laptop for directconnection to the server on page 23

4 Disable proxy servers. • If using Internet Explorer, see Disabling proxy servers in MicrosoftInternet Explorer on page 24

• If using Firefox, see Disabling proxyservers in Mozilla Firefox onpage 25

5 Install the Session Manager server. • If you are installing an Avaya S8800server, see Installing the AvayaS8800 Server for Avaya Aura ™Communication Manager (03–602918)

• If you are installing an Avaya S8510server, see Installing the AvayaS8510 Server Family and ItsComponents (03–602918)

• If you are installing a Dell R610server, see Installing the Dell™PowerEdge™ R610 Server,03-603793

• If you are installing an HP DL360G7 server, see Installing the HPDL360 G7 Server, 03-603799

6 Connect the laptop to the server. Connecting a laptop to the server onpage 26

7 Install the license file. Activating entitlements on page 26

8 Log in to System Manager associatedwith Session Manager.

9 Establish the Session Managerenrollment password on SystemManager.

Enrolling a password (EnrollmentPassword) on page 27

Installing Session Manager



# Installation action Link to installation description

10 Create and install an authenticationfile for Session Manager.

Authentication files for SessionManager on page 28

11 Configure Session Manager usingthe SMnetSetup command.

Configuring Session Manager withSMnetSetup on page 31

12 Ping the System Manager from theSession Manager server to ensurethat the Session Manager isconnected to your network.In case of Geo-Redundant SystemManager, make sure that SessionManager can ping both SystemManagers. If the Primary SystemManager is down, make sure that thesecondary System Manager is up.

13 Administer Session Manager. Session Manager administrationchecklist on page 35

14 Configure the Alarming setup. Activating and Managing the SessionManager serviceability agent onpage 33

15 Test the installation. Checking the Session Managerservice state on page 39

Note:Change the service state of the newly installed Session Manager to Accept New Serviceusing Session Manager Dashboard.

Note:Use SMnetSetup to change the DNS configuration. The command SMnetSetup can berun safely without interrupting service.

Caution:Do not restart SIP server instead restart the Session Manager server.

Configuring the laptop for direct connection to the serverAbout this taskBefore you connect the laptop to the server, you must manually configure the following:

Configuring the laptop for direct connection to the server


• IP address• Subnet mask• Default gateway

Note:

1. Make a note of the changes you make on your laptop for restoring to the standardconfiguration.

2. The following procedure is for Windows XP. The procedure may differ for otherversions of Windows.

Procedure

1. To configure the laptop to connect to the server, right-click My Network Places.

2. Click Properties.

3. In the Local Area Connection Properties dialog box, in the General tab, clickProperties.

4. Click Internet Protocol (TCP/IP) from the list of items.

5. Click Properties.

6. In the Internet Protocol (TCP/IP) Properties dialog box, under the General tab,select Use the following IP address.

Warning:Do not click the Alternate Configuration tab.

7. In the IP address field, enter 192.11.13.5.

8. In the Subnet mask field, enter 255.255.255.252.

9. In the Default gateway field, enter 192.11.13.6.

10. Click OK.

Disabling proxy servers in Microsoft Internet ExplorerAbout this taskTo connect directly to the services port, disable the proxy servers in Internet Explorer.

Procedure

1. Start Internet Explorer.




2. Select Tools > Internet Options.

3. Click the Connections tab.

4. Click LAN Settings.

5. Clear the Use a proxy server for your LAN option.

Tip:To reenable the proxy server, select the Use a proxy server for your LAN optionagain.

6. Click OK to close each dialog box.

Disabling proxy servers in Mozilla FirefoxAbout this taskTo connect directly to the services port, disable the proxy servers in Firefox.

Note:This procedure is for Firefox on a Windows-based computer. The steps can vary slightly ifyou are running Linux or another operating system on your laptop.

Procedure

1. Start Firefox.

2. Select Tools > Options.

3. Select the Advanced option.

4. Click the Network tab.

5. Click Settings.

6. Select the No proxy option.

Tip:To reenable the proxy server, select the appropriate option again.

7. Click OK to close each dialog box.

Disabling proxy servers in Mozilla Firefox


Connecting a laptop to the serverBefore you begin

• Ensure that you have an SSH client application, such as PuTTY, installed on yourlaptop.

• Configure the IP settings of the laptop for direct connection to the server. See the earliertopics.

• Disable the use of proxy servers. See the earlier topics.The remote services laptop is only for SSH access to Session Manager. Session Managerdoes not support Web access.

Procedure

1. Connect the laptop to the services port Eth1 with a standard or crossover Ethernetcable. See Ethernet port labels by server type on page 21 for the services port labelon a particular server.

2. Start an SSH client application, that is PuTTY, session.

3. In the Host Name (or IP Address) field, enter 192.11.13.6.The system assigns the IP address 192.11.13.6 to the services port.

4. Verify that the protocol is SSH.

5. Verify that the Port is 22.

6. Click Open.

Note:When you connect to the server for the first time, the system displays the PuTTYSecurity Alert window.

7. Click Yes to accept the server host key and display the PuTTY window.

8. Log in using craft on Session Manager or admin on System Platform or SystemManager.

9. To close PuTTY, enter exit.

Activating entitlementsWhen entitlements are activated, PLDS sends an Activation Record to the registered customeremail address. This email contains the entitlement details and the license file. To use the




license file, you must install the license on the System Manager server, which is the LicenseHost WebLM server.

Before you beginTo install a license on a server, you must have license activation codes (LAC) and the Host IDof the System Manager server, which is the WebLM server.

Procedure

1. Enter http://plds.avaya.com in the address bar of your Web browser toaccess the Avaya PLDS Web site.

2. Enter your Login ID and password to log on to the PLDS Web site.

3. Enter LAC, which you have received through an email, in the LAC(s) field in theQuick Activation section.

4. Enter the host information.

5. Click Next to validate the registration detail.

6. Enter System Manager or other WebLM server information.The Host ID is the MAC address from the machine hosting the WebLM server. Formore information on how to obtain MAC address, click Help.

7. Enter the number of licenses you want to activate.

8. Read and accept the Avaya Legal Agreement.

9. Send a confirmation email:

a. Enter any additional certificate recipient email addresses in the E-mail to:field.

b. (Optional) Enter Comments.c. Click Finish.

10. Click View Activation Record and verify the information.

Enrolling a password (Enrollment Password)About this taskWhen you enroll a password, the System Manager and Session Manager servers form a bondof trust. You need the Trust Management Enrollment Password to install and configure theSession Manager software.

Procedure

1. On the System Manager Web console, in the Services column, click Security >Certificates > Enrollment Password.

Enrolling a password (Enrollment Password)


http://plds.avaya.com

2. If a password already exists and the Time Remaining is not 0, skip the remainingsteps. The enrollment password is already valid. Make note of the passworddisplayed on the screen for future reference.

3. In the Password expires in box, select a value from the drop-down menu for thetime when the password should expire.

4. If a password already exists, copy the password to the Password box.

5. If a password does not exist, do one of the following:

• Click Generate to use a randomly generated string as a password.

• Enter a password in the Password field and click Commit.

• Make note of the password displayed on the screen for future reference.

Note:The system updates the time displayed next to the Time remaining label withthe value selected in the Password expires in field.

Authentication files for Session Manager

Note:Beginning with Session Manager 6.2, you must create and install an authentication file.

The authentication file contains Access Security Gateway (ASG) keys and the server certificatefor Session Manager. With the ASG keys, Avaya Services can securely gain access to thecustomer system.

A default authentication file is installed with Session Manager. However, replace the defaultfile with a unique file. Authentication File System (AFS) creates unique authentication files.AFS is an online application available at HTTP://RFA.AVAYA.COM.

AFS authentication files have a plain text XML header with encrypted authentication data andan encrypted server certificate. Each authentication file contains an authentication file ID(AFID) to identify the file. You need this AFID to create a new authentication file for an upgradeor to replace the current authentication file on the server.

Note:You must install the unique authentication file. Failure to install the unique authenticationfile results in receiving an alarm that re-transmits once a day until you install this file.

Related Topics



HTTP://RFA.AVAYA.COM


• Starting the AFS application on page 29

• Creating an authentication file for a Session Manager on page 29

• Installing an authentication file on page 30

Starting the AFS applicationBefore you beginAFS is available only to Avaya service personnel and Avaya Partners. If you are a customerand need an authentication file, contact Avaya or your authorized Avaya Partner.

You must have a login ID and password to start the AFS application. You can sign up for alogin at http://rfa.avaya.com.

About this taskProcedure

1. Type http://rfa.avaya.com in your Web browser.

2. Enter your login information and click Submit.

3. Click Start the AFS Application.A security message is displayed.

4. Click I agree.The AFS application starts.

Creating an authentication file for a Session ManagerAbout this taskTo acquire an authentication file, use one of the following options:

• Download the authentication file directly from AFS.• Receive the authentication file in an email.

Procedure

1. Log in to AFS.

2. In the Product field, select SM Session Manager.

3. In the Release field, select the release number of the software and then clickNext.

Starting the AFS application


http://rfa.avaya.com

http://rfa.avaya.com

4. Select New System, and then click Next.

5. If you want to download the authentication file directly from AFS to your computer:

a. Click Download file to my PC.b. Click Save in the File Download dialog box.c. Select the location where you want to save the authentication file, and then click

Save.d. Click Close in the Download complete dialog box to complete the

download.

After the authentication file is created, AFS displays a confirmation message thatcontains the system type, release, and authentication file ID (AFID).

6. To receive the authentication file in an e-mail message:

a. Enter the e-mail address in the Email Address field.b. Click Download file via email.

AFS sends the e-mail message that includes the authentication file as anattachment and the AFID, system type, and release in the message text.

c. Save the authentication file to a location on the computer of the e-mailrecipient.After the authentication file is created, AFS displays a confirmation messagethat contains the system type, release, and authentication file ID (AFID).

7. To view the header information in the authentication file, go to the location whereyou saved the file and open the file with WordPad.The header includes the AFID, product name and release number, and the dateand time that the authentication file was generated.

Installing an authentication fileProcedure

1. Log in as craft or customer to a console on the Session Manager server or useSSH for remote login.

2. Type echo $HOME.

3. Using WinSCP or some other file transfer program, transfer the authentication fileto the Session Manager server into the directory represented by $HOME.

4. Load the authentication file manually using loadpwd command as shown below:loadpwd -l <path to the auth file>.




Next stepsUse the displaypwd command to display information about the currently loadedauthentication file.

Configuring Session Manager with SMnetSetupAbout this taskSession Manager is shipped with the following configuration:

• System Name: avaya-asm• Eth0: 192.168.0.2/24• Eth1: 192.11.13.6/30• DNS Domain: localdomain• DNS Server: 127.0.0.1

Procedure

1. Connect Ethernet Ports by using cables to the customer Local Area Networkaccording to the server type. See Ethernet port labels by server type on page 21for the port labels for the different servers.

2. Connect the laptop to the server, or connect a monitor and USB keyboard to theserver.

3. Login to the Session Manager as craft.

4. Enter the command SMnetSetup5. For the information required by SMnetSetup, see Session Manager configuration

information worksheet on page 63.

a. Enter the Session Manager server hostname.b. Enter the Session Manager IP address (Mgmt).c. Enter the Netmask.d. Enter the Gateway IP address.e. Enter the Network Domain.f. Enter the Primary DNS server IP address.g. Enter the Secondary DNS (if applicable).h. Enter the Tertiary DNS (if applicable).i. Configure the local time zone.j. When prompted for Disable NTP?, enter no.k. Enter the NTP server.l. Enter the Secondary NTP server (if applicable).m. Enter the Tertiary NTP server (if applicable).

Configuring Session Manager with SMnetSetup


n. At the prompt, press Enter.o. When prompted, create a customer account with a password.p. Enter the Primary System Manager IP Address.

SMnetSetup automatically configures the System Manager relatedconfigurations. In case when System Manager is unreachable, then enter thefollowing information.

q. Enter “y” if System Manager is setup with Geographic Redundancy.r. Enter the Primary System Manager FQDN.s. Enter the Secondary System Manager IP address (if necessary).t. Enter the Secondary System Manager FQDN (if necessary).u. Enter the virtual System Manager FQDN.v. Verify your settings.w. Enter the enrollment password.

6. At this point, the system configures automatically. The configuration takesapproximately 15 minutes to complete.

Alarming Configuration

Network Management Systems DestinationsThe Session Manager serviceability agent can send SNMPv2c/v3 traps or Informs for alarmsto multiple destinations such as:

• SAL Gateway (mandatory)

• System Manager Trap Listener

• Third-party NMS

• Avaya SIG server

SAL Gateway is a mandatory trap destination for traps sent to Avaya Services for systemmaintenance. SAL Gateway converts the traps to alarms and forwards the alarms to the AvayaData Centre for ticketing purposes. Therefore, after you install or upgrade from release earlierthan 6.2 to Session Manager Release 6.2 or later, you must configure the serviceability agentwith the SAL Gateway as a trap destination. The serviceability agent configuration is performedusing System Manager Web Console. You must also configure Session Manager as amanaged device on the SAL Gateway. Optionally, you can configure any third-party NetworkManagement Systems (NMS) as a trap destination. Based on customer requirements, Avayatechnicians can also configure Avaya SIG server as another trap destination.




For upgrades from Release 6.2 or later, the configuration of the serviceability agent persiststhrough the Session Manager upgrade.

Activating and Managing the Session Manager serviceability agentAbout this taskActivating and managing the Session Manager serviceability agent is performed using theSystem Manager web console. To add an NMS destination, you must create a target profilefor the NMS destination and then attach the target profile to a serviceability agent. For moreinformation on activating agents and attaching target profiles, see Chapter 7, SNMP Supportfor Session Manager in the Maintaining and Troubleshooting Avaya Aura® Session Managerguide.

For the Geographic Redundant system setup, administer both System Manager instances astargets for the alarming.

Alarming Configuration


Chapter 5: Session Manager administration

IntroductionAfter the Session Manager installation, perform the following basic administrative steps at thecustomer site:

1. Add SIP Domains.

2. Add Session Manager as SIP entities.

3. Administer Session Manager instances. Configure the following:

a. Routing settings

b. Security default settings

c. User account setup

For a complete description of Session Manager administration, including administration of aGeographic Redundant system, see Administering Avaya Aura® Session Manager.

Session Manager administration checklistUse the following checklist for the initial administration of a newly-installed SessionManager.

# Administration action Link to administration action

1 Log into the System Managerassociated with this SessionManager.

2 Add Domain Names. Adding domain names for SessionManager on page 36

3 Add the installed Session Manager asa SIP Entity.

Adding Session Manager as a SIPentity on page 36

4 Administer the Session Manager. Administering Session Manager onpage 37


Adding domain names for Session ManagerProcedure

1. On the System Manager Web console, click Elements > > Routing > Domains.

2. Click New.

3. In the Name field, enter the Network Domain Name of Session Manager.

4. In the Type field, click SIP.

5. (Optional) Enter a description in the Notes field.

6. Click Commit.

Adding Session Manager as a SIP entityProcedure

1. On the System Manager Web console, Elements > Routing > SIP Entities.

2. Select New

3. In the Name field, enter the name of Session Manager.

4. In the FQDN or IP Address field, enter the IP address of the Session ManagerSecurity Module. This IP address is not the management IP address.

5. In the Type field, set the type to Session Manager.

6. In the Port section of the screen, click Add to add all port, protocol, and defaultdomain entries for each port and protocol on which the Session Manager will listenfor SIP traffic. Add Failover ports if the SIP entity is a failover group member. SeeFailover Groups section in the Administering Avaya Aura® Session Manager,03-603324 book for details.

7. Click Commit.

Session Manager administration



Administering Session ManagerProcedure

1. On the System Manager Web console, Elements > Session Manager > SessionManager Administration.

2. In the Session Manager Instances, select New.

3. In the SIP Entity Name field, enter the name of Session Manager.

4. (Optional) In the Description field, enter a description for Session Manager .

5. In the Management Access Point Host Name/IP field, enter the IP address of thehost on which the Session Manager is installed.

6. In the Network Mask field, enter the network mask of the Session Manager SecurityModule.

7. In the Default Gateway field, enter the default gateway of the Session ManagerSecurity Module.

8. Ensure that the Enable Monitoring box is checked by default.For more information regarding SIP monitoring, see Administering Avaya Aura®

Session Manager.

9. Click Commit.NOTE: After you administer the Session Manager instance, the configurationchanges may take several minutes to replicate to the Session Manager servers.Wait a few minutes before you continue with validation of the configuration.

Administering Session Manager


Session Manager administration



Chapter 6: Testing the installation

Checking the Session Manager service stateProcedure

1. Log in to the System Manager as an administrator using the admin login.

2. In Elements, select Session Manager .The service state for the new Session Manager must be Deny New Service.

3. If the system displays dashes as Service State for the installed Session Manager,see Unable to access Service State on page 59 for troubleshooting information.

Testing the System Manager and Session Managerinstallation

About this taskPerform the following steps to verify System Manager and Session Manager are installed andconfigured properly, and that the servers and applications are communicating.

Procedure

1. On System Manager Web Console, select Elements > Session Manager >System Tools > Maintenance Tests

2. Select System Manager from the Select Target drop-down list.

3. Click Execute All Tests.

4. Verify all tests display Success.

5. On System Manager Web Console, select Elements > Session Manager >System Status > Security Module Status.

6. Verify the status is Up for all Session Managers.

7. Verify the IP address is correct.


8. If the status is Down, reset the security module:

• Select the appropriate Session Manager from the table.

• Click Reset.

Warning:Session Manager cannot process calls while the security module is beingrestarted.

9. On System Manager Web Console, select Elements > Session Manager.

10. On the Session Manager Dashboard page, verify that the installed softwareversions of all Session Managers are the same.

Note:Perform this step after all the Session Manager instances in the network areupgraded.

11. Verify that all Session Manager servers are in the Accept New Service state underService State.

12. On System Manager Web Console, select Elements > Session Manager >System Tools > Maintenance Tests.

13. Select the appropriate Session Manager instance.

14. Select Execute All Tests.

15. Verify that all tests ran successfully.

16. Check the replication status of the Session Managers:

a. On System Manager Web Console, select Services > Replication.The Synchronization Status must be green and the status should beSynchronized.

b. If the status is not Synchronized, select the check box next toSessionManagers (type Replica Node) and click View Replica Nodes todetermine which Session Manager is not synchronized with System Manager.

17. Verify that there are no active alarms for Session Manager. To view alarms on theSystem Manager web console, in Services, select Events > Alarms.

18. If System Manager and customer NMS are configured to forward alarms, generatea test alarm to verify forwarding of alarms. See Generating a test alarm onpage 41.

Note:You can also use Session Manager Dashboard to verify that the installed SessionManager is ready for service.

19. For Geographic Redundant systems, verify the following:

• Ping the vFQDN of the System Managers to make sure connectivity is good.

Testing the installation



• Using System Manager Data Replication Service, verify that the SessionManager is in the DRS node list and is synchronized.

• Using System Manager Inventory, verify that the managed elements in themanaged by column show the correct value of the managing SystemManager.

Generating a test alarmAbout this taskThe generateTestAlarmSM.sh command generates a test alarm and sends the alarm to thetargets assigned to the serviceability agent. These targets may include:

• SAL Gateway (alarm is forwarded to ADC)• System Manager Trap Listener• Third-party NMS• Avaya SIG server

Procedure

1. To generate a test alarm, enter the Session Manager CLI commandgenerateTestAlarmSM.sh.

2. Verify that the System Manager received the test alarm message:

a. On the System Manager Web Console, select Services > Events > Alarms.b. Verify the following text is displayed under the Description column: Test alarm

for testing only, no recovery action necessary.

3. If the serviceability agent is configured with other targets, verify the other targetsalso received the test alarm.

Verifying Data Replication to Session ManagerProcedure

1. On the System Manager Web console, click Services > Replication.

2. Verify that the status for the appropriate replica group is Synchronized.

Generating a test alarm


3. If the replica group is not in a Synchronized, Queued for Repair, or Repairingstate, refer to Branch Session Manager fails to completely install on page 61.For more information, see Unable to access Service State on page 59.

Testing the installation



Chapter 7: Session Manager redundancy

Session Manager uses the active-active approach where two instances are simultaneously active.Session Manager routes request to either instance, and a failure of one of the Session Manager instancesdoes not interrupt service. Active-active redundancy requires Session Manager instances to beinterconnected over an IP network with sufficient bandwidth and low latency to synchronize runtimedata.

Configuring Session Manager redundancy on the sameSystem Manager

About this taskIn the following configuration example, SM-1 is one Session Manager instance and SM-2 isthe active backup.

Route-through failover relies on Communication Manager look-ahead routing to choosealternate routes. The route pattern form adds the secondary or failover trunk groupadministration.

If you use Local Host Name Resolution load balancing, you do not need additionaladministration if you reuse the same Port IDs and IP addresses, such as C-LANs or procr, forthe added SM-2 trunk groups..

Procedure

1. Add SM-2 as the backup Session Manager server.

2. On SM-2, create the entity links that exist on SM-1. For example, VP-1.

3. For route-through failover, add an entity link SM-1 to SM-2.

4. Add the trunk setup on your device, such as Communication Manager and VoicePortal. For example, if you have a Communication Manager signaling group toSM-1, you must add a Communication Manager signaling group to SM-2.All other administration is accessible to SM-2 automatically. You do not need toperform additional dial plan administration.


Session Manager redundancy



Chapter 8: Survivable Remote SessionManager

This section describes how to install, configure, and administer a Communication Manager with aSurvivable Remote Session Manager (also called as Branch Session Manager).

Prerequisites• Install and administer System Manager and the core Session Manager and ensure both

are operational.

• Install and administer the main Communication Manager server

• Ensure that the main Communication Manager is administered as a SIP entity on SessionManager.

Survivable Remote Session Manager With the Survivable Remote Session Manager, you can enable Survivable Remote Server-style survival capabilities for a customer with SIP phones in a branch. The Survivable RemoteSession Manager supports a total WAN outage in the branch when all the devices in the branchnetwork have lost connectivity to all of the devices in the core network.

Survivable Remote sites include a Session Manager and a Communication Manager. TheCommunication Manager is configured either as a feature server or an evolution server. SIPphones simultaneously register to the primary Session Manager, secondary Session Manager,and the Survivable Remote Session Manager. During a WAN outage, SIP phones failover tothe Survivable Remote Session Manager and the Survivable Remote CommunicationManager provides feature functionality.

When the Survivable Remote Session Manager is active in survivability mode, theadministrative changes made in System Manager takes effect as long as the SurvivableRemote Session Manager has network connectivity to the System Manager.

When a Survivable Remote Session Manager is installed, there is no SIP routing. The serverfunctions as a traditional Survivable Remote Server. You can activate Survivable RemoteSession Manager if the customer decides to add SIP at a later time.


You can install and configure Survivable Remote Session Manager on System Platform usingCommunication Manager Survivable Remote templates.

Installation overviewPerform the following steps for installation and administration:

• Administer the Survivable Remote Server on the main Communication Manager server.

• Install the necessary hardware and equipment for the survivable server.

• Install System Platform on the survivable server.

• Install and configure the Communication Manager Survivable Remote template on thesurvivable server.

• Administer the Survivable Remote Server using System Manager.

The Communication Manager Survivable Remote templates include the following applications:

• Communication Manager

• Branch Session Manager

• Utility Services

The Simplex Survivable Remote is installed on Avaya S8800, HP ProLiant DL360 G7, orDell™ PowerEdge™ R610 Server. You can install Simplex Survivable Remote on an AvayaS8510 server with 8-GB memory as an upgrade only. Embedded Survivable Remote isinstalled on Avaya S8300D server in a G250, G350, G430, G450, or G700 Gateway.

Survivable remote installation checklistSurvivable remote installation and administration requires using more than one document. Thefollowing table contains the procedures for installing, configuring, administering, and testingthe Survivable Remote Server and the documents to use for different procedures.

Complete the following procedures, which are not part of the checklist, on the coreCommunication Manager and Session Manager servers:

• Install, obtain the license, and configure the main Communication Manager either as afeature server or evolution server, and ensure that the server is operational.

• Administer the main Communication Manager as a SIP Entity on System Manager.

Survivable Remote Session Manager



Note:

• Before you install the survivable remote, ensure that you add all Branch SessionManagers to the DNS or to the /etc/hosts file on System Manager.

• Ensure that you synchronize the date and time with System Manager and SystemPlatform. A clock shift can cause certificate and DRS replication problems.

# Task Book or link to use Notes

1 Complete theSurvivable Remoteconfigurationinformation worksheetand verify theinformation is correct.

Survivable Remoteconfiguration informationworksheet on page 65

2 Administer theSurvivable RemoteServer on the mainCommunicationManager.

Survivable Remote SATadministrationchecklist on page 49

3 Install the SurvivableRemote SessionManager

If you are installing anAvaya S8800 server, seeInstalling the AvayaS8800 Server for AvayaAura™ CommunicationManager, 03-603444

If you are installing anAvaya S8510 server, seeUpgrading to Avaya Aura® CommunicationManager, 03–603560

Ensure that theS8510 server has8GB of memoryand aCommunicationManagerMigration kit.

If you are installing an HPProLiant DL360 G7server, see Installing theHP ProLiant DL360 G7Server (03-603799)

If you are installing aDell™ PowerEdge™ R610server, see Installing theDell™ PowerEdge™ R610Server (03-603739)

Survivable remote installation checklist


# Task Book or link to use Notes

If you are installing anAvaya S8300D server,see

• Quick Start forHardware Installation:Avaya G250 Gateway,03-300433




• Quick Start forHardware Installation:Avaya G700 Gateway,555-233-150

See the book thatmatches yourparticular GxxxGateway.

4 Install System Platformon the server.

Implementing Avaya Aura® CommunicationManager, 03-603558

5 Install the appropriateCommunicationManager templateusing the SystemPlatform Web console.

Implementing Avaya Aura® CommunicationManager, 03-603558

When youperform this step,you install BranchSessionManager.

6 Configure theCommunicationManager

Implementing AvayaAura® CommunicationManager, 03-603558

Configure ServerRole and NetworkConfiguration.

7 Administer, verify, andtest the SurvivableRemote Server usingSystem Manager.

Survivable RemoteSession Manageradministrationchecklist on page 51




Survivable Remote SAT administration checklistPrerequisites:

• Configure the Processor Ethernet IP address (procr) for the main CommunicationManager using the add ip-interface procr SAT command or using the CommunicationManager Web interface.

• If applicable, add the gateway using the add media-gateway x SAT command.• If applicable, update the mgc lists of the gateways with the IP addresses of both the main

Communication Manager server Processor Ethernet IP address, that is the first entry, andthe Survivable Remote Processor Ethernet IP address, that is the second entry.

• Ensure that System Manager and Session Manager are already active in an existing SIProuting deployment.

• Ensure that at least one SIP signaling group uses procr as the near-end node name.

# Administration Link

1 Log in to the CommunicationManager server.

2Administer the survivableprocessor configurationinformation.

Adding a Survivable Remoteserver on page 49.

3 If a gateway is part of the enterprise,validate the Recovery Rule.

Validating Gateway recoveryrule on page 50

4If a gateway is part of the enterprise,verify the Minimum time of networkstability.

Validating the minimum time ofnetwork stability on page 50.

Adding a Survivable Remote serverProcedure

1. Type add survivable-processor node-name, where node-name is thename of the remote server, and press Enter. For example, add survivable-processor lsp6.The system displays the SURVIVABLE PROCESSOR screen.

2. In the Type field, type lsp for an LSP or a Survivable Remote server.

Survivable Remote SAT administration checklist


3. Ensure that the value of the Cluster ID/MID field matches with the value of the MIDnumber field.The MID number field is on the Server Role page of the Server Maintenancesection on the Communication Manager System Management Interface Webpage.

4. Save the changes.

Validating gateway recovery ruleProcedure

1. Type change media-gateway x, where x is the gateway number, and pressEnter.The system displays the MEDIA GATEWAY x screen.

2. In the Recovery Rule field, type the recovery rule number associated with thegateway or type none to disable the recovery rule.The value none indicates that the system does not accept any automatic fallbackregistrations.You can apply a single rule to all gateways, or each gateway can have its own ruleand any permutation in between. You can administer the recovery rule by using thesystem-parameters mg-recovery-rule command.


Validating the minimum time of network stabilityAbout this taskUse this procedure to set the minimum time of network stability to three minutes. With the three-minute timer, the gateway can failback to the Communication Manager feature server orevolution server when it becomes available. The three-minute timer also prevents unnecessaryfailback and failover when the network is unreliable.

Procedure

1. Type change system-parameters mg-recovery-rule n, where n is the rulenumber, and press Enter. For example, change system-parameters mg-recovery-rule 1.The system displays the SYSTEM PARAMETERS MEDIA GATEWAYAUTOMATIC RECOVERY RULE screen.




2. In the Minimum time of network stability field, type 3.


Survivable Remote Session Manager administrationchecklist

The following checklist contains the steps to administer a survivable remote Session Managerserver using System Manager.

# Administration Link

1 Log in to the System Manager Webconsole.

2Add the Survivable RemoteSession Manager server as a SIPEntity.

Adding a Survivable Remoteserver as a SIP entity onpage 52.

3

Create Entity Links between theSurvivable Remote SessionManager server andCommunication Manager.

Creating entity links on page 52.

4

Verify the connections betweenCommunication Manager and thesurvivable remote SessionManager server.

Checking the connections onpage 53.

5 Administer the Survivable RemoteSession Manager server.

Administering a survivable remoteserver on page 53.

6Verify the survivable remote serverinformation in the /etc/hosts file onthe System Manager server.

Verifying survivable remoteinformation on page 55.

7 Verify the avaya-lsp-fs information. Verifying avaya-lsp-fsadministration on page 55

8 Verify the registration. Verifying survivable remoteinformation on page 55.

9Test Communication Manager withthe Survivable Remote SessionManager server.

Testing calls on page 57.

Survivable Remote Session Manager administration checklist


Adding a Survivable Remote server as a SIP entityProcedure

1. Log on to the System Manager Web interface.

2. Click Elements > Routing.

3. In the navigation pane on the left side of the page, click Routing > SIP Entities.

4. Click New.

5. In the FQDN or IP Address field, type the IP address of the security module of theSurvivable Remote Session Manager server.

6. In the Type field, select Session Manager.

7. Click Commit.

Creating entity linksAbout this taskWhen applicable, create the entity links between the following:

• Each Session Manager server and Communication Manager feature server or evolutionserver.

• Survivable Remote Session Manager server and Communication Manager feature serveror evolution server.

If you use separate entities and entity links, such as for an feature server and trunk gatewayconfiguration, you must administer two entity links for each entity on the Survivable Remoteserver. However, if you use only one entity and entity link, such as for an evolution serverconfiguration, you must administer only one entity link on the Survivable Remote server.

Procedure

1. Log on to the System Manager Web interface.

2. Click Elements > Routing.

3. In the navigation pane on the left side of the page, click Routing > Entity Links.

4. Click New.

5. In the Name field, type a descriptive name for the entity link.

6. In the SIP Entity 1 field, select the Survivable Remote Session Manager server.

7. In the Protocol field, select tls.




8. In the Port field, type 5061.

9. In the SIP Entity 2 field, select the Communication Manager server.

10. In the Port field, type 5061.

11. In the Connection policy list box, select Trusted.

12. (Optional) In the Notes field, type a short description about the entity link.

13. Click Commit.

Checking the connectionsProcedure

1. Check the Survivable Remote Session Manager SIP Entity Link status:

a. On System Manager Web console, in Elements, select Session Manager >System Status > SIP Entity Monitoring.

b. Select the Survivable Remote Session Manager name from the list in the tableSIP Entities Status for All Monitoring Session Manager Instances.

c. Verify that the Link Status is Up for the Survivable Remote SessionManager.

2. Check the Session Manager Dashboard:

a. On System Manager Web console, under Elements , select SessionManager .

b. On the Session Manager Dashboard page, click the Entity Monitoring column.For Survivable Remote Session Manager, the status is (---).The Session Manager Entity Link Connection Status page opens.

c. Verify the entity monitoring status of Survivable Remote Session Manager.

Administering a survivable remote serverBefore you beginEnsure that the SIP entity that you want to add is created. For a Session Manager SIP entity,ensure that the listen ports are administered on the SIP entity form. Endpoints use these listenports to connect to the survivable remote server and to map different ports to different domains.For details regarding administration of listen ports, see Administering Avaya Aura® SessionManager.

Survivable Remote Session Manager administration checklist


Procedure

1. Using the System Manager web interface, in Elements, select Session Manager> Session Manager Administration.

2. Click New in the Branch Session Manager Instances section.

3. In the General section:

a. Select the survivable remote SIP entity from the SIP Entity Name drop-downlist.

b. (Optional) In the Description field, add a comment.c. In the Management Access Point Host Name/IP field, add the IP address of

the host on which the management agent is running. This IP address is not theSecurity Module IP address.

d. Select the Communication Manager server from the Main CM for LSP drop-down menu.

e. Select Enable for Direct Routing to Endpoints from the drop-down list if it isnot enabled already.

f. If applicable, select Adaptation for Trunk Gateway from the drop-downmenu.You can use the default adaptation, which is the adaptation used for the trunkgateway entity that this survivable remote server subtends. You can alsospecify a different adaptation here. When you specify a different adaptation, thesystem overrides the default adaptation. If you administer two entities, one fora feature server and one for a trunk gateway, then the adaptation applies onlyto the trunk gateway entity. If you use a single entity, then the adaptation appliesto application-sequenced and trunk-gateway routed calls.

4. In the Security Module section:

a. The SIP Entity IP Address field is automatically populated with the IP addressof the SIP entity.

b. In the Network Mask field, enter the value for the network mask.c. In the Default Gateway field, enter the applicable IP address.d. For the Speed & Duplex field, select Auto from the drop-down menu.

For details about other fields, see Administering Avaya Aura® SessionManager.

5. Click Commit.




Verifying survivable remote informationAbout this taskVerify the survivable remote server information.

Procedure

1. Log in to the System Platform Web console.

2. Select Server Management > Network Configuration.

3. Verify the following information:

• Default Gateway

• Subnet Mask located in the Netmask column and avpublic row in theDomain-0 area of the form.

• Hostnames: Ensure that Branch Session Manager Hostname is in FQDNformat.

• IP Addresses

For details about other fields, see Administering Avaya Aura™ System Platform.

4. Log out of the System Platform Web console.

Verifying avaya-lsp-fs administrationAbout this taskThis topic is related to verification of the avaya-lsp-fs value. If the avaya-lsp-fs entry ismissing, the Survivable Remote Session Manager will not initialize properly. The cause mightbe an administration error.

Procedure

1. On the System Manager Web console, click Elements > Session Manager .

2. Locate the appropriate Survivable Remote Session Manager instance in thetable.

3. On the Session Manager Dashboard page, in the Entity Monitoring column, clickthe associated entry of the server .

4. On the Session Manager Entity Link Connection Status screen:

Verifying survivable remote information


a. Verify that there is a SIP Entity with the name avaya-lsp-fs.b. Verify that the port and transport protocol information is correct.

The state is deny for this avaya-lsp-fs link when the Survivable RemoteSession Manager is inactive. This link is the same for Communication ManagerEvolution Servers as well as Communication Manager Feature Servers.

5. If the avaya-lsp-fs entry is missing, Survivable Remote Session Manager did notinitialize properly.

a. On the System Manager Web console, verify the following:

• one or two entity links from the Survivable Remote Session Manager tothe core Communication Manager are administered correctly.

• entity links from the Survivable Remote Session Manager to the coreSession Managers, that are controllers for the users on the branch, areadministered correctly.

b. Verify that the same port and transport are used as administered between theprimary Session Manager and the core Communication Manager.

c. Verify that all users that are administered with this survivability server haveapplication sequencing to a Communication Manager entity. ThisCommunication Manager entity represents the main Communication Managerthat is administered on the Branch Session Manager page.

Verifying survivable server registrationBefore you beginLog in to a Communication Manager SAT session.

About this taskIf you installed a Survivable Core or Survivable Remote template on the server, verify that thetemplate is registered with the main server. This task could take several minutes tocomplete.

Procedure

1. Enter list survivable-processor to open the Survivable Processorscreen.

2. Verify that the Reg field is set to y, indicating that the survivable server hasregistered with the main server.

3. Verify that the Translations Updated field shows the current time and date,indicating that the translations have been pushed down to the survivable server.




Testing callsTest calls between the Survivable Remote Session Manager server and the mainCommunication Manager server.

Procedure

1. Place a phone call from one SIP extension to another and stay online.

2. To test the survivable remote functionality, disconnect Session Manager and mainCommunication Manager from the network.

3. Validate that the connections failover.

4. Re-establish the network connections to Session Manager and the mainCommunication Manager server.

Testing calls


Chapter 9: Troubleshooting

The following sections describe troubleshooting steps for errors that may occur during installation oradministration of the Session Manager server or the Survivable Remote Session Manager server.

Server has no powerEnsure that:

Procedure

1. You plug the power cord to the server and into a non-switched outlet oruninterrupted power supply (UPS).

2. You install the power supply bay and check that the bay is seated securely, if theserver has a single power supply.

3. You plug the UPS into a non-switched outlet.

4. The outlet has power.

5. The light emitting diodes (LED) of the server have the power supply. Check whetherthe alternate current (AC) LED and the direct current (DC) LED are both lit duringnormal operation.

Unable to access Service StateAbout this taskIn the Session Manager Dashboard page, check the Service State of the Session Manager.If the Service State shows an unknown value, then proceed with the following troubleshootingprocedure.

Procedure

1. Check the cable for Eth0 and Eth2. See Ethernet port labels by server type onpage 21 for the correct port labels.

2. Create an SSH session to the System Manager IP address (not the Dom0 or Cdom)using the customer account specified during the template install.


3. Create an SSH session to the Session Manager with the Management Interface IPaddress using the craft or customer login.

4. Enter the command ./SMnetSetupFor the information required by SMnetSetup, see Session Manager configurationinformation worksheet on page 63.

Issues with replica group state

Troubleshooting stepsAbout this taskPerform the following troubleshooting steps if the replica group state is not Synchronized,Queued for Repair, or Repairing, or if the replica group is stuck in the Starting state.

Procedure

1. Log in to the System Manager Web interface.

2. Under the Services column, select Replication.

3. Select the appropriate Replica Group for the Session Manager server.

4. Click on View Replica Nodes.

5. Verify information in the /etc/hosts file of the System Manager:

a. Log in to the CLI of the System Manager..b. Verify that the /etc/hosts file has the IP address, FQDN, and hostnames of

itself and all of the associated Session Managers (applicable only if DNS is notused for host resolution of an IP address).

c. Make corrections as needed.

6. Use the smconfig command to verify the basic data entry values of SessionManager.

7. Enter initTM. The command should complete within 10 minutes. If it does notcomplete within that time, continue with the next step.

8. Verify that the system date and time on the Session Manager server is in sync withthe system date and time on the System Manager virtual machine. Trust certificateinitialization can fail if the clocks differ by more than a few seconds.

9. Verify the information on the Network Configuration page on the System PlatformWeb Console (Server Management > Network Configuration).

Troubleshooting



10. On System Manager, check to see if Session Manager is synchronized.

Survivable server fails to sync with main server

Branch Session Manager fails to completely installCM_SurvRemote and CM_SurvRemoteEmbed templates include Branch Session Manager.After the template installation is finished, allow 20 additional minutes for the Branch SessionManager virtual machine to install and initialize. The Virtual Machine Management page onthe System Platform Web console should list the Branch Session Manager’s application stateas Running. If not, follow these troubleshooting steps.

Troubleshooting stepsProcedure

1. Within the survivable remote server:

a. Access the Communication Manager System Management Interface.b. In the navigation pane, click Server Configuration > Server Role.c. Verify that the This Server is field is set to a local survivable processor (LSP)

and the other fields are filled out correctly.

Note:If you change any of the configuration settings, click Restart CM to restartCommunication Manager.

2. Within the main server:

a. Start a SAT session.b. Enter list survivable-processor.c. Verify that the following fields are set correctly:

• Reg: y. If set to n, then the survivable remote server has not registeredwith the main server.

• Act: n

• Translation Updated: Shows a timestamp.

Survivable server fails to sync with main server


Troubleshooting steps

About this taskPerform the following troubleshooting steps if the replica group state is not Synchronized,Queued for Repair, or Repairing, or if the replica group is stuck in the Starting state.

Procedure

1. Log in to the System Manager Web interface.

2. Under the Services column, select Replication.

3. Select the appropriate Replica Group for the Session Manager server.

4. Click on View Replica Nodes.

5. Verify information in the /etc/hosts file of the System Manager:

a. Log in to the CLI of the System Manager..b. Verify that the /etc/hosts file has the IP address, FQDN, and hostnames of

itself and all of the associated Session Managers (applicable only if DNS is notused for host resolution of an IP address).

c. Make corrections as needed.

6. Use the smconfig command to verify the basic data entry values of SessionManager.

7. Enter initTM. The command should complete within 10 minutes. If it does notcomplete within that time, continue with the next step.

8. Verify that the system date and time on the Session Manager server is in sync withthe system date and time on the System Manager virtual machine. Trust certificateinitialization can fail if the clocks differ by more than a few seconds.

9. Verify the information on the Network Configuration page on the System PlatformWeb Console (Server Management > Network Configuration).

10. On System Manager, check to see if Session Manager is synchronized.

Troubleshooting



Appendix A: Worksheets

The following worksheets contain the information that you need for administering Session Manager andSession Manager related entities using System Manager.

Important:Do NOT use underscores in any of the Name fields. Names may only contain letters, numbers, andhyphens. System host names cannot contain underscore characters according to Internet standardsRFC 952.

Session Manager configuration information worksheetMake one copy of the Session Manager configuration information worksheet for each SessionManager that you install.

Field Information to enter

Session Manager server host name (short name)

Session Manager IP address (Mgmt) - Eth 0 IPaddress (management interface for SessionManager on the customer network)

Netmask (Network Mask Eth0)

Gateway IP address (for Eth0)

Network Domain (that is., MyCompany.com)

Primary DNS server IP address

Secondary DNS (if applicable)

Tertiary DNS (if applicable)

DNS Search Domains (separated with a space)

System Manager Virtual IP address

System Manager Virtual FQDN

Primary System Manager IP Address

Primary System Manager FQDN

Secondary System Manager IP Address (optional)



Secondary System Manager FQDN (optional)

Local time zone

NTP server

Secondary NTP server (if applicable)

Tertiary NTP server (if applicable)

Customer Linux Login (default is cust)

Enrollment Password: Set up in the Securitysection of System Manager.

Note:Ensure that the enrollment password is active.

Session Manager Entity information worksheetYou can use the Session Manager Entity information worksheet for administering SIP entities,such as Session Manager, Communication Manager, or other SIP entity (for example, ModularMessaging and Voice Portal). The information mentioned might not apply to every type ofentity .

For each Session Manager or Communication Manager SIP entity that you administer usingSystem Manager, you require the following information:

Use this information to administer SIP Entities and Entity Links.

Field Information to EnterEntity Name

Entity Type (For example, Session Managerand Communication Manager)

Location Name

Management IP Address (that is, SAT)

FQDN

Port (For example, 5060, 5061)

Transport (For example, UDP, TCP, or TLS)

Session Manager Security Module IPAddress

Session Manager Security Module NetworkMask

Worksheets



Field Information to EnterSession Manager Security Module DefaultGateway

CLAN/PROCRNode Name

CLAN/PROCRIP Address

Signaling Group # Tunk Group #

Survivable Remote configuration information worksheetMake one copy of the Survivable Remote configuration information worksheet for eachSurvivable Remote server that you install.


Communication Manager IP address

Communication Manager Hostname

Utility Server IP address

Utility Server Hostname

SIP Entity IP Address

BSM IP address (Admin IP)

BSM FQDN

Customer Login

Customer Login Password

DHCP parameters (optional)

DNS search string

System Manager Virtual IP address

System Manager Virtual FQDN

Primary System Manager IP Address

Primary System Manager FQDN

Survivable Remote configuration information worksheet



Secondary System Manager IP Address(optional)

Secondary System Manager FQDN(optional)

Enrollment Password: Set up in theSecurity section of System Manager.

Note:Ensure that the enrollment password isactive.

The product IDs are set on SAL gateway for a BSM managed element.

Note:Additional configuration data will be required during System Platform installation. SeeSystem Platform documentation at the Avaya Support website for details.

Worksheets



Appendix B: Available media

Avaya provides the following media for Release 6.3:

• Session Manager Release 6.3 software DVD: Comcode 700504625.

• Session Manager Release 6.3 Linux 6.2 operating system kickstart DVD: Comcode 700504700.

• Session Manager Release 6.3 Linux 6.2 kickstart upgrade DVD: Comcode 700504701.

• Session Manager Release 6.3 ISO image: asm-6.3.*installer.iso.

• Session Manager Release 6.3 Linux 6.2 OS upgrade ISO image: csp-6.2-*upgrade.iso.


Available media



Appendix C: Interoperability with Avayaproducts

For compatibility information of different Avaya products that are supported with the various releases ofSession Manager, see the following link:

http://support.avaya.com/CompatibilityMatrix/Index.aspx


http://support.avaya.com/CompatibilityMatrix/Index.aspx

Interoperability with Avaya products



Appendix D: Supported hardware and PortMatrix

The various releases of Session Manager support the following servers:

Releases Servers

R1.1 S8510

R5.2 S8510, S8800

R6.0 S8510, S8800

R6.1 S8510, S8800, Dell R610 or an HP DL360 G7 server



Avaya Aura Session Manager Port Matrix documents located at https://support.avaya.com/securitycontain information on the ports and protocols used by Session Manager.


https://support.avaya.com/security

Supported hardware and Port Matrix



Appendix E: CDR record format

Session Manager generates CDR data files that contain the following two types of data records:

• Date records

• Call detail records

Date recordThe date record is a timestamp in the CDR data file. Using the date record, the CDR processing applicationrefers all call records to the new date. The date record synchronizes the CDR adjunct time and dateprocessing with the starting time and date of the information in the CDR data file. A single CDR data filecan hold multiple date records, even if there is no change in date. The Session Manager CDR systemprovides date information to the CDR data file:

• Once a day at midnight• When the date or time is manually changed on the server• When a new CDR data file is created

To avoid inconsistencies between the date record and the following call records, the server may generatea new CDR data file just before midnight with all the completed calls at that time, regardless of the scheduleat which CDR files are to be created. In the following table, the call records contain the time the call endedand the duration of the call. The remaining calls ending after midnight are reported in the next CDR file,which uses a new date record. Date records are 13 characters long. The format of the date record is asfollows:

Table 1: Date Record

Position Description

1-2 Hour (leading 0s added if needed)

3 Colon (:)

4-5 Minute (leading 0s added if needed)

6 Blank

7-8 Month (leading 0s added if needed)

9 Slash ( / )

10-11 Day (leading 0s added if needed)

12 Carriage Return

13 Line Feed

For example, a CDR date record can be of the following format:


21:32 04/16<CR><LF>

Call detail recordFor releases earlier than Session Manager 6.1, each call detail record contains 106 characters. The CDRformat is as follows:

Table 2: Call detail record for releases earlier than 6.1


1-2 Time of day in hours

3-4 Time of day in minutes

5 Duration in hours

6-7 Duration in minutes

8 Duration in tenths of minutes

9 Condition code

10-17 Space

18-32 Dialed number

33-42 Calling number

43-48 Space

49-55 Terminating SIP Entity

56-57 Space

58-64 Originating SIP Entity

65-73 Space

74 Feature flag

75-92 Space

93 Bearer Capability Class

94 MA-UUI

95 Resource flag

96-104 Space

105 Carriage return

106 Line feed

For Session Manager releases 6.1 and 6.2, each call detail record contains 108 characters. The CDRformat is as follows:

CDR record format



Table 3: Call detail record for Releases 6.1 and 6.2


1-2 Time of day-hours

3-4 Time of day-minutes

5 Duration-hours

6-7 Duration-minutes

8 Duration-tenths of minutes

9 Condition code

10-17 Space

18-32 Dialed number


43-48 Space


56-57 Space


65-73 Space

74 Feature flag

75-92 Space

93 BCC

94 MA-UUI

95 Resource flag

96-104 Space

105-106 Bandwidth

107 Carriage return

108 Line feed

For Session Manager release 6.2, each call detail record contains 228 characters. The CDR format is asfollows:

Table 4: Call detail record for Release 6.2


1-2 Time of day-hours

3-4 Time of day-minutes


5 Duration-hours

6-7 Duration-minutes

8 Duration-tenths of minutes

9 Condition code

10-17 Space

18-32 Dialed number


43-48 Space


56-57 Space


65-73 Space

74 Feature flag

75-92 Space

93 BCC

94 MA-UUI

95 Resource flag

96-104 Space

105-106 Bandwidth

107-108 Space

109-144 Av-GSID

145-170 Space (Reserved for Future use)

171-185 Calling Party IP

186-211 Space (Reserved for Future use)

212-226 Called Party IP

227 Carriage return

228 Line feed

Field description:

Time of day (4 digits): The time at which the call ended with two digit hours and two digit for minutes.

Duration (4 digits): The duration of the call, which the system records in hours (0 to 9), minutes (00 to59), and tenth of a minute (0 to 9). The system rounds off the duration of the call in increments of 6-seconds. For example, the system records the duration of a 5-second call as 0000.

CDR record format



This field reports 9999 if the call was in progress when a time change was made on the system, and thecall duration can no longer be determined. The field reports 9599 for calls that last for more than 10 hours.For more information, see condition code 4.

Bandwidth (2 digits with a maximum value of 99): The highest bandwidth used by the call, rounded tothe nearest multiple of 64k (64,000), for example:

• 0 means < 32Kbps• 1 means 64Kbps (± 32Kbps)• 2 means 128Kbps (± 32Kbps)• 16 means 1024Kbps (± 32Kbps): This covers 1Mbps (1,000,000bps)• 31 means 1984Kbps (± 32Kbps): This covers 2Mbps (2,000,000bps)• 32 means 2048Kbps (± 32 Kbps)• 94 means 6016Kbps (± 32 Kbps): This covers 6Mbps (6,000,000bps)• 96 means 6144Kbps (± 32 Kbps)• 99 means 6304Kbps or greater single-digit values are recorded with a leading blank, for example, 3

and not 03.Condition Code (1 alphanumeric character): Indicates the type of call that the call record describes, aslisted in the following table. For example, condition code 9 indicates a tandem call. The two conditioncodes in the following table are only condition codes used in the first release of Session Manager. Severalother condition codes, still defined as one alphanumeric character, will be added in later releases and willidentify additional condition characteristics of the completed call.

Table 5: Condition Code with description

Code Description

4 Identifies a call of extremely long duration, such as a call that lastsfor 10 or more hours. When a call exceeds 10 hours, the systemcreates a call record with this condition code and a duration of 9hours, 59 minutes, and 1/9 tenths of a minute. The system createsa similar call record with this condition code after each succeeding10-hour period. When the call terminates, the system creates a finalcall record with the appropriate condition code identifying the type ofcall.

9 Identifies a tandem call. This condition code is used for calls thatcomplete normally through Session Manager and is also used for anincoming call.

A Identifies an outgoing call from a SIP phone.

Note:When the administrator sets up the trunks in Communication Manager to communicate with SessionManager, the administrator must turn off CDR on the change signaling group Communication ManagerSAT screen for the IMS trunks. Otherwise, the Communication Manager CDR captures two or more


call records for each call. and can cause an error to occur. An automated method to easily mergeCommunication Manager and Session Manager CDR records does not exist.

Dialed Number (15 digits): The 15 most significant digits of the numeric user portion of the requestURI.

Calling Number (10 digits): The 10 right-most significant digits of the numeric user portion identifying thecalling number, taken from the P-Asserted-Identity header (if not available, from the Contact header and,if not available, from the From header).

Terminating SIP Entity (7 alphanumeric characters): The last seven characters of the outbound SIPEntity administered on the Session Manager server.

Originating SIP Entity (7 alphanumeric characters): The last seven characters of the inbound SIPEntity.

Feature Flag (1 numeric digit): Set to 4 in the first Session Manager release, and identifies a voice callwith network answer supervision.

Bearer Capability Class (1 alphanumeric character): Set to M in the first Session Manager release,indicating multimedia call.

MA-UUI (1 numeric digit): Set to the digit 0 in the first Session Manager release, indicating no messageassociated user-to-user signaling.

Resource Flag (1 numeric digit): Set to the digit 0 in the first Session Manager release, indicating a circuit-switched call without using a conversion device. In Session Manager 6.1 and later, the Resource Flag isset to 4 whenever a call has a video session during the lifetime of the call.

Space (0x20), Carriage Return (0x0d), Line Feed (0x0a): The corresponding ASCII characters.

The Session Manager CDR feature supports SFTP for the secure transfer of CDR data files. The CDRadjunct must use the same protocol as Session Manager to access and retrieve the CDR data files fromthe servers.

Av-GSID (Avaya-Global-Session-ID): On receiving an initial SIP request (out of dialog), SessionManager creates and stores a globally unique identifier (Av-GSID token). Session Manager inserts theidentifier in the Av-Global-Session-ID header in the request. If the incoming request already contains anAv-Global-Session-ID header, Session Manager overwrites the header. The exception to the overwritingrule is when the request arrives from another Session Manager, a sequenced application, or a trusted SIPentity. The Av-Global-Session-ID is present in the initial request that comes back from the sequencedapplication. The Av-global identifier (GSID token) in the Avaya-Global-Session-ID header is a 128-bitunique integer in time and space. Session Manager follows one of the RFC 4122 (Universally UniqueIdentifier) recommended algorithms to generate the GSID token. The GSID is a 36 character sequencecomprised of digits 0-9; a-f; A-F;”-“.

Calling Party IP and Called Party IP: These fields have a default width of 15 characters to contain 15character IPv4 addresses. Any IP address populated into these fields is right-justified with any extracharacters located on the left side of the address. The extra character locations are populated withcharacters having an ASCII value of 32 decimal or 0x20 hex (the space character). The format for IPv4addresses is aaa.bbb.ccc.ddd, whereaaa, bbb, ccc and ddd are 1-3 character decimal numbers withvalues that range between 0 and 255. Each of these three-digit numbers is separated by a period character(ASCII 46 or 0x2E hex). If you reduce the size of the field and the full IP address does not fit, the field istruncated from the left side, so that the low-order parts of the IP address appear.

CDR record format



Appendix F: PCN and PSN notifications

PCN and PSN notificationsAvaya issues a product-change notice (PCN) in case of any software update. For example, aPCN must accompany a service pack or a patch that needs to be applied universally. Avayaissues product-support notice (PSN) when there is no patch, service pack, or release fix, butthe business unit or services need to alert Avaya Direct, Business Partners, and customers ofa problem or a change in a product. A PSN can also be used to provide a workaround for aknown problem, steps to recover logs, or steps to recover software. Both these notices alertyou to important issues that directly impact Avaya products.

Viewing PCNs and PSNsAbout this taskTo view PCNs and PSNs, perform the following steps:

Procedure

1. Go to the Avaya Support website at http://support.avaya.com.

Note:If the Avaya Support website displays the login page, enter your SSO logincredentials.

2. On the top of the page, click DOWNLOADS & DOCUMENTS.

3. On the Downloads & Documents page, in the Enter Your Product Here field, enterthe name of the product.

4. In the Choose Release field, select the specific release from the drop-down list.

5. Select Documents as the content type.

6. Select the appropriate filters as per your search requirement. For example, if youselect Product Support Notices, the system displays only PSNs in the documentslist.



Note:You can apply multiple filters to search for the required documents.

Signing up for PCNs and PSNsAbout this taskManually viewing PCNs and PSNs is helpful, but you can also sign up for receiving notificationsof new PCNs and PSNs. Signing up for notifications alerts you to specific issues you must beaware of. These notifications also alert you when new product documentation, new productpatches, or new services packs are available. The Avaya E-Notifications process managesthis proactive notification system .

To sign up for notifications:

Procedure

1. Go to the Avaya Support Web Tips and Troubleshooting: eNotificationsManagement page at https://support.avaya.com/ext/index?page=content&id=PRCS100274#.

2. Set up e-notifications. For detailed information, see the How to set up your E-Notifications procedure.

PCN and PSN notifications


https://support.avaya.com/ext/index?page=content&id=PRCS100274#

https://support.avaya.com/ext/index?page=content&id=PRCS100274#


Index

A

about .......................................................................... 32access, remote ........................................................... 11activating entitlements ................................................27Adding a Survivable Remote server ...........................49Adding a Survivable Remote server as a SIP entity ...52adding NMS Destination .............................................33adding SIP Entity, Session Manager ..........................36administration, survivable remote ...............................51AFS ............................................................................ 29

starting ................................................................. 29alarm test ....................................................................41Avaya courses ..............................................................8Avaya Mentor videos ....................................................9Avaya products ...........................................................69

C

CDR ............................................................................73format ...................................................................73

checking connections ................................................. 53checking Session Manager service state ................... 39checklist, Session Manager installation, .....................21Communication Manager server administration 49, 50, 52

Validating the minimum time of network stability . 50Adding a Survivable Remote server .................... 49Adding a Survivable Remote server as a SIP entity

.................................................................52Creating entity links ..............................................52

configuration, redundancy .......................................... 43connecting laptop to server ........................................ 26creating Authentication File ........................................ 29Creating entity links .................................................... 52

D

document changes .......................................................7document purpose ....................................................... 7downloading software .................................................18DVD ............................................................................19

writing ISO image .................................................19

E

enrollment password .................................................. 27

procedure .............................................................27Enrollment password ..................................................27

procedure .............................................................27entitlements ................................................................ 27

activating ..............................................................27entity link administration ............................................. 52Ethernet port labels .................................................... 21

F

Firefox ........................................................................ 25disabling proxy servers ........................................ 25

G

Gateway recovery rule ............................................... 50geographic redundancy ..............................................13

H

high-level installation steps ........................................ 11

I

Initial Administration ................................................... 35Initial Session Manager administration ................. 36, 37installation overview ................................................... 11installing an authentication file ................................... 30installing Session Manager ...................................13, 21intended audience ........................................................7Internet Explorer .........................................................24

disabling proxy servers ........................................ 24interoperability ............................................................ 69IP settings ...................................................................23

configuring on laptop ............................................23ISO image .................................................................. 19

writing to DVD ......................................................19

L

laptop ..........................................................................23configuring to connect to server ...........................23

legal notice ................................................................... 2logins installed ............................................................12


M

media ..........................................................................67

N

Network Management Systems Destinations .............32network stability ..........................................................50NMS destinations ....................................................... 32

P

PCN ............................................................................79PCN notification ..........................................................79PCNs .......................................................................... 79PLDS .......................................................................... 18

downloading software .......................................... 18port matrix .................................................................. 71prerequisites before installation ..................................17proxy servers ........................................................ 24, 25

disabling in Firefox ...............................................25disabling in Internet Explorer ............................... 24

PSN ............................................................................ 79PSN notification ..........................................................79PSNs .......................................................................... 79purpose of document ................................................... 7

R

redundancy .................................................................43redundancy configuration ........................................... 43registering ...................................................................18related documents ........................................................7related resources ......................................................... 9

Avaya Mentor videos ............................................. 9remote access ............................................................ 11replication verification .................................................41

S

SAT administration, survivable remote .......................49service pack upgrades ............................................... 13Session Manager administration checklist ................. 35Session Manager information worksheet ................... 63

Session Manager installation checklist .......................21Session Manager installation procedures .................. 21signing up for PCNs and PSNs .................................. 80SIP Entity information worksheet ............................... 64SMnetSetup ................................................................31software upgrades ......................................................13support ......................................................................... 9

contact ................................................................... 9supported hardware ................................................... 71survivable remote ....................................................... 53

administering ........................................................53Survivable remote ...................................................... 45survivable remote administration ................................51Survivable Remote information worksheet .................65survivable remote installation checklist ...................... 46survivable remote SAT administration ........................49Survivable Remote server .......................................... 49Survivable remote Session Manager ......................... 45Survivable Remote SIP entity administration ............. 52survivable server ........................................................ 56

registration ........................................................... 56

T

testing .........................................................................39installation test for System/Session Managers .... 39

training ......................................................................... 8troubleshooting ..................................................... 59, 61

Session Manager fails to install ........................... 61survivable server fails to sync with main ..............61

troubleshooting - cannot access service state ........... 59troubleshooting - server has no power ....................... 59trust management ...................................................... 27

enrollment password ............................................27

V

Validating gateway recovery rule ............................... 50Validating the minimum time of network stability ........50verify alarm configuration ........................................... 41verify avaya-lsp-fs ...................................................... 55verify survivable remote information ...........................55videos ...........................................................................9

Avaya Mentor .........................................................9

W

warranty ....................................................................... 9worksheet, Session Manager information .................. 63worksheet, SIP Entity information .............................. 64worksheet, Survivable Remote information ................65worksheets ................................................................. 63

82 Implementing Avaya Aura® Session Manager Release 6.3 May 2013

implementing avaya aura ® session manager

Documents

avaya customers

avaya doesnot

avaya channelpartner

andorinstalls avaya

bysaid avaya reseller

product information

standalone products

terms ofthe limited