You are on page 1of 92

Deploying Avaya Aura® Session Manager

Release 7.0.1
Issue 3
November 2016
© 2015-2016, Avaya, Inc. USES AND/OR INSTALLS AVAYA SOFTWARE, PURCHASED
All Rights Reserved. FROM AVAYA INC., ANY AVAYA AFFILIATE, OR AN AVAYA
CHANNEL PARTNER (AS APPLICABLE) UNDER A COMMERCIAL
Notice AGREEMENT WITH AVAYA OR AN AVAYA CHANNEL PARTNER.
While reasonable efforts have been made to ensure that the UNLESS OTHERWISE AGREED TO BY AVAYA IN WRITING,
information in this document is complete and accurate at the time of AVAYA DOES NOT EXTEND THIS LICENSE IF THE SOFTWARE
printing, Avaya assumes no liability for any errors. Avaya reserves WAS OBTAINED FROM ANYONE OTHER THAN AVAYA, AN
the right to make changes and corrections to the information in this AVAYA AFFILIATE OR AN AVAYA CHANNEL PARTNER; AVAYA
document without the obligation to notify any person or organization RESERVES THE RIGHT TO TAKE LEGAL ACTION AGAINST YOU
of such changes. AND ANYONE ELSE USING OR SELLING THE SOFTWARE
WITHOUT A LICENSE. BY INSTALLING, DOWNLOADING OR
Documentation disclaimer USING THE SOFTWARE, OR AUTHORIZING OTHERS TO DO SO,
“Documentation” means information published in varying mediums YOU, ON BEHALF OF YOURSELF AND THE ENTITY FOR WHOM
which may include product information, operating instructions and YOU ARE INSTALLING, DOWNLOADING OR USING THE
performance specifications that are generally made available to users SOFTWARE (HEREINAFTER REFERRED TO
of products. Documentation does not include marketing materials. INTERCHANGEABLY AS “YOU” AND “END USER”), AGREE TO
Avaya shall not be responsible for any modifications, additions, or THESE TERMS AND CONDITIONS AND CREATE A BINDING
deletions to the original published version of Documentation unless CONTRACT BETWEEN YOU AND AVAYA INC. OR THE
such modifications, additions, or deletions were performed by or on APPLICABLE AVAYA AFFILIATE (“AVAYA”).
the express behalf of Avaya. End User agrees to indemnify and hold Avaya grants You a license within the scope of the license types
harmless Avaya, Avaya's agents, servants and employees against all described below, with the exception of Heritage Nortel Software, for
claims, lawsuits, demands and judgments arising out of, or in which the scope of the license is detailed below. Where the order
connection with, subsequent modifications, additions or deletions to documentation does not expressly identify a license type, the
this documentation, to the extent made by End User. applicable license will be a Designated System License. The
Link disclaimer applicable number of licenses and units of capacity for which the
license is granted will be one (1), unless a different number of
Avaya is not responsible for the contents or reliability of any linked licenses or units of capacity is specified in the documentation or other
websites referenced within this site or Documentation provided by materials available to You. “Software” means computer programs in
Avaya. Avaya is not responsible for the accuracy of any information, object code, provided by Avaya or an Avaya Channel Partner,
statement or content provided on these sites and does not whether as stand-alone products, pre-installed on hardware products,
necessarily endorse the products, services, or information described and any upgrades, updates, patches, bug fixes, or modified versions
or offered within them. Avaya does not guarantee that these links will thereto. “Designated Processor” means a single stand-alone
work all the time and has no control over the availability of the linked computing device. “Server” means a Designated Processor that
pages. hosts a software application to be accessed by multiple users.
“Instance” means a single copy of the Software executing at a
Warranty
particular time: (i) on one physical machine; or (ii) on one deployed
Avaya provides a limited warranty on Avaya hardware and software. software virtual machine (“VM”) or similar deployment.
Refer to your sales agreement to establish the terms of the limited
License types
warranty. In addition, Avaya’s standard warranty language, as well as
information regarding support for this product while under warranty is Concurrent User License (CU). End User may install and use the
available to Avaya customers and other parties through the Avaya Software on multiple Designated Processors or one or more Servers,
Support website: https://support.avaya.com/helpcenter/ so long as only the licensed number of Units are accessing and using
getGenericDetails?detailId=C20091120112456651010 under the link the Software at any given time. A “Unit” means the unit on which
“Warranty & Product Lifecycle” or such successor site as designated Avaya, at its sole discretion, bases the pricing of its licenses and can
by Avaya. Please note that if You acquired the product(s) from an be, without limitation, an agent, port or user, an e-mail or voice mail
authorized Avaya Channel Partner outside of the United States and account in the name of a person or corporate function (e.g.,
Canada, the warranty is provided to You by said Avaya Channel webmaster or helpdesk), or a directory entry in the administrative
Partner and not by Avaya. database utilized by the Software that permits one user to interface
Hosted Service with the Software. Units may be linked to a specific, identified Server
or an Instance of the Software.
THE FOLLOWING APPLIES ONLY IF YOU PURCHASE AN AVAYA
HOSTED SERVICE SUBSCRIPTION FROM AVAYA OR AN AVAYA Heritage Nortel Software
CHANNEL PARTNER (AS APPLICABLE), THE TERMS OF USE “Heritage Nortel Software” means the software that was acquired by
FOR HOSTED SERVICES ARE AVAILABLE ON THE AVAYA Avaya as part of its purchase of the Nortel Enterprise Solutions
WEBSITE, HTTPS://SUPPORT.AVAYA.COM/LICENSEINFO Business in December 2009. The Heritage Nortel Software is the
UNDER THE LINK “Avaya Terms of Use for Hosted Services” OR software contained within the list of Heritage Nortel Products located
SUCH SUCCESSOR SITE AS DESIGNATED BY AVAYA, AND ARE at https://support.avaya.com/LicenseInfo under the link “Heritage
APPLICABLE TO ANYONE WHO ACCESSES OR USES THE Nortel Products” or such successor site as designated by Avaya. For
HOSTED SERVICE. BY ACCESSING OR USING THE HOSTED Heritage Nortel Software, Avaya grants Customer a license to use
SERVICE, OR AUTHORIZING OTHERS TO DO SO, YOU, ON Heritage Nortel Software provided hereunder solely to the extent of
BEHALF OF YOURSELF AND THE ENTITY FOR WHOM YOU ARE the authorized activation or authorized usage level, solely for the
DOING SO (HEREINAFTER REFERRED TO INTERCHANGEABLY purpose specified in the Documentation, and solely as embedded in,
AS “YOU” AND “END USER”), AGREE TO THE TERMS OF USE. IF for execution on, or for communication with Avaya equipment.
YOU ARE ACCEPTING THE TERMS OF USE ON BEHALF A Charges for Heritage Nortel Software may be based on extent of
COMPANY OR OTHER LEGAL ENTITY, YOU REPRESENT THAT activation or use authorized as specified in an order or invoice.
YOU HAVE THE AUTHORITY TO BIND SUCH ENTITY TO THESE
TERMS OF USE. IF YOU DO NOT HAVE SUCH AUTHORITY, OR Copyright
IF YOU DO NOT WISH TO ACCEPT THESE TERMS OF USE, YOU Except where expressly stated otherwise, no use should be made of
MUST NOT ACCESS OR USE THE HOSTED SERVICE OR materials on this site, the Documentation, Software, Hosted Service,
AUTHORIZE ANYONE TO ACCESS OR USE THE HOSTED or hardware provided by Avaya. All content on this site, the
SERVICE. documentation, Hosted Service, and the product provided by Avaya
Licenses including the selection, arrangement and design of the content is
owned either by Avaya or its licensors and is protected by copyright
THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYA and other intellectual property laws including the sui generis rights
WEBSITE, HTTPS://SUPPORT.AVAYA.COM/LICENSEINFO, relating to the protection of databases. You may not modify, copy,
UNDER THE LINK “AVAYA SOFTWARE LICENSE TERMS (Avaya reproduce, republish, upload, post, transmit or distribute in any way
Products)” OR SUCH SUCCESSOR SITE AS DESIGNATED BY any content, in whole or in part, including any code and software
AVAYA, ARE APPLICABLE TO ANYONE WHO DOWNLOADS, unless expressly authorized by Avaya. Unauthorized reproduction,
transmission, dissemination, storage, and or use without the express LICENSED TO PROVIDE AVC VIDEO. NO LICENSE IS GRANTED
written consent of Avaya can be a criminal, as well as a civil offense OR SHALL BE IMPLIED FOR ANY OTHER USE. ADDITIONAL
under the applicable law. INFORMATION FOR H.264 (AVC) AND H.265 (HEVC) CODECS
MAY BE OBTAINED FROM MPEG LA, L.L.C. SEE HTTP://
Virtualization WWW.MPEGLA.COM.
The following applies if the product is deployed on a virtual machine. Compliance with Laws
Each product has its own ordering code and license types. Note that
each Instance of a product must be separately licensed and ordered. You acknowledge and agree that it is Your responsibility for
For example, if the end user customer or Avaya Channel Partner complying with any applicable laws and regulations, including, but not
would like to install two Instances of the same type of products, then limited to laws and regulations related to call recording, data privacy,
two products of that type must be ordered. intellectual property, trade secret, fraud, and music performance
rights, in the country or territory where the Avaya product is used.
Third Party Components
Preventing Toll Fraud
“Third Party Components” mean certain software programs or
portions thereof included in the Software or Hosted Service may “Toll Fraud” is the unauthorized use of your telecommunications
contain software (including open source software) distributed under system by an unauthorized party (for example, a person who is not a
third party agreements (“Third Party Components”), which contain corporate employee, agent, subcontractor, or is not working on your
terms regarding the rights to use certain portions of the Software company's behalf). Be aware that there can be a risk of Toll Fraud
(“Third Party Terms”). As required, information regarding distributed associated with your system and that, if Toll Fraud occurs, it can
Linux OS source code (for those products that have distributed Linux result in substantial additional charges for your telecommunications
OS source code) and identifying the copyright holders of the Third services.
Party Components and the Third Party Terms that apply is available
in the products, Documentation or on Avaya’s website at: https:// Avaya Toll Fraud intervention
support.avaya.com/Copyright or such successor site as designated If You suspect that You are being victimized by Toll Fraud and You
by Avaya. The open source software license terms provided as Third need technical assistance or support, call Technical Service Center
Party Terms are consistent with the license rights granted in these Toll Fraud Intervention Hotline at +1-800-643-2353 for the United
Software License Terms, and may contain additional rights benefiting States and Canada. For additional support telephone numbers, see
You, such as modification and distribution of the open source the Avaya Support website: https://support.avaya.com or such
software. The Third Party Terms shall take precedence over these successor site as designated by Avaya.
Software License Terms, solely with respect to the applicable Third
Party Components to the extent that these Software License Terms Security Vulnerabilities
impose greater restrictions on You than the applicable Third Party Information about Avaya’s security support policies can be found in
Terms. the Security Policies and Support section of https://
The following applies only if the H.264 (AVC) codec is distributed with support.avaya.com/security.
the product. THIS PRODUCT IS LICENSED UNDER THE AVC Suspected Avaya product security vulnerabilities are handled per the
PATENT PORTFOLIO LICENSE FOR THE PERSONAL USE OF A Avaya Product Security Support Flow (https://
CONSUMER OR OTHER USES IN WHICH IT DOES NOT RECEIVE support.avaya.com/css/P8/documents/100161515).
REMUNERATION TO (i) ENCODE VIDEO IN COMPLIANCE WITH
THE AVC STANDARD (“AVC VIDEO”) AND/OR (ii) DECODE AVC Downloading Documentation
VIDEO THAT WAS ENCODED BY A CONSUMER ENGAGED IN A For the most current versions of Documentation, see the Avaya
PERSONAL ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO Support website: https://support.avaya.com, or such successor site
PROVIDER LICENSED TO PROVIDE AVC VIDEO. NO LICENSE IS as designated by Avaya.
GRANTED OR SHALL BE IMPLIED FOR ANY OTHER USE.
ADDITIONAL INFORMATION MAY BE OBTAINED FROM MPEG Contact Avaya Support
LA, L.L.C. SEE HTTP://WWW.MPEGLA.COM. See the Avaya Support website: https://support.avaya.com for
Service Provider product or Hosted Service notices and articles, or to report a problem
with your Avaya product or Hosted Service. For a list of support
THE FOLLOWING APPLIES TO AVAYA CHANNEL PARTNER’S telephone numbers and contact addresses, go to the Avaya Support
HOSTING OF AVAYA PRODUCTS OR SERVICES. THE PRODUCT website: https://support.avaya.com (or such successor site as
OR HOSTED SERVICE MAY USE THIRD PARTY COMPONENTS designated by Avaya), scroll to the bottom of the page, and select
SUBJECT TO THIRD PARTY TERMS AND REQUIRE A SERVICE Contact Avaya Support.
PROVIDER TO BE INDEPENDENTLY LICENSED DIRECTLY
FROM THE THIRD PARTY SUPPLIER. AN AVAYA CHANNEL Trademarks
PARTNER’S HOSTING OF AVAYA PRODUCTS MUST BE The trademarks, logos and service marks (“Marks”) displayed in this
AUTHORIZED IN WRITING BY AVAYA AND IF THOSE HOSTED site, the Documentation, Hosted Service(s), and product(s) provided
PRODUCTS USE OR EMBED CERTAIN THIRD PARTY by Avaya are the registered or unregistered Marks of Avaya, its
SOFTWARE, INCLUDING BUT NOT LIMITED TO MICROSOFT affiliates, its licensors, its suppliers, or other third parties. Users are
SOFTWARE OR CODECS, THE AVAYA CHANNEL PARTNER IS not permitted to use such Marks without prior written consent from
REQUIRED TO INDEPENDENTLY OBTAIN ANY APPLICABLE Avaya or such third party which may own the Mark. Nothing
LICENSE AGREEMENTS, AT THE AVAYA CHANNEL PARTNER’S contained in this site, the Documentation, Hosted Service(s) and
EXPENSE, DIRECTLY FROM THE APPLICABLE THIRD PARTY product(s) should be construed as granting, by implication, estoppel,
SUPPLIER. or otherwise, any license or right in and to the Marks without the
WITH RESPECT TO CODECS, IF THE AVAYA CHANNEL express written permission of Avaya or the applicable third party.
PARTNER IS HOSTING ANY PRODUCTS THAT USE OR EMBED Avaya is a registered trademark of Avaya Inc.
THE G.729 CODEC, H.264 CODEC, OR H.265 CODEC, THE
AVAYA CHANNEL PARTNER ACKNOWLEDGES AND AGREES All non-Avaya trademarks are the property of their respective owners.
THE AVAYA CHANNEL PARTNER IS RESPONSIBLE FOR ANY Linux® is the registered trademark of Linus Torvalds in the U.S. and
AND ALL RELATED FEES AND/OR ROYALTIES. THE G.729 other countries.
CODEC IS LICENSED BY SIPRO LAB TELECOM INC. SEE
WWW.SIPRO.COM/CONTACT.HTML. THE H.264 (AVC) CODEC IS
LICENSED UNDER THE AVC PATENT PORTFOLIO LICENSE FOR
THE PERSONAL USE OF A CONSUMER OR OTHER USES IN
WHICH IT DOES NOT RECEIVE REMUNERATION TO: (I)
ENCODE VIDEO IN COMPLIANCE WITH THE AVC STANDARD
(“AVC VIDEO”) AND/OR (II) DECODE AVC VIDEO THAT WAS
ENCODED BY A CONSUMER ENGAGED IN A PERSONAL
ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO PROVIDER
Contents

Chapter 1: Introduction............................................................................................................  7
Purpose.................................................................................................................................. 7
Prerequisites........................................................................................................................... 7
Change history........................................................................................................................ 8
Warranty................................................................................................................................. 8
Chapter 2: Architecture overview.......................................................................................... 10
®
Avaya Aura Virtualized Environment overview........................................................................ 10
®
Avaya Aura Virtualized Appliance overview...................................................................... 10
Solution Deployment Manager.......................................................................................... 13
Virtualized components.......................................................................................................... 18
VMware software requirements..............................................................................................  19
Server hardware and resources for VMware............................................................................  20
Authentication file.................................................................................................................. 20
®
Avaya Aura virtualized software............................................................................................  20
Chapter 3: Deployment process............................................................................................ 22
Deployment guidelines........................................................................................................... 22
Deployment of cloned and copied OVAs.................................................................................  23
Chapter 4: Planning and configuration................................................................................. 24
Planning checklist.................................................................................................................. 24
Capacity limits for Session Manager Footprints........................................................................ 25
Customer configuration data..................................................................................................  26
Conditions for Appliance Virtualization Platform and VM hosts..................................................  27
SAL Gateway........................................................................................................................ 27
Installing the license file.........................................................................................................  27
Chapter 5: Deploying the Session Manager OVA................................................................  29
Session Manager deployment checklist................................................................................... 29
Configuring the system for Session Manager deployment......................................................... 30
Methods for deploying the Session Manager OVA.................................................................... 30
Deploying using vSphere Client connected to vCenter........................................................ 30
Deploying using vSphere Client connected directly to VMware host..................................... 32
Deploying using Solution Deployment Manager through System Manager...........................  33
Configuring the virtual machine automatic startup settings........................................................  34
Troubleshooting a Session Manager virtual machine that does not power on.............................  35
Reconfiguring hardware resources for flexible footprint....................................................... 36
Configuring Session Manager................................................................................................  37
Installing software patches.....................................................................................................  37
Installed Patches field descriptions...................................................................................  40
Chapter 6: Post-installation verification...............................................................................  42
Post-deployment checklist...................................................................................................... 42

November 2016 Deploying Avaya Aura® Session Manager 4


Comments on this document? infodev@avaya.com
Contents

Verifying the connections.......................................................................................................  42


Upgrading Session Manager VMware Tools............................................................................  43
Chapter 7: Migrating Session Manager ...............................................................................  44
Migration checklist................................................................................................................. 44
Upgrading Session Manager from Release 6.x to 7.0 and later on VMware................................ 45
Data preserved during upgrade........................................................................................  47
Verifying the Enrollment Password status................................................................................ 47
Using System Manager to shut down or reboot the server........................................................  48
Using the CLI to shut down or reboot the server....................................................................... 48
Restoring the dmutility backup file........................................................................................... 49
Appliance Virtualization Platform Migration..............................................................................  49
Configuring the Appliance Virtualization Platform USB drive...............................................  49
Installing Appliance Virtualization Platform......................................................................... 50
Appliance Virtualization Platform Out of Band Management................................................ 52
Chapter 8: Maintenance and administration procedures.................................................... 55
Adding Session Manager as a SIP entity................................................................................. 55
Authentication files for Session Manager................................................................................. 55
Starting the AFS application.............................................................................................  56
Creating an authentication file for Session Manager...........................................................  56
Installing an authentication file.......................................................................................... 57
Accepting new service...........................................................................................................  57
Denying new service.............................................................................................................. 58
Creating a snapshot..............................................................................................................  58
Deleting a snapshot............................................................................................................... 59
Restoring a snapshot............................................................................................................. 60
Downloading software from PLDS..........................................................................................  60
Restarting a virtual machine from Solution Deployment Manager..............................................  61
Running maintenance tests....................................................................................................  62
Session Manager Backup and Restore...................................................................................  62
Accessing the Backup and Restore service.......................................................................  62
Backup and Restore field descriptions............................................................................... 63
Verifying the Active Call Count...............................................................................................  64
Verifying data replication........................................................................................................ 64
Troubleshooting Data Replication.....................................................................................  64
Viewing the Security Module page..........................................................................................  65
Troubleshooting Security Module Sanity failure.................................................................. 65
Viewing the Session Manager Entity Link Connection Status....................................................  66
Viewing the SIP Monitoring Status Summary page................................................................... 66
Chapter 9: Resources............................................................................................................. 68
Documentation...................................................................................................................... 68
Finding documents on the Avaya Support website.............................................................  70
Training................................................................................................................................  70
Viewing Avaya Mentor videos................................................................................................. 71

November 2016 Deploying Avaya Aura® Session Manager 5


Comments on this document? infodev@avaya.com
Contents

Support................................................................................................................................  72
Appendix A: Best Practices for VMware performance and features.................................  73
BIOS....................................................................................................................................  73
Intel Virtualization Technology..........................................................................................  73
Dell PowerEdge Server ................................................................................................... 74
HP ProLiant Servers........................................................................................................ 74
Timekeeping.........................................................................................................................  74
VMware Tools....................................................................................................................... 76
VMware networking best practices.......................................................................................... 76
Separating Session Manager management and Security Module traffic...............................  80
Storage................................................................................................................................  81
Thin vs. thick deployments.....................................................................................................  81
Best Practices for VMware features........................................................................................  82
VMware High Availability.................................................................................................. 82
VMware vMotion.............................................................................................................  82
VMware Snapshots.........................................................................................................  83
Appendix B: Product notifications........................................................................................ 85
Viewing PCNs and PSNs.......................................................................................................  85
Registering for product notifications........................................................................................  86
Glossary................................................................................................................................... 87

November 2016 Deploying Avaya Aura® Session Manager 6


Comments on this document? infodev@avaya.com
Chapter 1: Introduction

Purpose
This document:
• describes the procedures for deploying the Avaya Aura® Session Manager virtual application in
a virtualized environment.
• includes deployment procedures, initial administration, and basic maintenance procedures.
• does not include optional or customized aspects of a configuration.
The primary audience for this document is anyone who deploys, configures, and upgrades Session
Manager.
The audience includes, but is not limited to:
• Implementation Engineers
• Field Technicians
• Business Partners
• Solution Providers
• Customers

Prerequisites
Before deploying Session Manager, ensure that you have the following knowledge, skills and tools.
Knowledge
• Linux operating system
• VMware
• VMware vSphere ESXi
• VMware vCenter Server
• Virtualized Environment
• PLDS

November 2016 Deploying Avaya Aura® Session Manager 7


Comments on this document? infodev@avaya.com
Introduction

Skills
• Linux configuration tools
• VMware tools
• VMware vCenter Server and ESXi
Tools
• PuTTy
• Laptop with System Manager tools
• Solution Deployment Manager client if System Manager is unreachable
• Session Manager configuration worksheet

Change history
Issue Date Summary of changes
1.0 August 2015 Initial Release
2.0 May 2016 • Added the Installing software
patches section.
• Updated the Session Manager
deployment checklist section.
• Updated the VMware software
requirements section for ESXi
6.0 version support.
• Updated the Capacity limits for
Session Manager Footprints
section.
3.0 November 2016 Updated the Planning and
configuration section to indicate
that all virtual machines on an
Appliance Virtualization Platform
host must be on the same subnet
mask.

Warranty
Avaya provides a 90-day limited warranty on Session Manager. For more information about the
terms of the limited warranty, see the sales agreement or other applicable documentation.

November 2016 Deploying Avaya Aura® Session Manager 8


Comments on this document? infodev@avaya.com
Warranty

You can view the standard warranty information about Session Manager support on the Avaya
Support website at https://support.avaya.com. You can find the warranty information and license
terms at the bottom of the page under:
• Help & Policies > Policies & Legal > Warranty & Product Lifecycle
• Help & Policies > Policies & Legal > License Terms

November 2016 Deploying Avaya Aura® Session Manager 9


Comments on this document? infodev@avaya.com
Chapter 2: Architecture overview

Avaya Aura® Virtualized Environment overview


Avaya Aura® Virtualized Environment integrates real-time Avaya Aura® applications with VMware®
virtualized server architecture.
Using Avaya Aura® Virtualized Environment, customers with a VMware IT infrastructure can
upgrade to the next release level of collaboration using their own VMware infrastructure. For
customers who need to add more capacity or application interfaces, Avaya Aura® applications on
VMware offer flexible solutions for expansion. For customers who want to migrate to the latest
collaboration solutions, Avaya Aura® Virtualized Environment provides a hardware-efficient
simplified solution for upgrading to the latest Avaya Aura® release and adding the latest Avaya
Aura® capabilities.
The Virtualized Environment project applies only for Avaya Appliance Virtualization Platform and
customer VMware®, and does not include any other industry hypervisor.
Note:
This document uses the following terms, and at times, uses the terms interchangeably.
• server and host
• reservations and configuration values
Deployment considerations
The following manage the deployment to the blade, cluster, and server:
• Avaya Appliance Virtualization Platform from System Manager Solution Deployment Manager
or the Solution Deployment Manager client
• VMware® vCenter and VMware® vSphere

Avaya Aura® Virtualized Appliance overview


Avaya Aura® Virtualized offers
Starting with Release 7.0, Avaya Aura® supports the following two Avaya virtualization offers based
on VMware:
• Avaya Aura® Virtualized Appliance (VA) - Avaya-provided server, Avaya Appliance
Virtualization Platform, based on the customized OEM version of VMware® ESXi 5.5.

November 2016 Deploying Avaya Aura® Session Manager 10


Comments on this document? infodev@avaya.com
Avaya Aura® Virtualized Environment overview

• Avaya Aura® Virtualized Environment (VE) - Customer-provided VMware infrastructure


The virtualization offers, provides the following benefits:
• Simplifies IT management using common software administration and maintenance.
• Requires fewer servers and racks which reduces the footprint.
• Lowers power consumption and cooling requirements.
• Enables capital equipment cost savings.
• Lowers operational expenses.
• Uses standard operating procedures for both Avaya and non-Avaya products.
• Deploys Avaya Aura® virtual products in a virtualized environment on Avaya provided servers
or customer-specified servers and hardware.
• Business can scale rapidly to accommodate growth and to respond to changing business
requirements

Avaya Virtualized Appliance overview


Avaya Aura® Virtualized Appliance is a turnkey solution. Avaya provides the hardware, all the
software including the VMware hypervisor and might also offer the customer support of the setup.
Virtualized Appliance offer is different from Avaya Aura® Virtualized Environment, where Avaya
provides the Avaya Aura® application software and the customer provides and supports the VMware
hypervisor and the hardware on which the hypervisor runs.
Deployment considerations
• Deployment on the Appliance Virtualization Platform server is performed from the System
Manager Solution Deployment Manager or the Solution Deployment Manager standalone
Windows client.
• Avaya provides the servers, Appliance Virtualization Platform, which includes the VMware
ESXi hypervisor.

Appliance Virtualization Platform overview


From Release 7.0, Avaya uses the VMware®-based Avaya Appliance Virtualization Platform to
provide virtualization for Avaya Aura® applications in Avaya Aura® Virtualized Appliance offer.
Avaya Aura® Virtualized Appliance offer includes:
• Common Servers: Dell™ PowerEdge™ R610, Dell™ PowerEdge™ R620, HP ProLiant DL360 G7,
HP ProLiant DL360p G8, Dell™ PowerEdge™ R630, and HP ProLiant DL360 G9
• S8300D and S8300E
Appliance Virtualization Platform is the customized OEM version of VMware® ESXi 5.5. With
Appliance Virtualization Platform, customers can run any combination of supported applications on
Avaya-supplied servers. Appliance Virtualization Platform provides greater flexibility in scaling
customer solutions to individual requirements.

November 2016 Deploying Avaya Aura® Session Manager 11


Comments on this document? infodev@avaya.com
Architecture overview

From Release 7.0, Appliance Virtualization Platform replaces System Platform.


Avaya Aura® Release 7.0.1 supports the following applications on Appliance Virtualization Platform:
• Utility Services 7.0.1
• System Manager 7.0.1
• Session Manager 7.0.1
• Branch Session Manager 7.0.1
• Communication Manager 7.0.1
• Application Enablement Services 7.0.1
• WebLM 7.0.1
• Avaya Breeze™ 3.1.1
• SAL 2.5
• Communication Manager Messaging 7.0
• Avaya Aura® Media Server 7.7.0.292 (SP3)
• Avaya Scopia® 8.3.5
• Avaya Proactive Contact 5.1.2

November 2016 Deploying Avaya Aura® Session Manager 12


Comments on this document? infodev@avaya.com
Avaya Aura® Virtualized Environment overview

For more information about installing Avaya Proactive Contact and administering Appliance
Virtualization Platform with Avaya Proactive Contact, see the Avaya Proactive Contact
documentation.

Solution Deployment Manager


Solution Deployment Manager overview
Solution Deployment Manager is a centralized software management solution in System Manager
that provides deployments, upgrades, migrations, and updates to Avaya Aura® 7.0 applications.
Solution Deployment Manager supports the operations on customer Virtualized Environment and
Avaya Aura® Virtualized Appliance model.
Solution Deployment Manager provides the combined capabilities that Software Management,
Avaya Virtual Application Manager, and System Platform provided in earlier releases.
Note:
In Release 7.0.1, Solution Deployment Manager does not support migration of Virtualized
Environment-based 6.x applications to Release 7.0.1 in customer Virtualized Environment. Use
vSphere Client to migrate to customer Virtualized Environment.
Release 7.0 and later supports a standalone version of Solution Deployment Manager, the Solution
Deployment Manager client. For more information, see Using the Solution Deployment Manager
client.
System Manager is the primary management solution for Avaya Aura® 7.0 and later applications.
System Manager with the Solution Deployment Manager runs on:
• Avaya Aura® Virtualized Appliance: Contains a server, Appliance Virtualization Platform, and
Avaya Aura® application OVA. Appliance Virtualization Platform includes a VMware ESXi 5.5
hypervisor.
From Release 7.0, Appliance Virtualization Platform replaces System Platform.
• Customer-provided Virtualized Environment solution: Avaya Aura® applications are deployed
on customer-provided, VMware® certified hardware.
With Solution Deployment Manager, you can perform the following operations in Virtualized
Environment and Avaya Aura® Virtualized Appliance models:
• Deploy Avaya Aura® applications.
• Upgrade and migrate Avaya Aura® applications.
• Download Avaya Aura® applications.
• Install service packs, feature packs, and software patches for the following Avaya Aura®
applications:
- Communication Manager and associated devices, such as gateways, media modules, and
TN boards.
- Session Manager
- Branch Session Manager

November 2016 Deploying Avaya Aura® Session Manager 13


Comments on this document? infodev@avaya.com
Architecture overview

- Utility Services
- Appliance Virtualization Platform, the ESXi host that is running on the Avaya Aura®
Virtualized Appliance.
The upgrade process from Solution Deployment Manager involves the following key tasks:
• Discover the Avaya Aura® applications.
• Refresh applications and associated devices, and download the necessary software
components.
• Run the preupgrade check to ensure successful upgrade environment.
• Upgrade Avaya Aura® applications.
• Install software patch, service pack, or feature pack on Avaya Aura® applications.
For more information about the setup of the Solution Deployment Manager functionality that is part
of System Manager 7.x, see Avaya Aura® System Manager Solution Deployment Manager Job-Aid.

Capability comparison between System Manager Solution Deployment


Manager and the Solution Deployment Manager client
Centralized Solution Deployment Manager Solution Deployment Manager client
Manage virtual machine lifecycle Manage virtual machine lifecycle
®
Deploy Avaya Aura applications Deploy Avaya Aura® applications
Deploy hypervisor patches only for Appliance Deploy hypervisor patches only for Appliance
Virtualization Platform Virtualization Platform
Upgrade Avaya Aura® applications Upgrade System Platform-based System Manager
Release 7.x supports upgrades from Linux-based or
System Platform-based to Virtualized Environment or
Appliance Virtualization Platform. Release 7.0.1
does not support Virtualized Environment to
Virtualized Environment upgrades.
Install software patches for Avaya Aura® applications Install System Manager patches
excluding System Manager application
Discover Avaya Aura® applications Deploy System Manager
®
Analyze Avaya Aura applications -
Create and use the software library -

Solution Deployment Manager client


For the initial System Manager deployment or when System Manager is inaccessible, you can use
the Solution Deployment Manager client. The client can reside on the computer of the technician.
The Solution Deployment Manager client provides the functionality to install the OVAs on an Avaya-
provided server or customer-provided Virtualized Environment.
A technician can gain access to the user interface of the Solution Deployment Manager client from
the computer or web browser.
The Solution Deployment Manager client runs on Windows 7.0 and Windows 8, 64 bit.

November 2016 Deploying Avaya Aura® Session Manager 14


Comments on this document? infodev@avaya.com
Avaya Aura® Virtualized Environment overview

Use the Solution Deployment Manager client to:


• Deploy System Manager and Avaya Aura® applications on Avaya appliances and Virtualized
Environment.
• Upgrade System Platform-based System Manager.
• Install System Manager software patches, service packs, and feature packs.
• Install Appliance Virtualization Platform patches.
• Restart and shutdown the Appliance Virtualization Platform host.
• Start, stop, and restart a virtual machine.
• Change the footprint of Avaya Aura® applications that support dynamic resizing. For example,
Session Manager and Avaya Breeze™.
Note:
You can deploy or upgrade the System Manager virtual machine only by using the Solution
Deployment Manager client.

Figure 1: Solution Deployment Manager client dashboard

Solution Deployment Manager client capabilities


The Solution Deployment Manager client provides the following capabilities and functionality:
• Runs on the technician computer on the following operating systems:
- Windows 7, 64-bit Professional or Enterprise
- Windows 8.1, 64-bit Professional or Enterprise
• Supports the same web browsers as System Manager Release 7.0.1.
• Provides the user interface with similar look and feel as the central Solution Deployment
Manager in System Manager Release 7.0.1.
• Supports deploying the System Manager OVA. The Solution Deployment Manager client is the
only option to deploy System Manager.
• Supports Flexible footprint feature. The size of the virtual resources depends on the capacity
requirements of the Avaya Aura® applications.

November 2016 Deploying Avaya Aura® Session Manager 15


Comments on this document? infodev@avaya.com
Architecture overview

• Defines the physical location, Appliance Virtualization Platform or ESXi host, and discovers
virtual machines that are required for application deployments and virtual machine life cycle
management.
• Manages lifecycle of the OVA applications that are deployed on the ESXi host. The lifecycle
includes start, stop, reset virtual machines, and establishing trust for virtual machines.
• Deploys the Avaya Aura® applications that can be deployed from the central Solution
Deployment Manager for Avaya Aura® Virtualized Appliance and customer Virtualized
Environment. You can deploy one application at a time.
• Configures application and networking parameters required for application deployments.
• Supports the local computer or an HTTP URL to select the application OVA file for deployment.
You do not need access to PLDS.
• Supports changing the hypervisor IP address on Appliance Virtualization Platform.
• Supports installing patches for the hypervisor on Appliance Virtualization Platform.
• Supports installing software patches, service packs, and feature packs only for System
Manager.
Avaya Aura® applications must use centralized Solution Deployment Manager from System
Manager to install software patches, service packs, and feature packs.

Solution Deployment Manager


The Solution Deployment Manager capability simplifies and automates the deployment and upgrade
process.
With Solution Deployment Manager, you can deploy the following Avaya Aura® applications in
Release 7.0.1:
• Utility Services 7.0.1
• System Manager 7.0.1
• Session Manager 7.0.1
• Branch Session Manager 7.0.1
• Communication Manager 7.0.1
• Application Enablement Services 7.0.1
• WebLM 7.0.1
• Avaya Breeze™ 3.1.1
• SAL 2.5
• Communication Manager Messaging 7.0
• Avaya Aura® Media Server 7.7.0.292 (SP3)
• Avaya Scopia® 8.3.5
• Avaya Proactive Contact 5.1.2

November 2016 Deploying Avaya Aura® Session Manager 16


Comments on this document? infodev@avaya.com
Avaya Aura® Virtualized Environment overview

For more information about installing Avaya Proactive Contact and administering Appliance
Virtualization Platform with Avaya Proactive Contact, see the Avaya Proactive Contact
documentation.
Note:
You must deploy the Release 7.0 OVA, and then install the Release 7.0.1 file on the Avaya
Aura® Release 7.0 application.
With Solution Deployment Manager, you can migrate, upgrade, and update the following
applications:
• Linux-based Communication Manager 5.x and the associated devices, such as Gateways, TN
boards, and media modules.
Note:
In bare metal Linux-based deployments, the applications are directly installed on the server
and not as a virtual machine.
• Linux-based Session Manager 6.x
• System Platform-based Communication Manager
- Duplex CM Main / Survivable Core with Communication Manager
- Simplex CM Main / Survivable Core with Communication Manager, Communication
Manager Messaging, and Utility Services
- Simplex Survivable Remote with Communication Manager, Branch Session Manager, and
Utility Services
- Embedded CM Main with Communication Manager, Communication Manager Messaging,
and Utility Services
- Embedded Survivable Remote with Communication Manager, Branch Session Manager,
and Utility Services
• System Platform-based Branch Session Manager
- Simplex Survivable Remote with Communication Manager, Branch Session Manager, and
Utility Services
- Embedded Survivable Remote with Communication Manager, Branch Session Manager,
and Utility Services
Note:
However, you must manually migrate Services virtual machine that is part of the template.
The centralized deployment and upgrade process provide better support to customers who want to
upgrade their systems to Avaya Aura® Release 7.0.1. The process reduces the upgrade time and
error rate.
Solution Deployment Manager dashboard
You can gain access to the Solution Deployment Manager dashboard from the System Manager
web console or by installing the Solution Deployment Manager client.

November 2016 Deploying Avaya Aura® Session Manager 17


Comments on this document? infodev@avaya.com
Architecture overview

Solution Deployment Manager capabilities


With Solution Deployment Manager, you can perform deployment and upgrade-related tasks by
using the following links:
• Upgrade Release Setting: To select Release 7.0 or 6.3.8 as the target upgrade. Release
7.0.1 is the default upgrade target.
• Manage Software: To upgrade IP Office.
• VM Management: To deploy OVA files for the supported Avaya Aura® application.
• Upgrade Management: To upgrade Communication Manager that includes TN boards, media
gateways and media modules, Session Manager, Communication Manager Messaging, Utility
Services, Branch Session Manager to Release 7.0.1.
• User Settings: To configure the location from where System Manager displays information
about the latest software and firmware releases.
• Download Management: To download the OVA files and firmware to which the customer is
entitled. The download source can be the Avaya PLDS or an alternate source.
• Software Library Management: To configure the local or remote software library for storing
the downloaded software and firmware files.
• Upload Version XML: To save the version.xml file to System Manager. You require the
version.xml file to perform upgrades.

Virtualized components
Software component Description
ESXi Host The physical machine running the ESXi Hypervisor software.
ESXi Hypervisor A platform that runs multiple operating systems on a host computer at
the same time.
Table continues…

November 2016 Deploying Avaya Aura® Session Manager 18


Comments on this document? infodev@avaya.com
VMware software requirements

Software component Description


vSphere Client vSphere Client is an application that installs and manages virtual
machines. vSphere Client connects to a vCenter server or directly to an
ESXi host if a vCenter Server is not used. The application is installed on
a personal computer or accessible through a web interface.
vCenter Server vCenter Server provides centralized control and visibility at every level of
the virtual infrastructure. vCenter Server provides VMware features such
as High Availability and vMotion.
Appliance Virtualization Platform Avaya-provided virtualization turnkey solution that includes the hardware
and all the software including the VMware hypervisor.
Solution Deployment Manager Centralized software management solution of Avaya that provides
deployment, upgrade, migration, and update capabilities for the Avaya
Aura® virtual applications.
Open Virtualization Appliance The virtualized OS and application packaged in a single file that is used
(OVA) to deploy a virtual machine.

VMware software requirements


The Avaya Aura® Virtualized Environment supports the following VMware software versions:
• VMware vSphere ESXi 5.0
• VMware vSphere ESXi 5.1
• VMware vSphere ESXi 5.5
• VMware vSphere ESXi 6.0
• VMware vCenter Server 5.0
• VMware vCenter Server 5.1
• VMware vCenter Server 5.5
• VMware vCenter Server 6.0

To view compatibility with other solution releases, see VMware Product Interoperability Matrices at
http://partnerweb.vmware.com/comp_guide2/sim/interop_matrix.php.
Note:
ESXi 4.1 is not supported.

November 2016 Deploying Avaya Aura® Session Manager 19


Comments on this document? infodev@avaya.com
Architecture overview

Server hardware and resources for VMware


VMware offers compatibility guides that list servers, system, I/O, storage, and backup compatibility
with VMware infrastructure. For more information about VMware-certified compatibility guides and
product interoperability matrices, see http://www.vmware.com/resources/guides.html.

Authentication file
Session Manager 7.0 and later requires a new authentication file.
The Session Manager OVA contains a default authentication file. The customer must replace the
default authentication file with a new 7.0 or later authentication file. The system generates an alarm
once a day until a new 7.0 or later authentication file is installed.
For more information on authentication file, see Authentication files for SM/BSM on page 55.

Avaya Aura® virtualized software


Software delivery
The software is delivered as one or more pre-packaged Open Virtualization Appliance (OVA) files
that are posted on the Avaya Product Licensing and Download System (PLDS) and the Avaya
support site. Each OVA contains the following components:
• The application software and operating system.
• Preinstalled VMware tools.
• Preset configuration details for:
- RAM and CPU reservations and storage requirements
- Network Interface Card (NIC)
Note:
The customer provides the servers and the VMware® infrastructure, that includes VMware®
licenses.
Patches and upgrades
A minimum patch level can be required for each supported application. For more information about
the application patch requirements, see the compatibility matrix tool at http://support.avaya.com/
CompatibilityMatrix/Index.aspx.
Important:
Do not upgrade the VMware tools software that is packaged with each OVA unless Avaya
instructs you to upgrade. The supplied version is the supported release and has been
thoroughly tested.

November 2016 Deploying Avaya Aura® Session Manager 20


Comments on this document? infodev@avaya.com
Avaya Aura® virtualized software

Performance and capacities


The OVA template is built with configuration values which optimize performance and follow
recommended Best Practices.
Caution:
Modifying configuration values might have a direct impact on the performance, capacity, and
stability of the virtual machine. Customer must understand the aforementioned impacts when
changing configuration values. Avaya Global Support Services (GSS) might not be able to
assist in fully resolving a problem if the virtual hardware or resource allocation has been
changed to unsupported values for a virtual application. Avaya GSS could require the customer
to reset the values to the optimized values before starting to investigate the issue.

November 2016 Deploying Avaya Aura® Session Manager 21


Comments on this document? infodev@avaya.com
Chapter 3: Deployment process

The following are the high-level steps for deploying, administering, and verifying the deployment of
Session Manager.
• Complete the planning checklist.
• Complete the site preparation activities.
• Complete the configuration worksheets.
• Deploy Session Manager.
• Administer and configure Session Manager.
• Verify the Session Manager deployment and configuration.

Deployment guidelines
The high-level deployment steps are:
1. Deploy the OVA or OVAs.
2. Configure the application.
3. Verify the installation.
The deployment guidelines for the virtual appliances are:
• Deploy as many virtual appliances on the same host as possible.
• Deploy the virtual appliances on the same cluster if the cluster goes beyond the host boundary.
• Segment redundant elements on a different cluster, or ensure that the redundant elements are
not on the same host.
• Create a tiered or segmented cluster infrastructure that isolates critical applications, such as
Avaya Aura® applications, from other virtual machines.
• Plan for rainy day scenarios or conditions. Do not configure resources only for traffic or
performance on an average day.
• Do not oversubscribe resources. Oversubscribing affects performance.
• Monitor the server, host, and virtual appliance performance.

November 2016 Deploying Avaya Aura® Session Manager 22


Comments on this document? infodev@avaya.com
Deployment of cloned and copied OVAs

Important:
The values for performance, occupancy, and usage can vary greatly. The blade server
might run at 5% occupancy, but a virtual machine might run at 50% occupancy. Note that a
virtual machine behaves differently when the CPU usage is higher.

Deployment of cloned and copied OVAs


To redeploy a virtual machine, do not create a copy of the virtual machine or clone the virtual
machine. These processes have subtle technical details that require a thorough understanding of
the effects of these approaches. To avoid any complexities and unexpected behavior, deploy a new
OVA on the virtual machine. At this time, Avaya only supports the deployment of new OVAs.

November 2016 Deploying Avaya Aura® Session Manager 23


Comments on this document? infodev@avaya.com
Chapter 4: Planning and configuration

Planning checklist
Complete the following actions before deploying Session Manager.
# Action Links/Notes

1 Assess and verify the resource See Capacity limits for Core Session
requirements with the customer. Manager footprints on page 25.
The key factors are:
• CPU utilization
• Memory usage
• Storage requirements
• Network utilization
• Supported capacity
2 Enter the required information in the See Customer configuration data on
Customer Configuration Data worksheet. page 26.
3 Verify the customer has the required
hardware at the customer site.
4 Licenses: See Installing a license file on page 27.
1. Obtain the License Activation Code
(LAC) and Authentication File ID
(AFID).
2. Install the license file.
5 Create or obtain an Authentication File for See Authentication files for Session
Session Manager. Manager on page 55.
6 Verify you have the necessary resources See SAL Gateway on page 27.
for the SAL Gateway.
7 Plan staging and verification activities, and
assign resources to those activities.

November 2016 Deploying Avaya Aura® Session Manager 24


Comments on this document? infodev@avaya.com
Capacity limits for Session Manager Footprints

Capacity limits for Session Manager Footprints


The following table summarizes single Session Manager capacities for all Session Manager
footprints.
Note:
The capacities listed here are only for Session Manager. For information about capacity limits
for AADS, see the AADS documentation.
Session Manager Up to 2.5K 2.5K to 4.5K 4.5K to 7K 7K to 10K 10K to 23.5K
Device Footprints Devices Devices Devices Devices Devices
(R1 footprint) (R2 footprint)
* see note
CPU Minimum 2300MHz, Hyper-threaded
vCPUs 3 5 8 12 20
CPU MHz 3950 5750 9200 13800 23000
Reservation
Memory 4GB 5GB 8GB 10GB 18GB
Reservation
SIP Devices 2.5K/3K 4.5K/5K 7K/8K 10K/12K 23.3K/ 25K
(Normal/Failure)
CC Agents (Normal/ 2K/2.5K 3.75K/4166 5.8K/6666 8333/10K 18K/21K
Failure)
Presence Users 2.5K/3K 4.5K/5K 7K/8K 10K/12K 18K/21K
(Normal/Failure)
Sessions (Sec/Hour/ 25/90K/ 22.4K 45/162K/37.4K 70/256K/59.8K 100/360K/90K 150/540K/
Max) 170K

Note:
Session Manager Footprint 5 is only supported on Avaya Common Server Release 2, Release 3
and onward and not supported on Release 1.
Session Manager instances are intended to operate as redundant, homogeneous servers to provide
high reliability if a Session Manager failure or a network component failure occurs. Each Session
Manager should have similar system resources and a balanced number of devices.
Session Manager instances must be similarly sized in both processing power and available memory
to accommodate distributions of devices during failover. Small and large footprints are not intended
to be mixed in a solution. However, closely sized footprints, such as one size with the next size
down in the table above, can be mixed temporarily as capacities increase. You must ensure that the
number of devices failing over to a smaller footprint does not exceed the device capacities of that
footprint.
You can implement a system that consists of a mixture of Session Manager instances hosted on
VMware platforms as well as Session Manager instances hosted on the existing non-VMware
platforms. You must configure the VMware-based Session Manager to be similar to the non-
VMware-based Session Manager across the enterprise. Similar configurations ensure the best use
of system resources and handling failover scenarios. Be careful when configuring the system where

November 2016 Deploying Avaya Aura® Session Manager 25


Comments on this document? infodev@avaya.com
Planning and configuration

a large non-VMware Session Manager can failover to Session Manager running in VMware
environment. You must ensure that the target Session Manager can handle the total capacities.
A single 350K SIP device solution supports a geo-redundant Session Manager configuration of up to
28 Session Manager instances that are interconnected and aware of each other. Configurations that
exceed this limit are not expected to have problems, but these configurations are not guaranteed to
be supported.

Customer configuration data


The following table identifies the required customer configuration information for deployment and
configuration. An asterisk (*) indicates a required field.
Configuration Data Field Value for System Example
IP address*
Short hostname* example-sm-1
Network domain Mycompany.com
Netmask*
Network Settings
Default gateway*
DNS server(s) 123.4.56.789,142.67.
2.123
Comma-separated list,
up to 3 servers
Local time zone*
NTP server(s) Timeserver.ex.com,T
System Time Settings
S1.ex2.com
Comma-separated list,
up to 3 servers
Login Name*
Custom Login
Password*
Primary System Manager
IP address*
Enrollment password*
System Manager
Settings Note:
Verify the
enrollment
password is active.

November 2016 Deploying Avaya Aura® Session Manager 26


Comments on this document? infodev@avaya.com
Conditions for Appliance Virtualization Platform and VM hosts

Conditions for Appliance Virtualization Platform and VM


hosts
An Appliance Virtualization Platform host and all virtual machines running on the host must be on
the same subnet mask.
If Out of Band Management is configured in an Appliance Virtualization Platform deployment, you
need two subnet masks, one for each of the following:
• Public or signaling traffic, Appliance Virtualization Platform, and all virtual machines public
traffic.
• Management, Appliance Virtualization Platform, and all virtual machine management ports.

SAL Gateway
You require a Secure Access Link (SAL) Gateway for remote access and alarming.
Through SAL, support personnel or tools can gain remote access to managed devices to
troubleshoot and debug problems.
A SAL Gateway:
1. Receives alarms from Avaya products in the customer network.
2. Reformats the alarms.
3. Forwards the alarms to the Avaya support center or a customer-managed Network
Management System.
You can deploy SALGateway OVA:
• On Avaya Aura® Virtualized Appliance by using Solution Deployment Manager
• In the Avaya Aura® Virtualized Environment by using vCenter, vSphere or Solution Deployment
Manager
For more information about SAL Gateway, see the Secure Access Link documentation on the Avaya
Support website at http://support.avaya.com.

Installing the license file


Procedure
1. On the System Manager web console, click Services > Licenses.
2. In the left navigation pane, click Install license.
3. Click Browse to specify the location of the Session Manager license file on your computer.

November 2016 Deploying Avaya Aura® Session Manager 27


Comments on this document? infodev@avaya.com
Planning and configuration

4. Click Accept the License Terms & Conditions.


5. Click Install.
The system displays Session Manager in the Licensed products section.

November 2016 Deploying Avaya Aura® Session Manager 28


Comments on this document? infodev@avaya.com
Chapter 5: Deploying the Session Manager
OVA

Session Manager deployment checklist


Session Manager footprints are configured as part of the OVA. Both VMware and Solution
Deployment Manager display these footprints to the user during deployment.
Important:
You cannot administer a core Session Manager OVA as a Branch Session Manager (remote
survivable server). Deploy the Session Manager OVA as a core Session Manager only.
# Action Reference

1 Verify System Manager and Session Configuring the system for SM/BSM
Manager are configured. deployment on page 30.
2 Download the following from PLDS: Downloading software from PLDS on
page 60.
• Session Manager OVA file
• Session Manager patch file
3 Deploy the Session Manager OVA. Methods for deploying the Session
Manager OVA on page 30.
4 Configure the Session Manager virtual Configuring the virtual machine
machine to start automatically after a automatic startup settings on page 34.
power failure.
5 Start the Session Manager server.
6 Configure Session Manager. Install the Configuring Session Manager on
authentication file. page 37.
7 Apply the latest Session Manager Release Installing software patches on page 37.
7.0 and later patch.
8 Configure the alarming.
9 Verify the deployment. Post-installation checklist on page 42.

November 2016 Deploying Avaya Aura® Session Manager 29


Comments on this document? infodev@avaya.com
Deploying the Session Manager OVA

Configuring the system for Session Manager deployment


Procedure
1. Log in to System Manager associated with Session Manager.
2. Verify System Manager is running the same or later Service Pack level as the Session
Manager that you will be installing.
3. Navigate to Elements > Routing > SIP Entities page and add the Session Manager as a
SIP entity.
4. Navigate to Elements > Session Manager > Session Manager Administration and add
a Session Manager instance.
5. Navigate to Services > Security > Certificates > Enrollment Password and enter an
Enrollment Password.
Note:
Password must be alphanumeric and 6 to 25 characters long. Make note of the
password for future reference.
6. Define FQDNs for both System Manager and Session Manager. You can either configure the
FQDNs in the referenced DNS servers or add the FQDN of the Session Manager to the
hosts file of the System Manager.

Methods for deploying the Session Manager OVA


Deploy the Session Manager OVA using one of the following methods:
• Deploying using vSphere Client connected to vCenter on page 30. This is for VMWare
environment set up.
• Deploying using vSphere Client connected directly to VMware host on page 32.
• Deploying using the Solution Deployment Manager on page 33. This is for the Appliance
Virtualization Platform set up.

Deploying using vSphere Client connected to vCenter


When deploying using vCenter, the system prompts you before boot-up to enter the configuration
information. Make sure you have a copy of the Customer Configuration Data worksheet available
before you begin this procedure.
Before you begin
The vCenter must have access to the VMware host on which the Session Manager will be deployed.
• Install the vSphere client.
• Install the vCenter server.

November 2016 Deploying Avaya Aura® Session Manager 30


Comments on this document? infodev@avaya.com
Methods for deploying the Session Manager OVA

• Add the VMware host to the vCenter.


Note:
If you use vSphere Client 5.5 to connect to vCenter Server 5.5, a warning displays asking you to
use vSphere Web Client because of limitations with vSphere Client 5.5, so use vSphere Web
Client.
Procedure
1. Start the vSphere client.
2. Enter the IP address and the user credentials for the vCenter server.
3. On the vSphere client, click File > Deploy OVF Template.
4. In the Deploy OVF Template dialog box, do one of the following:
• In the Deploy from a file or URL field, enter the path to the Session Manager .ova file.
• Click Browse and navigate to the Session Manager .ova file from the local computer,
network share, CD-ROM, or DVD.
5. Verify the details of the OVF template, then click Next.
6. On the End User License Agreement page, click Accept.
7. Click Next.
8. (Optional) On the Name and Location page, in the Name field, change the name for the
virtual machine.
9. Select the Session Manager deployment configuration (footprint). For details on Session
Manager footprint, see Capacity limits for Core SM footprints on page 25. The networks
available are: Public network for the SIP and HTTP traffic, and Out of Band Management
network for SSH, System Manager — Session Manager communication, and SNMP.
10. In the Inventory Location area, select the appropriate datacenter and click Next.
Note:
The datacenter can be local to the host or a mounted shared storage such as NFS or
SAN. Select a datacenter large enough to accommodate the virtual machine and all
virtual disk files.
11. If the cluster exists, select the cluster and click Next.
12. Select the specific host within the cluster and click Next.
13. On the Storage page, select the required data store and click Next.
14. On the Disk Format page, click Thick Provision Lazy Zeroed.
The system displays the data store that you selected and the space available.
15. On the Network Mapping page, for each network that you specified in the OVA Template
Details page:
a. Click the Destination Network column.
b. Select a host network from the drop-down menu.

November 2016 Deploying Avaya Aura® Session Manager 31


Comments on this document? infodev@avaya.com
Deploying the Session Manager OVA

c. Click Next.
16. On the Properties page, enter the configuration data from the Customer Configuration Data
worksheet, then click Next.
17. Verify the deployment settings, then click Finish.
18. Check the Status in the Recent Tasks window and wait for the Deploy OVF template task
to display Completed.

Deploying using vSphere Client connected directly to VMware


host
Procedure
1. Start the vSphere Client.
2. Enter the IP address and the user credentials for the ESXi host. Ignore any security
warnings that the system displays.
3. Click File > Deploy OVF Template.
4. In the Deploy OVF Template dialog box, do one of the following:
• In the Deploy from a file or URL field, enter the path to the Session Manager .ova file.
• Click Browse and navigate to the Session Manager .ova file from the local computer,
network share, CD-ROM, or DVD.
5. Verify the details of the template, then click Next.
6. On the End User License Agreement page, click Accept.
7. Click Next.
8. On the Name and Location page, in the Name field, enter the name for the virtual machine,
then click Next.
9. Select the Session Manager deployment configuration (footprint). For details on Session
Manager footprint, see Capacity limits for Core SM footprints on page 25.
10. On the Storage page, select a destination storage for the virtual machine files, then click
Next.
Note:
The datastore can be local to the host or a mounted shared storage such as NFS or
SAN. Select a datastore large enough to accommodate the virtual machine and all
virtual disk files.
11. On the Disk Format page, select Thick Provision Lazy Zeroed, then click Next.
The system displays the data store that you selected and the available space.

November 2016 Deploying Avaya Aura® Session Manager 32


Comments on this document? infodev@avaya.com
Methods for deploying the Session Manager OVA

12. On the Network Mapping page, for each network that you specified in the OVA Template
Details page:
a. Click the Destination Network column.
b. Select a host network from the drop-down menu.
c. Click Next.
13. Verify the deployment settings, then click Finish.
14. Check the Status in the Recent Tasks window, and wait for the Deploy OVF template task
to display Completed.
The system prompts you to enter configuration information in the virtual machine system
console when you boot the virtual machine.

Deploying using Solution Deployment Manager through System


Manager
About this task
To deploy Session Manager by using Solution Deployment Manager, you must have System
Manager 7.0 or later.
Procedure
1. On the home page of System Manager Web Console, under Services, select Solution
Deployment Manager > VM Management.
2. Add the location for Session Manager virtual machine:
a. On the Location tab, click New.
b. Enter the required information. Enter optional information as necessary.
c. Click Save. The Save link does not become active until you enter all required
information.
3. Add an ESXi host:
a. In the VM Management Tree, select the location you just created.
b. On the Hosts tab, click New.
c. Enter the ESXi host information.
d. Click Save.
4. Add a Virtual Machine to the host:
a. In the VM Management Tree, select the host you just added.
b. On the Virtual Machine tab, click New.
c. In the Select Location and Hosts section, enter the name of the virtual machine.

November 2016 Deploying Avaya Aura® Session Manager 33


Comments on this document? infodev@avaya.com
Deploying the Session Manager OVA

5. Do one of the following:


• Click Select the OVA from LOCAL SMGR, enter the path to the .ova file, and click
Submit.
• Click Select OVA from software library, enter the path to the .ova file, and click
Commit.
Note:
This assumes that Session Manager OVA has been previously uploaded to the Software
Library using the System Manager web console. For more information, see
Administering Avaya Aura® Session Manager.
6. Enter the required information in the Network Parameters section.
7. Enter the required information in the Configuration Parameters section.
8. Click Deploy.
For more information on Solution Deployment Manager and vCenter deployment, see
Deploying Avaya Aura® Session Manager.

Configuring the virtual machine automatic startup settings


About this task
This procedure does not apply for deployments and upgrades of applications running on Appliance
Virtualization Platform.
When a vSphere ESXi host restarts after a power failure, the virtual machines that are deployed on
the host do not start automatically. You must configure the virtual machines to start automatically.
In high availability (HA) clusters, the VMware HA software ignores the startup selections.
Before you begin
Verify with the system administrator that you have the proper level of permissions to configure the
automatic startup settings.
Procedure
1. In the vSphere Client inventory, select the host where the virtual machine is located.
2. Click the Configuration tab.
3. In the Software section, click Virtual Machine Startup/Shutdown.
4. Click Properties in the upper-right corner of the screen.
5. In the System Settings section, select Allow virtual machines to start and stop
automatically with the system.
6. In the Manual Startup section, select the virtual machine.
7. Use the Move up button to move the virtual machine to the Automatic Startup section.

November 2016 Deploying Avaya Aura® Session Manager 34


Comments on this document? infodev@avaya.com
Troubleshooting a Session Manager virtual machine that does not power on

8. Click OK.
Example
The following is an example of the Virtual Machine Startup/Shutdown screen.

Troubleshooting a Session Manager virtual machine that


does not power on
The system displays appropriate messages for CPU or memory resource limitations. The Session
Manager might be deployed on a host that does not have the necessary resources allocated for
power up. A power up failure indicates the newly deployed OVA must be resized or resources are
being oversubscribed. The recommendation is to not oversubscribe resources.

November 2016 Deploying Avaya Aura® Session Manager 35


Comments on this document? infodev@avaya.com
Deploying the Session Manager OVA

Default CPU and memory reservations are built into the Session Manager OVA. The reservations
are set to match the desired configuration and based on the footprint. If the system does not have
sufficient resources to support a given footprint of Session Manager, select one of the following:
• A smaller footprint — You can support less number of devices, when you select a smaller
footprint.
• A footprint with larger capacity.

Reconfiguring hardware resources for flexible footprint


About this task
Reconfigure the CPU and RAM resources for the Session Manager virtual machine. The procedure
is for the setup in virtualized environment.
Note:
This procedure is not applicable to Appliance Virtualization Platform. For information about
managing hardware resources using Solution Deployment Manager, refer Migrating and
Installing Avaya Appliance Virtualization Platform and Avaya Aura® System Manager 7.0
Solution Deployment Manager Job-Aid.
Before you begin
To make the resource changes, power off the virtual machine.
Procedure
1. Connect to the host or cluster using the VMware vSphere client.
2. Log in as an administrator
3. Right-click on the virtual machine name and select Edit Settings.
4. Click the Hardware tab.
5. Click Memory and change the Memory Size to the appropriate limit.
6. Click the Resources tab.
7. Select Memory and verify the Reservation is set correctly.
8. If you want to limit the Session Manager memory use, clear the unlimited check box and
verify the Limit slide is set to the same value as the Reservation.
9. Click the Hardware tab.
10. Select CPUs and change the Number of sockets according to the limit requirement.
11. Click the Resources tab.
12. Select CPUs and verify the Reservation is set correctly. The Reservation value must be at
least half of the stated minimum MHz requirement because Session Manager capacities
assume hyperthreading is active.

November 2016 Deploying Avaya Aura® Session Manager 36


Comments on this document? infodev@avaya.com
Configuring Session Manager

13. If you want to limit the Session Manager CPU use:


a. Clear the unlimited check box.
b. Verify the Limit slide is set to the full value of the stated minimum MHz requirement.
14. Click OK and wait until the virtual machine finishes the reconfiguration procedure.
Related links
Capacity limits for Session Manager Footprints on page 25

Configuring Session Manager


If you deployed the Session Manager OVA using vCenter or the Solution Deployment Manager, skip
this procedure and continue to post-deployment.
Perform this entire procedure only if you deployed Session Manager OVA using vSphere Client
connected directly to the VMware host. Session Manager is not yet configured.
You are prompted for setup information during the first boot.
Procedure
1. Verify System Manager is configured and operational.
2. Right-click the Session Manager virtual machine and select Open Console.
3. Configure Session Manager:
a. At each prompt, enter the appropriate information from the Customer Configuration
Data worksheet.
b. Verify your settings.
c. Enter the enrollment password.
The system starts the configuration process. The process takes approximately 15
minutes to complete.

Installing software patches


About this task
Use the procedure to install the software patches for Session Manager, and commit the software
patches that you installed.
To install patches for Session Manager by using Solution Deployment Manager, you must have
System Manager 7.0 or later.
Before you begin
• Download the Session Manager patch file, Session_Manager_7.0.1.0.xxxxxx.iso.

November 2016 Deploying Avaya Aura® Session Manager 37


Comments on this document? infodev@avaya.com
Deploying the Session Manager OVA

• If you upgrade an application that was not deployed from Solution Deployment Manager,
perform the following:
1. On the home page of System Manager Web Console, under Services, select Solution
Deployment Manager > VM Management.
2. On the VM Management page, select the virtual machine.
3. To establish trust, click More Actions > Re-establish Connection.
4. Type the credentials and click Reestablish Connection.
The Current Action Status column displays the status of virtual machine
reestablishment.
5. Select the same virtual machine, click More Actions > Refresh VM.
The Current Action Status column displays the status of virtual machine.
Note:
To install software patches without using the Solution Deployment Manager, see Upgrading
Avaya Aura® Session Manager.
Procedure
1. On the System Manager web console, click Services > Solution Deployment Manager.
2. In the left navigation pane, click Upgrade Management.
3. Select the Session Manager virtual machine to install the patch.
4. Select the virtual machine, click Pre-upgrade Actions > Refresh Element(s).
a. On the Job Schedule page, in the Job Name field, type the job name.
b. Click Schedule.
5. Select the virtual machine, click Pre-upgrade Actions > Analyze.
a. On the Job Schedule page, in the Job Name field, type the job name.
b. Click Schedule.
After analyzing the software, the system enables the Pre-upgrade Actions > Pre-upgrade
Check.
6. Select the virtual machine, click Pre-upgrade Actions > Pre-upgrade Check.
a. On the Pre-upgrade Configuration page, specify the Target Host, Data Store, Upgrade
Source, and Upgrade/Update To details.
b. On the Job Schedule page, in the Job Name field, type the job name.
c. Click Schedule.
After performing the Pre-upgrade check, the system enables the Upgrade Actions >
Upgrade/Update.
7. Click Upgrade Actions > Upgrade/Update.
8. On the Upgrade Configuration page, click Edit.
9. In the General Configuration Details section, in the Operation field, click Update.

November 2016 Deploying Avaya Aura® Session Manager 38


Comments on this document? infodev@avaya.com
Installing software patches

10. In the Upgrade Source field, select the software library where you have downloaded the
patch.
11. In the Select patches for update section, the page displays the available patches.
12. Select the patch that you want to install.
13. (Optional) Select the Auto Commit check box, if you want the system to automatically
commit the patch.
Note:
If you do not select Auto Commit, then follow Steps 22 through 26.
14. In the Upgrade Configuration Details section, select the patch file that you want to install.
15. Accept the license agreement.
16. Click Save.
17. Ensure that the Configuration Status field displays .
18. Click Upgrade.
19. On the Job Schedule page, click one of the following:
• Run Immediately: To perform the job.
• Schedule later: To perform the job at a scheduled time.
20. Click Schedule.
On the Upgrade Management page, the Update status and Last Action Status columns
display .
21. To view the upgrade status, click .
The Upgrade Job Details page displays the detailed update checks that are in progress.
Click Done to close the window.
When the update is complete, the Upgrade Status and Last Action Status columns display
.
22. Click Upgrade Actions > Installed Patches.
23. On the Installed Patches page, in the Patch Operation section, click Commit.
The page displays all software patches that you can commit.
If you must rollback and uninstall the software patch, use Rollback and Uninstall options.
24. Select the patch that you installed, in the Job Schedule section, click Run Immediately.
You can use the Schedule later option to commit the patch at a later time.
25. Click Schedule.
The Upgrade Management page displays the last action as Commit.
26. Ensure that the Upgrade Status and Last Action Status columns display .

November 2016 Deploying Avaya Aura® Session Manager 39


Comments on this document? infodev@avaya.com
Deploying the Session Manager OVA

Related links
Installed Patches field descriptions on page 40

Installed Patches field descriptions


Name Description
Commit The option to select the patches that you can
commit.
Uninstall The option to select the patches that you can
uninstall.
Rollback The option to select the patches that you can
rollback.
Show All The option to display all the available options.

Name Description
Name The name of the software patch.
Element Name The element on which the software patch is installed.
Patch Version The version of the software patch.
Patch Type The type of the software patch. The options are:
• service pack or software patch
• Kernel
Patch State The state of the software patch. The options are:
• Installed
• Activated
• Deactivated
• Removed
• Uninstall
• Pending

Name Description
Schedule Job The option to schedule a job:
• Run immediately: To run the upgrade job
immediately.
• Schedule later: To run the upgrade job at the
specified date and time.
Date The date on which you want to run the job. The date
format is mm:dd:yyyy. Use the calendar icon to
choose a date.
Table continues…

November 2016 Deploying Avaya Aura® Session Manager 40


Comments on this document? infodev@avaya.com
Installing software patches

Name Description
This field is available when you select the Schedule
later option for scheduling a job.
Time The time when you want to run the job. The time
format is hh:mm:ss and 12 (AM or PM) or 24-hour
format.
This field is available when you select the Schedule
later option for scheduling a job.
Time Zone The time zone of your region.
This field is available when you select the Schedule
later option for scheduling a job.

Name Description
Schedule Runs the job or schedules to run at the time that you
configured in Job Schedule.

Related links
Installing software patches on page 37

November 2016 Deploying Avaya Aura® Session Manager 41


Comments on this document? infodev@avaya.com
Chapter 6: Post-installation verification

Post-deployment checklist
Perform the following steps to verify the Session Manager OVA deployment.
# Action Link

Verify the connections of the deployed Verifying the connections on page 42.
1
Session Manager.
2 Install the authentication file. Installing an authentication file on page 57.
Run the maintenance tests on the Running Session Manager maintenance
3
deployed Session Manager. tests on page 62.
4 Verify data replication. Verifying Data Replication on page 64.
5 Generate an alarm.

Verifying the connections


About this task
Verify the connections of the deployed Session Manager .
Verify the connections of the deployed Session Manager and Branch Session Manager.
Procedure
1. On the home page of the System Manager Web Console, in Elements, click Session
Manager.
2. Verify Security Module state is Up for Session Manager.
3. Verify the Service State of the Session Manager instance is Accept New Service. If the
service state is not Accept New Service:
a. Select the Session Manager instance.
b. Click Service State > Accept New Service.

November 2016 Deploying Avaya Aura® Session Manager 42


Comments on this document? infodev@avaya.com
Upgrading Session Manager VMware Tools

Upgrading Session Manager VMware Tools


About this task
Installing Session Manager service packs might cause loss of network connectivity due to incorrect
drivers.
The guest operating system checks the version of VMware Tools when you power on a virtual
machine. The status bar of the virtual machine displays a message regarding the availability of a
new version.
Caution:
Do not upgrade the VMware tools software that is packaged with each OVA unless instructed to
do so by Avaya. The supplied version is the supported release and has been thoroughly tested.
Note:
Starting with Release 7.0.1, Session Manager supports VMware Tools 6.0 version.
The procedure does not apply to Appliance Virtualization Platform.
Procedure
1. Right-click the target Session Manager virtual machine.
2. On the Guest menu, click Install/Upgrade VMware Tools.
3. Select Automatic Tools Upgrade in the pop-up window.
4. Click OK.
5. In the Recent Tasks window, check the status of the Initiated VMware Tools install or
upgrade task. Wait until the status displays Completed.
6. Reboot the Session Manager virtual machine.
When the reboot completes, network connectivity is restored.

November 2016 Deploying Avaya Aura® Session Manager 43


Comments on this document? infodev@avaya.com
Chapter 7: Migrating Session Manager

This chapter provides the procedures for migrating a bare-metal instance of Session Manager to a
VMware-based Session Manager. The Session Manager virtual machine reuses the IP addresses
and hostname of the hardware Session Manager.

Warning:
Capacities for the hardware-based Session Manager differ from the VMware-based Session
Manager. Before attempting a migration, verify the load capacity of the VMware Session
Manager is compatible with the hardware-based Session Manager. For information about the
VMware configuration requirements, see Capacity limits for Core Session Manager footprints on
page 25.

Migration checklist
# Action Reference

1 Plan the migration activities using the Planning checklist on page 24


planning checklist.
2 Verify System Manager is configured Configuring the system for SM/BSM
properly. deployment on page 30.
3 Download and run the data migration tool. Upgrading SM from 6.x to 7.0 on
VMware on page 45.
4 Download the Session Manager OVA from Downloading software from PLDS on
PLDS. page 60.
5 Deploy the Session Manager OVA. Methods for deploying the SM OVA on
page 30.
Do not power up the virtual machine.
6 Verify the Enrollment Password. Verifying Enrollment Password status on
page 47.
7 Deny new service for the old Session Denying new service on page 58.
Manager.
8 Shut down the old Session Manager. • Using the CLI to shut down or reboot
the server on page 48
Table continues…

November 2016 Deploying Avaya Aura® Session Manager 44


Comments on this document? infodev@avaya.com
Upgrading Session Manager from Release 6.x to 7.0 and later on VMware

# Action Reference

• Using the GUI to shut down or reboot


the server on page 48
9 Disconnect the old Session Manager from You do not want the old Session
the power source and the network. Manager to return to service and
interfere with the new Session Manager.
10 Configure the new Session Manager Configuring the virtual machine
virtual machine to start automatically after automatic startup settings on page 34.
a power failure.
11 Start the Session Manager virtual
machine.
12 Configure the new Session Manager. Configuring Session Manager on
page 37.
13 Restore the backup file on the new Restoring the dmutility backup file on
Session Manager. page 49.
14 Manage the serviceability agent. This procedure requires root access.
Redeploying Session Manager requires a Contact Avaya Global Services.
cleanup of the existing serviceability agent
data.
15 Verify the installation. Continue with the Post-installation
checklist on page 42.

Upgrading Session Manager from Release 6.x to 7.0 and


later on VMware
Before you begin
Back up the call history using User Data Storage. For more information, see Administering Avaya
Aura® Session Manager.
Session Manager stores call logs only when the Centralized Call History is enabled.
About this task
You must perform this procedure to get data migration tool certificates to avoid the loss of alarming
and configuration data.
Note:
You cannot use Data Migration Utility for Session Manager or Branch Session Manager that run
on Avaya-provided servers.
Procedure
1. Log into Session Manager with the customer account.

November 2016 Deploying Avaya Aura® Session Manager 45


Comments on this document? infodev@avaya.com
Migrating Session Manager

2. Go to the customer’s home directory. For example, cd /home/cust.


3. Download the latest version of the data migration utility to the local directory.
4. Run the dmutility-7.0.1.0.xxxxx.bin utility.
$ bash dmutility-7.0.1.0.xxxx.bin

Verifying signature... [ OK ]
Checking integrity of install.sh [ OK ]
Checking integrity of sm_backup.sh [ OK ]
Checking integrity of cs_functions.sh [ OK ]
Mounted ISO image /tmp/tmp.GUqkp31591 to /iso
Removing any previous backup files
Backing up data
Moving backup file to the current directory
Data backup is complete.
Copy /home/cust/Session_Manager_backup.tgz to a remote server before shutting
down Session Manager.

5. Copy the backup file to a remote server.


In most cases, the backup file is /home/cust/Session_Manager_backup.tgz. The
dmutility displays the exact location of the backup file as an output.
6. Use the shutdownSM command to shutdown Session Manager.
$ shutdownSM

Note: It is strongly suggested that the Session Manager


be in Deny New Service state and that one waits for all
active calls to end before shutting down the server.
Active calls through this Session Manager will drop if
it remains down too long. New calls will immediately use
an alternate Session Manager (if available) once
this Session Manager is placed in the Deny New Service state.

Do you really want to continue? (y or n)

7. Deploy the Release 7.0 Session Manager or Branch Session Manager OVA.
Note:
When you run the Data Migration Utility on Session Manager R 6.x, a datamigration file
is created. You must run the datamigration file after the Session Manager Release 7.0
ova is deployed, with the upgradeSM Session_Manager_backup.tgz command.
Then, upgrade to release 7.0.1 with the upgradeSM
Session_Manager_7.0.1.0.701007.iso command.
For deploying the Session Manager OVA on VMware, see Deploying Avaya Aura® Session
Manager.
8. On the newly deployed Session Manager, copy the backup file to the customer's home
directory.
9. Use the customer account to log into Session Manager. Use the upgradeSM command to
run the restore utility.
$ upgradeSM Session_Manager_backup.tgz
Performing data migration
VSP_PROGRESS[[Starting restore]]VSP_PROGRESS

November 2016 Deploying Avaya Aura® Session Manager 46


Comments on this document? infodev@avaya.com
Verifying the Enrollment Password status

VSP_PROGRESS[[Stopping Session Manager]]VSP_PROGRESS


...
Trust Management Initialization started.
Trust Management Initialization with System Manager started.
Trust Management Initialization completed.
Upgrading saved certificates
Saving upgrade files to /opt/Avaya/prev-upgrade
Downloading System Manager root CA
Waiting for WebSphere components to startup...
Waiting for WebSphere components to startup...
...
Waiting for Management components to startup...
Waiting for Management components to startup...
Thu Apr 9 16:06:37 MDT 2015: DRS Replication registration succeeded
Please go to the System Manager Replication Page to check the synchronization state

10. Log in to Session Manager and copy the 7.0.1 iso file.
11. Use the upgradeSM Session_Manager_7.0.1.0.701007.iso command to upgrade to
Release 7.0.1.
12. On the Session Manager Dashboard page, change Service State of the Session Manager
server to Accept New Service.
13. For VMware Virtualized Environment, delete the old Session Manager virtual machine.

Data preserved during upgrade


Note:
User Store data will not be preserved automatically on upgrades from pre 7.0 releases.
A new Authentication File System (AFS) file is required for Release 7.0 and later.

Verifying the Enrollment Password status


Session Manager requires an Enrollment Password during the initial installation and deployment
process. Enrolling a password establishes trust between System Manager and Session Manager.
The Enrollment Password is also known as the certificate enrollment password.
If the Enrollment Password has expired, or if you do not know the password, do one of the following:
• Ask the customer for a password.
• Make up a password.
Procedure
1. On the home page of the System Manager web console, under Services, select Security >
Certificates > Enrollment Password.

November 2016 Deploying Avaya Aura® Session Manager 47


Comments on this document? infodev@avaya.com
Migrating Session Manager

2. If the value of the Time Remaining field is zero, you need to reset the password:
a. In the Password expires in field, select a value from the drop-down menu for the time
when the password must expire.
b. Enter a password in the Password field.
c. Re-enter the password in the Confirm Password field.
d. Make a note of the password for future reference.
e. Click Commit.
The system updates the Time remaining field.

Using System Manager to shut down or reboot the server


Procedure
1. On System Manager Web Console, select Elements > Session Manager.
2. Select the Session Manager server that you want to shut down or reboot.
Note:
You can shut down or reboot only one Session Manager at a time.
3. Click Service State.
4. Select Deny New Service.
5. Wait for all active calls on Session Manager to end before shutting down or rebooting the
server.
6. Click Shutdown System.
7. Select Shutdown or Reboot from the drop-down menu.
The system displays a confirmation screen. If Session Manager is not in the Deny New
Service state, the system displays an additional screen with the recommended action.

Using the CLI to shut down or reboot the server


If you experience problems accessing System Manager, use the CLI to shut down or reboot that
particular Session Manager using the following procedure:
Procedure
1. Log in to the Session Manager using the customer login.
2. Enter one of the following commands:
• shutdownSM (to shut down the server)

November 2016 Deploying Avaya Aura® Session Manager 48


Comments on this document? infodev@avaya.com
Restoring the dmutility backup file

• rebootSM (to reboot the server)


3. If Session Manager is shut down, the confirmation screen warns that onsite personnel must
restart the system.

Restoring the dmutility backup file


Procedure
1. Copy the backup file to the customer's home directory on the newly deployed Session
Manager.
2. Log into the new Session Manager with the customer account.
3. Run the restore utility, upgradeSM, on the backup file. For example: upgradeSM /home/
cust/Session_Manager_backup.tgz.
4. When the script completes, on System Manager web console, navigate to Services >
Replication and verify the synchronization state is Synchronized.
5. Using the appropriate System Manager pages, delete the old Session Manager virtual
machine.

Appliance Virtualization Platform Migration


Avaya Appliance Virtualization Platform
Avaya Appliance Virtualization Platform is a base operating system for Avaya appliance offers
including Common Servers, S8300D, and S8300E.
This section contains Appliance Virtualization Platform migrating information for Session Manager.
For more information on Avaya Appliance Virtualization Platform, see Migrating and Installing Avaya
Appliance Virtualization Platform.

Configuring the Appliance Virtualization Platform USB drive


Before you begin
Use the USB drive that Avaya provides in the media kit for this procedure. The provided USB is a
FAT 32 format. If you must use a different USB, use a FAT 32 format file.
Procedure
1. Download a copy of Avaya Aura® Appliance Virtualization Platform 7.0 Kick Start Generator
from Avaya PLDS at https://plds.avaya.com/ or from Avaya support site at https://
support.avaya.com.

November 2016 Deploying Avaya Aura® Session Manager 49


Comments on this document? infodev@avaya.com
Migrating Session Manager

The kick start generator is also available from the 700510424 media kit on the USB stick.
2. Type the required details in the spreadsheet.
3. Click Generate AVP installation configuration file.
4. Save a copy of ks.cfg on the USB drive.
Next steps
Install Appliance Virtualization Platform.

Installing Appliance Virtualization Platform


About this task
Warning:
You can obtain the root password for the Appliance Virtualization Platform system from the USB
configuration file. The file must be kept secure. After installation, you must change the root
password for the Appliance Virtualization Platform host to a different value with the password
change option from Solution Deployment Manager.
Install Appliance Virtualization Platform on one of the following servers:
• Dell™ PowerEdge™ R610
• HP ProLiant DL360 G7
• Dell™ PowerEdge™ R620
• HP ProLiant DL360p G8
• Dell™ PowerEdge™ R630
• HP ProLiant DL360 G9
• S8300D for Communication Manager
• S8300E for Communication Manager
Release 7.0 and later does not support S8510 and S8800 servers.
Before you begin
• Configure the USB drive.
• Ensure that the backup file is saved on a different server because after the Appliance
Virtualization Platform installation, server restarts, and all data is lost.
• To use the Solution Deployment Manager client for deploying the virtual machines, install the
Solution Deployment Manager client on your computer.
Note:
To install Appliance Virtualization Platform server while connected to the customer network,
ensure that the IP address used for Appliance Virtualization Platform is not in use by another
system. If the configured IP address is already in use on the network during installation, the

November 2016 Deploying Avaya Aura® Session Manager 50


Comments on this document? infodev@avaya.com
Appliance Virtualization Platform Migration

installation process stops. You must remove the duplicate IP address, and restart the
installation.
Procedure
1. Insert the USB drive and the Appliance Virtualization Platform CD-ROM into the server.
Use an external Avaya-approved USB and CD-ROM drives for installing Appliance
Virtualization Platform on S8300D or S8300E. The only supported USB CD-ROM drive is
Digistor DIG73322, comcode 700406267.
2. Log on to the System Platform web console, and click Server Management > Server
Reboot/Shutdown > Reboot to restart the server.

Warning:
When the server restarts, Appliance Virtualization Platform is installed, and all existing
data on the server is lost.
The system installs Appliance Virtualization Platform and ejects CD-ROM. The installation
process might takes about 30 minutes to complete.
Note:
If using a monitor, the screen changes to black before the installation is complete. A
message in red text might briefly display, which is an expected behavior. Do not take
any action.
3. Remove the USB drive and CD-ROM.
Note:
When installing Appliance Virtualization Platform on an HP server, you must remove the
USB drive when the server ejects CD-ROM. Otherwise, the server might become
nonoperational on reboot. If the server becomes nonoperational, remove the USB drive,
and restart the server.
4. Using an SSH client, connect to the server through the eth1 services port by using the
following network parameters for your system:
• IP address: 192.168.13.5
• Netmask: 255.255.255.248
• Gateway: 192.168.13.1
The SSH client must use UTF-8. Alternatively, you can connect to the public network
address that was configured during the installation from a computer on the customer
network.
5. Log in to Appliance Virtualization Platform as root and provide the password that is
configured in the spreadsheet.
The system displays the End user license agreement (EULA) screen.
6. Read the EULA, and type Y to accept the terms.

November 2016 Deploying Avaya Aura® Session Manager 51


Comments on this document? infodev@avaya.com
Migrating Session Manager

You can press any key to read EULA, and use the space bar to scroll down.

Warning:
Accept EULA before you deploy virtual machines. If deployments are attempted before
you accept EULA, deployments fail.
7. On the System Manager web console, click Services > Solution Deployment Manager,
and then click VM Management.
8. Install the Appliance Virtualization Platform patch.
For more information, see Installing the Appliance Virtualization Platform patch from Solution
Deployment Manager.
9. Deploy the Utility Services virtual machine, and then all other virtual machines with the data
that you noted in “System Platform and Template values”.
For instructions to deploy Utility Services and other virtual machines, see Deploying Avaya
Aura® applications from System Manager.
10. From System Manager Solution Deployment Manager, install the required software patches
for the virtual machines.

Appliance Virtualization Platform Out of Band Management


Overview
When you install Appliance Virtualization Platform, the public network of virtual machines is
assigned to vmnic0 or Server Ethernet port 1 of the server.
In the installation spreadsheet, if Out of Band Management is:
• Disabled: The public and management interfaces of virtual machines are assigned on the
public network. Assign public and management interfaces of virtual machines on the same
network.
• Enabled: The public interfaces of virtual machines are assigned to vmnic0 or Server Ethernet
port 1, and the Out of Band Management interfaces are assigned to vmnic2 or Server Ethernet
port 3. Assign separate network ranges to the public and management interfaces of virtual
machines. The management port must be given an appropriate IP address of the public and
Out of Band Management network.
Note:
All virtual machines on an Out of Band Management enabled Appliance Virtualization
Platform host must support and implement Out of Band Management.
When Out of Band Management is:
• Disabled: The management port of Appliance Virtualization Platform is assigned to the public
interface.
• Enabled: The management port of Appliance Virtualization Platform is assigned to the Out of
Band Management network.
The vmnic1 or Server Ethernet port 2 of the server is assigned to the services port.

November 2016 Deploying Avaya Aura® Session Manager 52


Comments on this document? infodev@avaya.com
Appliance Virtualization Platform Migration

The hypervisor is 192.168.13.6 on the services port network (VMNIC1 or eth1).


After Utility Services OVA is deployed, from your computer by using an SSH client, gain access to
the Utility Services shell from the services port with the following:
• IP address: 192.11.13.5 or 192.11.13.30
• Gateway: 192.11.13.6
Common servers
When Appliance Virtualization Platform is installed, VMNIC0 is assigned to the public interface of
virtual machines.
When deploying or reconfiguring Appliance Virtualization Platform, if Out of Band Management is:
• Disabled: VMNIC0 is used for both network and management traffic.
• Enabled: VMNIC2 is used for management by all the virtual machines on that hypervisor.
S8300D
When you install the connection through the media gateway using Appliance Virtualization Platform ,
Ethernet ports are assigned to the public interface of the virtual machines. When you install the
connection through the media gateway backplane using Appliance Virtualization Platform, the LAN
port on the G4x0 Gateway is assigned to the public interface of virtual machines.
If Out of Band Management is enabled, the Out of Band Management network is assigned to a
separate VLAN on the public interface. Otherwise all virtual machine interfaces are on the same
network.
The Appliance Virtualization Platform management interface is assigned to:
• The public VLAN if Out of Band Management is disabled
• The Out of Band Management VLAN if Out of Band Management is enabled
Note:
To support Out of Band Management on S8300D, you require specific versions of gateway
firmware. To ensure that you are running the correct version, see the gateway documentation.
S8300E
When Appliance Virtualization Platform installs the connection through the media gateway, Ethernet
ports are assigned to the public interface of virtual machines. When Appliance Virtualization
Platform installs the connection through the media gateway backplane, the LAN port on the G4x0
Gateway is assigned to the public interface of virtual machines.
If Out of Band Management is enabled, the Out of Band Management network is on the LAN2
interface on the S8300E faceplate.
The Appliance Virtualization Platform management interface is assigned to:
• The public VLAN if Out of Band Management is disabled
• The Out of Band Management network if Out of Band Management is enabled

November 2016 Deploying Avaya Aura® Session Manager 53


Comments on this document? infodev@avaya.com
Migrating Session Manager

Session Manager Out of Band Management ports


Component Interface Description
Security Module (secmod) th1(public IP) The interface that manages SIP
and HTTP traffic to and from the
WebSphere Application Server
(WAS) traffic. Security Module is
the front-end of Session Manager
running Linux operating system
6.5 with Avaya proprietary
applications providing SIP
protection, TLS termination, and
firewall.
WebSphere (WAS) eth0 (public IP) A converged JSR289 container
that processes SIP messages
received from SIP entities or
endpoints.
Management Agent (MGMT) eth0 (public IP) A management console that is
used to listen on port 8643 for an
HTTPS connection to add,
remove, restart, or monitor
Session Manager.
SAL-Agent eth0 (public IP) A Java application that receives
events and collects inventory
information from the product and
converts them to its own internal
format. It then encapsulates the
message into HTTPS and sends
the information to an Enterprise
Server, usually at Avaya.
Data Replication Service (DRS) eth0 (public IP) A service that synchronizes
database changes between
System Manager and Session
Manager. DRS uses HTTPS for
replication messages. JMX is used
from remote management.

For information on Management Port and Security Port, see Session Manager Port Matrix.

November 2016 Deploying Avaya Aura® Session Manager 54


Comments on this document? infodev@avaya.com
Chapter 8: Maintenance and administration
procedures

Adding Session Manager as a SIP entity


Procedure
1. On the home page of the System Manager Web Console, in Elements, click Routing > SIP
Entities.
2. Click New.
3. In the Name field, enter the name of the Session Manager.
4. In the FQDN or IP Address field, enter the IP address of the Session Manager Security
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.
7. Add the port, protocol, and default domain entries for each port and protocol on which the
Session Manager listens for SIP traffic.
Add failover ports if the SIP entity is a failover group member. For more information about
Failover Groups, see Administering Avaya Aura® Session Manager.
8. Click Commit.

Authentication files for Session Manager


The authentication file contains Access Security Gateway (ASG) keys and the server certificate for
Session Manager. With the ASG keys, Avaya Services can gain secure access to the customer
system.
Session Manager installs a default authentication file. You must replace the default file using the
Authentication File System (AFS) to create a unique authentication file. AFS is an online application
available at RFA.
Each authentication file contains an authentication file ID (AFID) to identify the file. You use the
AFID to create a new authentication file to replace the current authentication file on the server.

November 2016 Deploying Avaya Aura® Session Manager 55


Comments on this document? infodev@avaya.com
Maintenance and administration procedures

Note:
Installation of the unique authentication file is essential. Failure to install the unique
authentication file results in receiving an alarm that retransmits daily until you install the
authentication file.

Starting the AFS application


Before you begin
AFS is available only to Avaya service personnel and Avaya Partners. If you are a customer and
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 a login at
http://rfa.avaya.com.
Procedure
1. Enter 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 Session Manager


AFS is available only to Avaya service personnel and Avaya Partners. If you are a customer and
need an authentication file, contact Avaya or your authorized Avaya Partner.
To acquire an authentication file, download the authentication file directly from AFS.
After AFS creates the authentication file, AFS displays a confirmation message that contains the
system type, release, and authentication file ID (AFID).
Procedure
1. Enter http://rfa.avaya.com in your browser and log in.
2. Click Start the AFS Application, then click I agree.
3. In the Product field, select SM Session Manager.
4. In the Release field, select the software release number, then click Next.
5. If you are installing a new Session Manager instance (not upgrading), select New System,
then click Next.

November 2016 Deploying Avaya Aura® Session Manager 56


Comments on this document? infodev@avaya.com
Accepting new service

6. 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, then click Save.
d. Click Close in the Download complete dialog box to complete the download.
7. To view the header information in the authentication file:
a. Locate the saved file.
b. Open the file with WordPad.
The header includes the AFID, product name and release number, and the date and time
that AFS generated the authentication file.

Installing an authentication file


Procedure
1. Log in using the customer login to the Session Manager server using an SSH tool such as
PuTTy.
2. Enter the command echo $HOME.
3. Using WinSCP or some other file transfer program, transfer the authentication file for the
Session Manager server into the directory represented by $HOME.
4. Load the authentication file manually using the loadpwd command. For example:
loadpwd -l <path to the auth file>.
5. Enter the displaypwd command to display information about the currently loaded
authentication file.

Accepting new service


Note:
Even though the Security Module displays the status as Up, the security module might take 5 to
10 minutes before the security module can begin routing calls.
Procedure
1. On the home page of the System Manager Web Console, in Elements, click Session
Manager.
2. On the Session Manager Dashboard page, select the appropriate Session Manager or
Branch Session Manager in the Session Manager Instances table.

November 2016 Deploying Avaya Aura® Session Manager 57


Comments on this document? infodev@avaya.com
Maintenance and administration procedures

3. Click Service State.


4. Select Accept New Service from the drop-down menu.
5. Click Confirm.

Denying new service


When you change the state of the selected Session Manager to Deny New Service, the system
denies any new call attempts and service requests. Existing calls remain in effect until the users
terminate the calls.
Procedure
1. On the home page of System Manager Web Console, Under Elements, click Session
Manager.
2. On the Session Manager Dashboard page, select the appropriate Session Manager or
Branch Session Manager in the Session Manager Instances table.
3. Click Service State.
4. From the drop-down list box, select Deny New Service.
5. On the confirmation page, click Confirm.

Creating a snapshot
Caution:
Do not perform any activity on the virtual application until the snapshot backup is complete.
Snapshot operations can adversely affect service.
Before you begin
Verify with the system administrator that the required privilege Virtual machine.State.Create
snapshot is available on the virtual machine.
Note:
Differences exist between the vSphere Web Client versions. You might need to modify the
following steps accordingly.
Procedure
1. To select a virtual machine using the vSphere Web Client:
a. Search for a virtual machine and select it from the search results list.
b. Stop the application that is running on the virtual machine or make the application out-
of-service.

November 2016 Deploying Avaya Aura® Session Manager 58


Comments on this document? infodev@avaya.com
Deleting a snapshot

c. Right-click the virtual machine and select Snapshot > Take Snapshot.
2. To select a virtual machine using the vSphere Client:
a. Stop the application that is running on the virtual machine or make the application out-
of-service.
b. Click Inventory > Virtual Machine > Snapshot > Take Snapshot.
3. In the Name field, enter a name for the snapshot.
4. In the Description field, enter a description for the snapshot.
5. Disable Snapshot the virtual machine’s memory.
6. Enable Quiesce guest file system (Needs VMware Tools installed).
7. Click OK.
The system displays Completed when the snapshot backup is complete.

Deleting a snapshot
Note:
Differences exist between the vSphere Web Client versions. Modify the steps accordingly.
Before you begin
Verify the required privilege Virtual machine.State.Remove snapshot is available on the virtual
machine.
Procedure
1. To open the Snapshot Manager using the vSphere Web Client:
a. Search for a virtual machine.
b. Select the virtual machine from the search results list.
c. Right-click the virtual machine and select Snapshot > Snapshot Manager.
2. To open the Snapshot Manager using the vSphere client, select Inventory > Virtual
Machine > Snapshot > Snapshot Manager.
3. In the Snapshot Manager, click a snapshot to select it.
4. Select Delete from Disk to delete the single snapshot from the Snapshot Manager and the
virtual machine.
5. Click Yes in the confirmation dialog box.
6. If you are using the vSphere Web Client, click Close to close the Snapshot Manager.

November 2016 Deploying Avaya Aura® Session Manager 59


Comments on this document? infodev@avaya.com
Maintenance and administration procedures

Restoring a snapshot
Use this procedure to return the memory, settings, and state of the virtual machines to the state
when you took the snapshot. The power and data states of the virtual machines return to the state
when you took the parent snapshot.
Important:
Do not perform any activity on the virtual application until the snapshot restoration is complete.
Before you begin
Verify with the system administrator that the required privilege Virtual machine.State.Revert to
snapshot is available on the virtual machine.
Note:
Differences exist between the vSphere Web Client versions. You might need to modify the steps
accordingly.
Procedure
1. Click Inventory > Virtual Machine.
2. Right-click the virtual machine name on which you want to restore the snapshot, and click
Snapshot.
3. Open Snapshot Manager.
4. Select the snapshot version that you want to restore.
5. Click Go to.
6. In the Recent Tasks window, verify the Status of the Revert snapshot task.
Wait until the message Completed displays.

Downloading software from PLDS


When you place an order for an Avaya PLDS-licensed software product, PLDS creates the license
entitlements of the order and sends an email notification to you. The email includes a license
activation code (LAC) and instructions for accessing and logging into PLDS. Use the LAC to locate
and download the purchased license entitlements.
In addition to PLDS, you can download the product software from http://support.avaya.com using
the Downloads and Documents tab at the top of the page.
Note:
Only the latest service pack for each release is posted on the support site. Previous service
packs are available only through PLDS.

November 2016 Deploying Avaya Aura® Session Manager 60


Comments on this document? infodev@avaya.com
Restarting a virtual machine from Solution Deployment Manager

Procedure
1. Enter http://plds.avaya.com in your Web browser to access the Avaya PLDS website.
2. Enter your login ID and password.
3. On the PLDS home page, select Assets.
4. Click View Downloads.
5. Click on the search icon (magnifying glass) for Company Name.
6. In the %Name field, enter Avaya or the Partner company name.
7. Click Search Companies.
8. Locate the correct entry and click the Select link.
9. Enter the Download Pub ID.
10. Click Search Downloads.
11. Scroll down to the entry for the download file and click the Download link.
12. In the Download Manager box, click the appropriate download link.
Note:
The first link, Click to download your file now, uses the Download Manager to
download the file. The Download Manager provides features to manage the download
(stop, resume, auto checksum). The click here link uses your standard browser
download and does not provide the download integrity features.
13. If you use Internet Explorer and get an error message, click the install ActiveX message at
the top of the page and continue with the download.
14. Select a location where you want to save the file and click Save.
15. If you used the Download Manager, click Details to view the download progress.

Restarting a virtual machine from Solution Deployment


Manager
Before you begin
• System Manager is operational, and ESXi or vCenter is added to the VM Management page to
deploy Avaya Aura® Application OVA on ESXi virtual machines.
• Virtual machines must be in the running state.
Procedure
1. On the System Manager web console, click Services > Solution Deployment Manager,
and then click VM Management.
2. From the virtual management tree, select a host to which you added virtual machines.

November 2016 Deploying Avaya Aura® Session Manager 61


Comments on this document? infodev@avaya.com
Maintenance and administration procedures

3. On the Virtual Machines tab, select one or more virtual machines that you want to restart.
4. Click Restart.
In VM State, the system displays Stopped and then Started.

Running maintenance tests


Run the maintenance tests on System Manager or any administered Session Manager or Branch
Session Manager.
Procedure
1. On the System Manager Web Console, under Elements, click Session Manager > System
Tools > Maintenance Tests.
2. In the System Manager or a Session Manager to test field, select System Manager, a
Session Manager instance, or a Branch Session Manager instance from the drop-down
menu.
3. Do one of the following:
• To run all the tests, select Execute All Tests.
• To run only certain tests, select the tests you want to run and click Execute Selected
Tests.
4. Verify the tests pass.

Session Manager Backup and Restore


Use the native System Manager backup and restore function for the long-term backup and recovery
of entire cluster of the Session Manager when running on VMware.
For more information about Session Manager backup and restore, see Administering Avaya Aura®
Session Manager on the Avaya support website at http://support.avaya.com.
Note:
This procedure only backs up administration data.

Accessing the Backup and Restore service


Procedure
On System Manager Web Console, click Services > Backup and Restore.

November 2016 Deploying Avaya Aura® Session Manager 62


Comments on this document? infodev@avaya.com
Session Manager Backup and Restore

Note:
The secondary System Manager that is in the standby mode does not display the Backup and
Restore link on the web console.
Result
The system displays the Backup and Restore page.

Backup and Restore field descriptions


Name Description
Operation The type of operation. The values are:
• Backup
• Restore
File Name • For the backup operation, the name of the backup
file.
• For the restore operation, the name of the backup
file that was used for the restore.
Path • For the backup operation, the path of the backup
file.
• For the restore operation, the path of the backup
file that was used for the restore.
Status The status of the backup or restore operation. The
values are:
• SUCCESS
• FAILED
• PLANNED
• RUNNING
Status Description The error details of the backup or restore operation
that has failed.
Operation Time The time of the backup or restore operation.
Operation Type Defines whether the backup or restore operation is
local or remote.
User The user who performed the operation.

Button Description
Backup Opens the Backup page from where you can backup
the System Manager data.
Restore Opens the Restore page from where you can restore
the data to System Manager.

November 2016 Deploying Avaya Aura® Session Manager 63


Comments on this document? infodev@avaya.com
Maintenance and administration procedures

Verifying the Active Call Count


The Active Call Count value indicates the number of active calls on the Session Manager instance.
Active calls are calls that were already active before the Session Manager was placed in the denial
state. Changing the state to Deny New Service does not drop calls that are currently processed.
To prevent any impact on calls that are active, the Active Call Count must be zero before
proceeding with the Session Manager upgrade. If the administrator decides to continue the upgrade
if the active call count is not zero, the active calls are dropped.
Procedure
1. On the home page of the System Manager Web Console, in Elements, click Session
Manager.
2. Wait until Active Call Count is zero. Refresh the screen to update the count.

Verifying data replication


Procedure
1. On the System Manager web console home page, under Services, click Replication.
2. Select the appropriate Replica Group and click View Replica Nodes.
3. Confirm the selected Replica Group Host Name is Synchronized (green).

4. If the selected Replica Group Host Name is not Synchronized:


a. Select the appropriate Replica Group Host Name.
b. Click Repair.

Troubleshooting Data Replication


Procedure
1. On the home page of the System Manager Web console, under Services, click Replication.
2. If the status for the replica group is not Synchronized:
a. Select the affected replica group.
b. Click View Replica Nodes.
c. Verify that an instance exists in the replica group under Replica Group Host Name.
d. Select the appropriate instance under Replica Group Host Name.
e. Click View Details.
f. Under the Synchronization Statistics section, wait until the Pending Batches value is
zero. Refresh the page as necessary by clicking Refresh.

November 2016 Deploying Avaya Aura® Session Manager 64


Comments on this document? infodev@avaya.com
Viewing the Security Module page

3. If the Pending Batches value does not change to zero:


a. Click Done.
b. On the Replica Group page, click Repair.
c. Click OK in the dialog box.
4. Wait until the status of the replica group changes to Synchronized. Refresh the page as
necessary.

Viewing the Security Module page


Possible causes for the Security Module status to be Down include:
• The security module may have recently been reset. A reset can take several minutes to
complete.
• The security module may not have received security module configuration information from
System Manager.
Procedure
1. On the home page of the System Manager Web Console, in Elements, click Session
Manager.
2. If the Security Module state of Session Manager does not display as Up:
a. Click on the status text of the Security Module for Session Manager to display the
Security Module Status page.
b. Verify the IP address for Session Manager is correct.
c. Select Session Manager.
d. Click Synchronize.
e. If the status remains Down, click Reset.

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

Troubleshooting Security Module Sanity failure


Procedure
1. On the System Manager Web Console, select Elements > Session Manager > System
Status > Security Module Status.
2. Select Refresh to display the current status.
3. Verify that the Status for the indicated Session Manager is Up.

November 2016 Deploying Avaya Aura® Session Manager 65


Comments on this document? infodev@avaya.com
Maintenance and administration procedures

4. Verify that the IP address is correct.


5. If the status is selected as Down, reset the security module:
a. Select the appropriate Session Manager instance from the table.
b. Click Reset.

Warning:
Session Manager cannot process calls while the system resets the security module.
6. Select Refresh to display the current status.

Viewing the Session Manager Entity Link Connection


Status
Note:
Entity Monitoring does not apply to a Branch Session Manager. The monitoring status of a
Branch Session Manager is always unknown (---).
An entity link consists of one or more physical connections between a Session Manager server and
a SIP entity. If all the connections are up, then the Entity Link status is up. If one or more
connections are down but at least one connection is up, the link status is partially down. If all the
connections are down, the Entity Link status is down.
On the Session Manager dashboard page, the number of down links and total links are shown in the
Entity Monitoring column. The values have the format # of Down links / # of Total links.
Procedure
1. On the home page of the System Manager Web Console, in Elements, click Session
Manager.
2. Under the Entity Monitoring column, red values indicate that at least one entity link is down.
Click the red values link to display the Session Manager Entity Link Connection Status page.
The Session Manager Entity Link Connection Status page displays the details for each link.
If a link is down, the page displays a reason code.
3. To view the SIP Entity Link Monitoring Status Summary page, click Summary View.

Viewing the SIP Monitoring Status Summary page


The SIP Entity Link Monitoring Status Summary page displays the status of the entity links for all the
administered Session Manager instances. An entity link consists of one or more physical
connections between a Session Manager server and a SIP entity.

November 2016 Deploying Avaya Aura® Session Manager 66


Comments on this document? infodev@avaya.com
Viewing the SIP Monitoring Status Summary page

Procedure
On the System Manager Web Console, under Elements, click Session Manager > System Status
> SIP Entity Monitoring.

November 2016 Deploying Avaya Aura® Session Manager 67


Comments on this document? infodev@avaya.com
Chapter 9: Resources

Documentation
The following documents are available at http://support.avaya.com.
For the latest information, see the Session Manager Release Notes.
Title Description Audience
Overview
Avaya Aura® Session Manager Describes the key features of Session IT management
Overview and Specification Manager.
System administrators
®
Avaya Aura Virtualized Environment Describes the Avaya Virtualized Sales engineers
Solution Description Environment, design considerations,
Implementation
topology, and resources requirements.
engineers
Support personnel
®
Avaya Aura Session Manager Describes the security considerations, Network
Security Design features, and solutions for Session administrators,
Manager. services, and support
personnel
Avaya Aura® Session Manager 7.0.1 Contains enhancements, fixes, and System administrators
Release Notes workarounds for the Session Manager 7.0.1
Services and support
release.
personnel
Implementation
Deploying Avaya Aura® applications Describes how to deploy the Avaya Aura® Services and support
from System Manager virtual applications using the System personnel
Manager Solution Deployment Manager.
Deploying Avaya Aura® Session Describes how to deploy the Session Services and support
Manager Manager virtual application in a virtualized personnel
environment.
Deploying Avaya Aura® Branch Describes how to install and configure Services and support
Session Manager Branch Session Manager in a virtualized personnel
environment.
Routing Web Service API Describes how to use the System Manager Services and support
Programming Reference Routing Web Service API for Session personnel
Manager.
Table continues…

November 2016 Deploying Avaya Aura® Session Manager 68


Comments on this document? infodev@avaya.com
Documentation

Title Description Audience


Upgrading and Migrating Avaya Describes how to upgrade and migrate the Services and support
Aura® applications to Release 7.0.1 Avaya Aura® virtual applications using personnel
from System Manager System Manager Solution Deployment
Manager.
Using
Using the Solution Deployment Deploy and install patches for Avaya Aura System administrators
Manager client applications.
Administration
Administering Avaya Aura® Session Describes the procedures to administer System administrators
Manager Session Manager using System Manager.
Administering Avaya Aura® Describes the procedures to administer System administrators
Communication Manager Server Communication Manager as a feature
Options server or an evolution server. Provides
information related to Session Manager
administration.
Avaya Aura® Session Manager Case Provides common administration scenarios. System administrators
Studies
Installation and upgrades
Installing the Dell™ PowerEdge™ Describes the installation procedures for the Services and support
R610 Server Dell™ PowerEdge™ R610 server. personnel
Installing the Dell™ PowerEdge™ Describes the installation procedures for the Services and support
R620 Server Dell™ PowerEdge™ R620 server. personnel
Installing the Dell™ PowerEdge™ Describes the installation procedures for the Services and support
R630 Server Dell™ PowerEdge™ R630 server. personnel
Installing the HP ProLiant DL360 G7 Describes the installation procedures for the Services and support
Server HP ProLiant DL360 G7 server. personnel
Installing the HP ProLiant DL380p Describes the installation procedures for the Services and support
G8 Server HP ProLiant DL380p G8 server. personnel
Installing the HP ProLiant DL360 G9 Describes the installation procedures for the Services and support
Server HP ProLiant DL360 G9 server. personnel
Upgrading Avaya Aura® Session Describes the procedures to upgrade Services and support
Manager Session Manager to the latest software personnel
release.
Migrating and Installing Avaya Describes the migration and installation Services and support
Appliance Virtualization Platform procedures for Appliance Virtualization personnel
Platform.
Using the Solution Deployment Describes the patch deployment and Services and support
Manager client installation procedure for Avaya Aura® personnel
applications.
Maintaining and Troubleshooting
Maintaining Avaya Aura® Session Contains the procedures for maintaining Services and support
Manager Session Manager. personnel
Table continues…

November 2016 Deploying Avaya Aura® Session Manager 69


Comments on this document? infodev@avaya.com
Resources

Title Description Audience


®
Troubleshooting Avaya Aura Contains the procedures to troubleshoot Services and support
Session Manager Session Manager, resolve alarms, and personnel
replace hardware.

Related links
Finding documents on the Avaya Support website on page 70

Finding documents on the Avaya Support website


About this task
Use this procedure to find product documentation on the Avaya Support website.
Procedure
1. Use a browser to navigate to the Avaya Support website at http://support.avaya.com/.
2. At the top of the screen, enter your username and password and click Login.
3. Put your cursor over Support by Product.
4. Click Documents.
5. In the Enter your Product Here search box, type the product name and then select the
product from the drop-down list.
6. If there is more than one release, select the appropriate release number from the Choose
Release drop-down list.
7. Use the Content Type filter on the left to select the type of document you are looking for, or
click Select All to see a list of all available documents.
For example, if you are looking for user guides, select User Guides in the Content Type
filter. Only documents in the selected category will appear in the list of documents.
8. Click Enter.
Related links
Documentation on page 68

Training
The following table contains courses that are available on https://www.avaya-learning.com. To
search for the course, in the Search field, enter the course code and click Go.
New training courses are added periodically. Enter Session Manager in the Search field to display
the inclusive list of courses related to Session Manager.

November 2016 Deploying Avaya Aura® Session Manager 70


Comments on this document? infodev@avaya.com
Viewing Avaya Mentor videos

Course code Course title


1A00236E Knowledge Access: Avaya Aura® Session and System Manager Fundamentals
4U00040E Knowledge Access: Avaya Aura® Session Manager and System Manager
Implementation
5U00081V Session Manager Administration
5U00082I Session Manager and System Manager Administration
5U00082R Session Manager and System Manager Administration
5U00050E Knowledge Access: Avaya Aura® Session Manager and System Manager Support
5U00095V System Manager Implementation, Administration, Maintenance and
Troubleshooting
5U00096V Avaya Aura® Session Manager Implementation, Administration, Maintenance and
Troubleshooting
5U00097I Avaya Aura® Session and System Manager Implementation, Administration,
Maintenance and Troubleshooting
5U00105W Avaya Aura® Session Manager Overview
ATC01840OEN Survivable Remote Session Manager Administration
ATU00171OEN Session Manager General Overview
ATC00175OEN Session Manager Rack and Stack
ATU00170OEN Session Manager Technical Overview
2011V What is new in Avaya Aura® System Manager 7.0 and Avaya Aura® Session
Manager 7.0

Viewing Avaya Mentor videos


Avaya Mentor videos provide technical content on how to install, configure, and troubleshoot Avaya
products.
About this task
Videos are available on the Avaya Support website, listed under the video document type, and on
the Avaya-run channel on YouTube.
Procedure
• To find videos on the Avaya Support website, go to http://support.avaya.com and perform one
of the following actions:
- In Search, type Avaya Mentor Videos to see a list of the available videos.
- In Search, type the product name. On the Search Results page, select Video in the
Content Type column on the left.

November 2016 Deploying Avaya Aura® Session Manager 71


Comments on this document? infodev@avaya.com
Resources

• To find the Avaya Mentor videos on YouTube, go to 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 product or
topic.
- Scroll down Playlists, and click the name of a topic to see the available list of videos posted
on the website.
Note:
Videos are not available for all products.

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

November 2016 Deploying Avaya Aura® Session Manager 72


Comments on this document? infodev@avaya.com
Appendix A: Best Practices for VMware
performance and features

The following sections describe the best practices for VMware performance and features.

BIOS
For optimal performance, turn off power saving server options. See the technical data provided by
the manufacturer for your particular server regarding power saving options.
For information about how to use BIOS settings to improve the environment for latency-sensitive
workloads for an application, see the technical white paper at http://www.vmware.com/files/pdf/
techpaper/VMW-Tuning-Latency-Sensitive-Workloads.pdf.
The following sections describe the recommended BIOS settings for:
• Intel Virtualization Technology
• Dell PowerEdge Servers
• HP ProLiant Servers

Intel Virtualization Technology


Intel CPUs require EM64T and Virtualization Technology (VT) support in the chip and in the BIOS to
run 64–bit virtual machines.
All Intel Xeon processors include:
• Intel Virtualization Technology
• Intel Extended Memory 64 Technology
• Execute Disable Bit
Ensure that VT is enabled in the host system BIOS. The feature is also known as VT, Vanderpool
Technology, Virtualization Technology, VMX, or Virtual Machine Extensions.

November 2016 Deploying Avaya Aura® Session Manager 73


Comments on this document? infodev@avaya.com
Best Practices for VMware performance and features

Note:
The VT setting is locked as either On or Off when the server starts. After enabling VT in the
system BIOS, save your changes to the BIOS settings and exit. The BIOS changes take effect
after the host server reboots.
Other suggested BIOS settings
Servers with Intel Nehalem class and newer Intel Xeon CPUs offer two more power management
options: C-states and Intel Turbo Boost. These settings depend on the OEM make and model of the
server. The BIOS parameter terminology for current Dell and HP servers are described in the
following sections. Other server models might use other terminology for the same BIOS controls.
• Disabling C-states lowers latencies to activate the CPUs from halt or idle states to a fully active
state.
• Intel Turbo Boost steps up the internal frequency of the processor if the workload requires
more power. The default for this option is enabled. Do not change the default.

Dell PowerEdge Server


When the Dell server starts, press F2 to display the system setup options.
• Set the Power Management Mode to Maximum Performance.
• Set the CPU Power and Performance Management Mode to Maximum Performance.
• In Processor Settings, set:
- Turbo Mode to enable.
- C States to disabled.

HP ProLiant Servers
The following are the recommended BIOS settings for the HP ProLiant servers:
• Set the Power Regulator Mode to Static High Mode.
• Disable Processor C-State Support.
• Disable Processor C1E Support.
• Disable QPI Power Management.
• Enable Intel Turbo Boost.

Timekeeping
For accurate timekeeping, use the Network Time Protocol (NTP) as a time source instead of the
ESXi hypervisor.

November 2016 Deploying Avaya Aura® Session Manager 74


Comments on this document? infodev@avaya.com
Timekeeping

The NTP servers can be local or over the Internet. If the NTP servers are on the Internet, the
corporate firewall must open UDP port 123 so that the NTP service can communicate with the
external NTP servers.
The VMware tools time synchronization method is disabled at application deployment time to avoid
dueling clock masters. You must configure the NTP service first because the applications are not
receiving clock updates from the hypervisor. To verify that VMware Tools Timesync is disabled, run
the command /usr/bin/vmware-toolbox-cmd timesync status.
In certain situations, the ESXi hypervisor pushes an updated view of its clock into a virtual machine.
These situations include starting the virtual machine and resuming a suspended virtual machine, If
this view differs more than 1000 seconds from the view that is received over the network, the NTP
service might shutdown. In this situation, the guest OS administrator must manually set the guest
clock to be the same or as close as possible to the network time source clock. To keep the NTP
service active, the clock on the ESXi host must also use an accurate clock source, such as the
same network time source that is used by the guest operating system. The VMware
recommendation is to add tinker panic 0 to the first line of the ntp.conf file so that the NTP can
adjust to the network time even with large differences.
If you use the names of the time servers instead of the IP address, you must configure the Domain
Name Service in the guest OS before you administer the NTP service. Otherwise, the NTP service
cannot locate the time servers. If you administer the NTP service first, you must restart the NTP
service after administering the DNS service.
After you administer the NTP service in the application, run the ntpstat or /usr/sbin/ntpq -p
command from a command window. The results from these commands:
• Verify if the NTP service is getting time from a network time source.
• Indicate which network time source is in use.
• Display how closely the guest OS matches the network time.
• Display how often the guest OS checks the time.
The guest OS polls the time source every 65 to 1024 seconds. Larger time intervals indicate that the
guest clock is tracking the network time source closely. If the time source is local, then the NTP
service is not using a network time source and a problem exists.
If the clock value is consistently wrong, look through the system log for entries regarding ntpd. The
NTP service writes the activities it performs to the log, including when the NTP service loses
synchronization with a network time source.
For more information, see Timekeeping best practices for Linux guests at http://kb.vmware.com/kb/
1006427. The article presents best practices for Linux timekeeping to achieve best timekeeping
results. The article includes:
• specifics on the particular kernel command line options to use for the Linux operating system of
interest.
• recommended settings and usage for NTP time sync, configuration of VMware Tools time
synchronization, and Virtual Hardware Clock configuration.

November 2016 Deploying Avaya Aura® Session Manager 75


Comments on this document? infodev@avaya.com
Best Practices for VMware performance and features

VMware Tools
The VMware Tools utility suite is built into the application OVA. The tools enhance the performance
of the guest operating system on the virtual machine and improve the management of the virtual
machine.
VMware tools provide:
• VMware Network acceleration
• Host to Guest time synchronization
• Disk sizing
For more information about VMware tools, see Overview of VMware Tools at http://
kb.vmware.com/kb/340.
Important:
Do not upgrade the VMware tools software that is packaged with each OVA unless instructed to
do so by Avaya. The supplied version is the supported release and has been thoroughly tested.

VMware networking best practices


You can administer networking in a VMware environment for many different configurations. The
examples in this section describe some of the VMware networking possibilities.
This section is not a substitute for the VMware documentation. Review the VMware networking best
practices before deploying any applications on an ESXi host.
The following are the suggested best practices for configuring a network that supports deployed
applications on VMware Hosts:
• Separate the network services to achieve greater security and performance by creating a
vSphere standard or distributed switch with dedicated NICs for each service. If you cannot use
separate switches, use port groups with different VLAN IDs.
• Configure the vMotion connection on a separate network devoted to vMotion.
• For protection, deploy firewalls in the virtual machines that route between virtual networks that
have uplinks to physical networks and pure virtual networks without uplinks.
• Specify virtual machine NIC hardware type vmxnet3 for best performance.
• Connect all physical NICs that are connected to the same vSphere standard switch to the
same physical network.
• Connect all physical NICs that are connected to the same distributed switch to the same
physical network.
• Configure all VMkernel vNICs to be the same IP Maximum Transmission Unit (MTU).

November 2016 Deploying Avaya Aura® Session Manager 76


Comments on this document? infodev@avaya.com
VMware networking best practices

Networking Avaya applications on VMware ESXi – Example 1

This configuration describes a simple version of networking Avaya applications within the same
ESXi host. Highlights to note:
• Separation of networks: VMware Management, VMware vMotion, iSCSI (SAN traffic), and
virtual machine networks are segregated to separate physical NICs.
• Teamed network interfaces: vSwitch 3 in Example 1 displays use of a load-balanced NIC team
for the Virtual Machines Network. Load balancing provides additional bandwidth for the Virtual
Machines Network, while also providing network connectivity for the virtual machines in the
case of a single NIC failure.
• Communication Manager Duplex link: Communication Manager software duplication must be
separated from all other network traffic. Example 1 displays one method of separating
Communication Manager Duplex with a port group combined with a VLAN. The

November 2016 Deploying Avaya Aura® Session Manager 77


Comments on this document? infodev@avaya.com
Best Practices for VMware performance and features

Communication Manager software duplication link must meet specific network requirements.
For more information, see Avaya PSN003556u at PSN003556u. The following are the
minimum requirements of the Communication Manager software duplex connectivity:
- The total capacity must be 1 Gbps or greater. Reserve 50 Mbps of bandwidth for duplication
data.
- The round-trip delay must be 8 ms or less.
- The round-trip packet loss must be 0.1% or less.
- Both servers duplication ports must be on the same IP subnet.
- You must disable duplication link encryption for busy-hour call rates that result in greater
than 40% CPU occupancy. You can view the CPU occupancy using the list
measurements occupancy command and looking at the results under the Static + CPU
occupancy heading.
- The system must maintain CPU occupancy on the active server (Static + CPU) at less than
65% to provide memory refresh from the active to standby server.
• Session Manager vNIC mapping: Session Manager OVA defines four separate virtual NICs
within the VM. However, example 1 shows all interfaces networked through a single virtual
machine network, which is supported. If the Session Manager Management and Session
Manager Asset networks are separated by subnets, you can create a VLAN for the appropriate
network.
• Virtual networking: The network connectivity between virtual machines that connect to the
same vSwitch is entirely virtual. In example 2, the virtual machine network of vSwitch3 can
communicate without entering the physical network. Virtual networks benefit from faster
communication speeds and lower management overhead.

November 2016 Deploying Avaya Aura® Session Manager 78


Comments on this document? infodev@avaya.com
VMware networking best practices

Networking Avaya applications on VMware ESXi – Example 2

This configuration shows a complex situation using multiple physical network interface cards. The
key differences between example 1 and example 2 are:
• VMware Management Network redundancy: Example 2 includes a second VMkernel Port at
vSwitch2 to handle VMware Management Network traffic. In the event of a failure of vmnic0,
VMware Management Network operations can continue on this redundant management
network.
• Removal of Teaming for Virtual Machines Network: Example 2 removes the teamed physical
NICs on vSwitch3. vSwitch3 was providing more bandwidth and tolerance of a single NIC
failure instead of reallocating this NIC to other workloads.
• Communication Manager Duplex Link: vSwitch4 is dedicated to Communication Manager
Software Duplication. The physical NIC given to vSwitch4 is on a separate physical network
that follows the requirements described in PSN003556u at PSN003556u.

November 2016 Deploying Avaya Aura® Session Manager 79


Comments on this document? infodev@avaya.com
Best Practices for VMware performance and features

• Session Manager Management Network: Example 2 shows the Session Manager Management
network separated onto its own vSwitch. The vSwitch has a dedicated physical NIC that
physically segregates the Session Manager Management network from other network traffic.
References
Title Link
Product Support Notice PSN003556u https://downloads.avaya.com/css/P8/documents/
100154621
Performance Best Practices for VMware vSphere® http://www.vmware.com/pdf/
5.5 Perf_Best_Practices_vSphere5.5.pdf
Performance Best Practices for VMware vSphere® http://www.vmware.com/files/pdf/techpaper/VMware-
6.0 PerfBest-Practices-vSphere6-0.pdf
VMware vSphere 5.5 Documentation https://www.vmware.com/support/pubs/vsphere-esxi-
vcenter-server-pubs.html
VMware vSphere 6.0 Documentation https://www.vmware.com/support/pubs/vsphere-esxi-
vcenter-server-6-pubs.html
VMware Documentation Sets https://www.vmware.com/support/pubs/

Separating Session Manager management and Security Module


traffic
About this task
As a best practice, Session Manager management and Security Module related traffic should be
separate. There are many ways in which to separate Session Manager including VLANs, VMware
port groups, and VMware virtual switches connected to different physical network interface cards.
Using a VLAN to separate management and Security Module related traffic must be done from a
customer’s switch, as VLAN configuration cannot be accomplished from a virtual machine or
Hypervisor level. The result is a Session Manager virtual machine with all of its NICs connected to
the same vSwitch.
If the defaults are selected during deployment, management and Security Module traffic are placed
on the same vSwitch. As a best practice, separate Session Manager management and Security
Module traffic using the following procedure.
Procedure
1. Create a vSwitch for dedicated Session Manager Security Module traffic.
2. From the vSphere client inventory view, right-click the Session Manager virtual machine and
select Edit Settings.
3. The Hardware tab is selected by default. Select the proper Network adapter from the
hardware list on the left-side.
4. On the right side, under the Network label list, select a separate vSwitch for this NIC.
5. Click OK to complete configuration.

November 2016 Deploying Avaya Aura® Session Manager 80


Comments on this document? infodev@avaya.com
Storage

Storage
There is no stipulation on the underlying storage vendor type and storage technology used. Fibre
Channel SAN arrays, iSCSI SAN arrays, and NAS arrays are different storage technologies
supported by VMware vSphere to meet different datacenter storage needs. The storage arrays are
connected to and shared between groups of servers through storage area networks. This
arrangement allows aggregation of the storage resources and provides more flexibility in
provisioning these resources to virtual machines.

Thin vs. thick deployments


When creating a virtual disk file, VMware ESXi uses a thick type of virtual disk by default. The thick
disk pre-allocates the space specified during the creation of the disk. For example, if you create a 10
megabyte disk, all 10 megabytes are pre-allocated for that virtual disk.
In contrast, a thin virtual disk does not pre-allocate nspace. Blocks in the VMDK file are not
allocated and backed by physical storage until they are written during the normal course of
operation. A read to an unallocated block returns zeroes, but the block is not backed with physical
storage until it is written. Consider the following when implementing thin provisioning in your
VMware environment:
• Thin provisioned disks can grow to the full size specified at the time of virtual disk creation, but
do not shrink. Once the blocks have been allocated, they cannot be un-allocated.
• By implementing thin provisioned disks, you are able to over-allocate storage. If storage is
over-allocated, thin virtual disks can grow to fill an entire datastore if left unchecked.
• If a guest operating system needs to make use of a virtual disk, the guest operating system
must first partition and format the disk to a file system it can recognize. Depending on the type
of format selected within the guest operating system, the format may cause the thin
provisioned disk to grow to full size. For example, if you present a thin provisioned disk to a
Microsoft Windows operating system and format the disk, unless you explicitly select the Quick
Format option, the Microsoft Windows format tool writes information to all sectors on the disk,
which in turn inflates the thin provisioned disk to full size.
Thin provisioned disks can over-allocate storage. If the storage is over-allocated, thin virtual disks
can grow to fill an entire datastore if left unchecked. You can use thin provisioned disks, but you
must use strict control and monitoring to maintain adequate performance and ensure that storage is
not completely consumed. If operational procedures are in place to mitigate the risk of performance
and storage depletion, then thin disks are a viable option.

November 2016 Deploying Avaya Aura® Session Manager 81


Comments on this document? infodev@avaya.com
Best Practices for VMware performance and features

Best Practices for VMware features

VMware High Availability


VMware High Availability (HA) provides automatic detection of hardware failures, server failures,
and operating system failures. In the event of a physical server failure, VMware HA automatically
restarts the affected virtual machine on other production servers that have spare capacity. In the
event of an operating system failure, VMware HA restarts the affected virtual machine on the same
server.
VMware HA ensures that capacity is available to restart all virtual machines that are affected by a
service failure. HA continuously monitors capacity utilization and reserves spare capacity to restart
virtual machines.
VMware HA helps users identify abnormal configuration settings detected within HA clusters. The
VMware vSphere client interface reports relevant operating status and potential error conditions
along with suggested remediation steps.
For more information, see the VMware website at http://www.vmware.com/files/pdf/VMware-High-
Availability-DS-EN.pdf.
Note:
• All virtual machines and their configuration files must be on shared storage, e.g. Fibre
Channel SAN, iSCSI SAN, or SAN iSCI NAS.
• The console network must have redundant network paths to have reliable failure detection
for HA clusters. VMware HA monitors the heartbeat between hosts on the console network
for failure detection.
• VMware HA uses virtual machine priority to decide order of restart.
• VMware HA only works across a LAN. VMware HA does not work across a WAN.

VMware vMotion
VMware uses the vMotion technology to migrate a running virtual machine from one physical server
to another physical server without incurring downtime. The migration process, also known as a hot
migration, migrates running virtual machines with zero downtime, continuous service availability,
and complete transaction integrity.
With vMotion, you can:
• Schedule migration to occur at predetermined times and without the presence of an
administrator.
• Perform hardware maintenance without scheduled downtime.
• Migrate virtual machines away from failing or under-performing servers.

November 2016 Deploying Avaya Aura® Session Manager 82


Comments on this document? infodev@avaya.com
Best Practices for VMware features

Before using vMotion, you must:


• Ensure that each host that migrates virtual machines to or from the host uses a licensed
vMotion application and the vMotion is enabled.
• Ensure that you have identical vSwitches. You must enable vMotion on these vSwitches.
• Ensure the Port Groups are identical for vMotion.
• Use a dedicated NIC to ensure the best performance.

VMware Snapshots
A snapshot preserves the state and data of a virtual machine at a specific point in time. You can
create a snapshot before upgrading or installing a patch.
The best time to take a snapshot is when no applications in the virtual machine are communicating
with other computers. The potential for problems is greatest if the virtual machine is communicating
with another computer. For example, if you take a snapshot while the virtual machine is
downloading a file from a server on the network, the virtual machine continues downloading the file
and communicating its progress to the server. If you revert to the snapshot, communications
between the virtual machine and the server are confused and the file transfer fails.

Caution:
Snapshot operations can adversely affect service. Before performing a snapshot
operation, you must stop the application that is running on the virtual machine or place
the application out-of-service. When the snapshot operation is complete, start or bring
the application back into service.
Snapshots can:
• Consume large amounts of data resources.
• Increase CPU loads on the host.
• Affect performance.
• Affect service.
To prevent adverse behaviors, consider the following recommendations when using the Snapshot
feature:
• Do not rely on VMware snapshots as a robust backup and recovery method. Snapshots are not
backups. The snapshot file is only a change log of the original virtual disk.
• Do not run a virtual machine from a snapshot. Do not use a single snapshot for more than 24 to
72 hours.
• Take the snapshot, make the changes to the virtual machine, and delete or commit the
snapshot after you verify the virtual machine is working properly. These actions prevent
snapshots from growing so large as to cause issues when deleting or committing the
snapshots to the original virtual machine disks.
• When taking a snapshot, do not save the memory of the virtual machine. The time that the host
takes to write the memory to the disk is relative to the amount of memory that the virtual

November 2016 Deploying Avaya Aura® Session Manager 83


Comments on this document? infodev@avaya.com
Best Practices for VMware performance and features

machine is configured to use. Saving the memory can add several minutes to the time taken to
complete the operation. If the snapshot is active, saving memory can make calls appear to be
active or in progress and can cause confusion to the user. To create a clean snapshot image
from which to boot, do the following when you create a snapshot:
- In the Take Virtual Machine Snapshot window, clear the Snapshot the virtual machine’s
memory check box.
- Select the Quiesce guest file system (Needs VMware Tools installed) check box to
ensure that all write instructions to the disks are complete. You have a better chance of
creating a clean snapshot image from which to boot.
• If you are going to use snapshots for a long time, you must consolidate the snapshot files
regularly to improve performance and reduce disk usage. Before merging the snapshot delta
disks back into the base disk of the virtual machine, you must first delete stored snapshots.
Note:
If a consolidation failure occurs, end-users can use the actual Consolidate option without
opening a service request with VMware. If a commit or delete operation does not merge
the snapshot deltas into the base disk of the virtual machine, the system displays a
warning on the user interface.
Related resources
Title Link
Best practices for virtual machine snapshots in the Best Practices for virtual machine snapshots in the
VMware environment VMware environment
Understanding virtual machine snapshots in VMware Understanding virtual machine snapshots in VMware
ESXi and ESX ESXi and ESX
Working with snapshots Working with snapshots
Configuring VMware vCenter Server to send alarms Send alarms when virtual machines are running from
when virtual machines are running from snapshots snapshots
Consolidating snapshots in vSphere 5.x Consolidating snapshots in vSphere 5.x

November 2016 Deploying Avaya Aura® Session Manager 84


Comments on this document? infodev@avaya.com
Appendix B: Product notifications

Avaya issues a product change notice (PCN) for a software update. A PCN accompanies a service
pack or patch that must be applied universally.
Avaya issues a product support notice (PSN) when there is a change in a product. A PSN provides
information such as a workaround for a known problem and steps to recover software.
Both of these types of notices alert you to important issues that directly impact Avaya products.

Viewing PCNs and PSNs


Procedure
1. Go to the Avaya Support website at http://support.avaya.com.
2. Enter your login credentials, if applicable.
3. On the top of the page, click DOCUMENTS.
4. In the Enter your Product Here field, enter the name of the product, then select the product
from the drop-down menu.
5. In the Choose Release field, select the specific release from the drop-down menu.
6. In the list of filters, select the Product Correction Notices and/or Product Support Notices
check box.
Note:
You can select multiple filters to search for different types of documents at one time.
7. Click Enter.

November 2016 Deploying Avaya Aura® Session Manager 85


Comments on this document? infodev@avaya.com
Product notifications

Registering for product notifications


Note:
This procedure applies only to registered Avaya customers and business partners with an SSO
login.
Procedure
1. Go to the Avaya Support website at http://support.avaya.com.
2. Log in using your SSO credentials.
3. Click on the MY PROFILE link.
4. Click the highlighted HI, <username> tab.
5. Select E Notifications from the menu.
6. In the Product Notifications section:
a. Click Add More Products.
b. Select the appropriate product.
7. In the Product box that appears on your screen:
a. Select the appropriate release or releases for which you want to receive notifications.
b. Select which types of notifications you want to receive. For example, Product Support
Notices and Product Correction Notices (PCN).
c. Click Submit.
8. If you want notifications for other products, select another product from the list and repeat
the above step.
9. Log out.

November 2016 Deploying Avaya Aura® Session Manager 86


Comments on this document? infodev@avaya.com
Glossary

AFS Authentication File System. AFS is an Avaya Web system that allows you
to create Authentication Files for secure Avaya Global Services logins for
supported non-Communication Manager Systems.

Appliance Appliance Virtualization Platform is the customized OEM version of


Virtualization VMware® ESXi 5.5. With Appliance Virtualization Platform, customers can
Platform run any combination of supported applications on Avaya-supplied servers.
Appliance Virtualization Platform provides greater flexibility in scaling
customer solutions to individual requirements.
Appliance Virtualization Platform is available only in an Avaya-appliance
offer. Avaya-appliance offer does not support VMware® tools, such as
vCenter and vSphere Client. You can configure and manage Appliance
Virtualization Platform by using Solution Deployment Manager that is part of
System Manager, or by installing the Solution Deployment Manager client.

Application A software solution development by Avaya that includes a guest operating


system.

Avaya Appliance A physical server sold by Avaya running a VMware hypervisor that has
several virtual machines, each with its virtualized applications. The servers
can be staged with the operating system and application software already
installed. Some of the servers are sold as just the server with DVD or
software downloads.

Blade A blade server is a stripped-down server computer with a modular design


optimized to minimize the use of physical space and energy. Although
many components are removed from blade servers to save space,
minimize power consumption and other considerations, the blade still has
all of the functional components to be considered a computer.

ESXi A virtualization layer that runs directly on the server hardware. Also known
as a bare-metal hypervisor. Provides processor, memory, storage, and
networking resources on multiple virtual machines.

Hypervisor A hypervisor is also known as a Virtual Machine Manager (VMM). A


hypervisor is a hardware virtualization technique which runs multiple
operating systems on the same shared physical server.

November 2016 Deploying Avaya Aura® Session Manager 87


Comments on this document? infodev@avaya.com
Glossary

MAC Media Access Control address. A unique identifier assigned to network


interfaces for communication on the physical network segment.

OVA Open Virtualization Appliance. An OVA contains the virtual machine


description, disk images, and a manifest zipped into a single file. The OVA
follows the Distributed Management Task Force (DMTF) specification.

PLDS Product Licensing and Download System. The Avaya PLDS provides
product licensing and electronic software download distribution.

Reservation A reservation specifies the guaranteed minimum required amounts of CPU


or memory for a virtual machine.

RFA Remote Feature Activation. RFA is an Avaya Web system that you use to
create Avaya License Files. These files are used to activate software
including features, capacities, releases, and offer categories. RFA also
creates Authentication Files for secure Avaya Global Services logins for
Communication Manager Systems.

SAN Storage Area Network. A SAN is a dedicated network that provides access
to consolidated data storage. SANs are primarily used to make storage
devices, such as disk arrays, accessible to servers so that the devices
appear as locally attached devices to the operating system.

Snapshot The state of a virtual appliance configuration at a particular point in time.


Creating a snapshot can affect service. Some Avaya virtual appliances
have limitations and others have specific instructions for creating
snapshots.

Storage vMotion A VMware feature that migrates virtual machine disk files from one data
storage location to another with limited impact to end users.

vCenter Server An administrative interface from VMware for the entire virtual infrastructure
or data center, including VMs, ESXi hosts, deployment profiles, distributed
virtual networking, and hardware monitoring.

virtual appliance A virtual appliance is a single software application bundled with an


operating system.

VM Virtual Machine. Replica of a physical server from an operational


perspective. A VM is a software implementation of a machine (for example,
a computer) that executes programs similar to a physical machine.

vMotion A VMware feature that migrates a running virtual machine from one
physical server to another with minimal downtime or impact to end users.
vMotion cannot be used to move virtual machines from one data center to
another.

VMware HA VMware High Availability. A VMware feature for supporting virtual


application failover by migrating the application from one ESXi host to

November 2016 Deploying Avaya Aura® Session Manager 88


Comments on this document? infodev@avaya.com
vSphere Client

another. Since the entire host fails over, several applications or virtual
machines can be involved. The failover is a reboot recovery level which can
take several minutes.

vSphere Client The vSphere Client is a downloadable interface for administering vCenter
Server and ESXi.

November 2016 Deploying Avaya Aura® Session Manager 89


Comments on this document? infodev@avaya.com
Index
A deployment procedures ................................................ 29
migration procedures ....................................................44
accepting new service ......................................................... 57 planning procedures ..................................................... 24
accessing the Backup and Restore service .........................62 post-installation procedures ..........................................42
Active Call Count client Solution Deployment Manager ................................... 13
verifying ........................................................................ 64 clones
adding SIP Entity deployment ................................................................... 23
Session Manager ..........................................................55 components
AFS virtualized ..................................................................... 18
starting ..........................................................................56 VMware ........................................................................ 18
appliance virtualization platform .......................................... 49 configuration data worksheet
Appliance Virtualization Platform ................................... 10, 11 customer .......................................................................26
conditions ..................................................................... 27 configuration verification ...................................................... 30
install ............................................................................ 50 configure Appliance Virtualization Platform USB drive ........ 49
networking .................................................................... 52 configuring
Appliance Virtualization Platform overview ..........................11 Session Manager ..........................................................37
Appliance Virtualization Platform USB drive virtual machine automatic restart ..................................34
configure .......................................................................49 connections
authentication file verifying ........................................................................ 42
installing ........................................................................57 creating a snapshot ............................................................. 58
Authentication File creating Authentication File ................................................. 56
creating .........................................................................56 customer configuration data ................................................ 26
automatic restart customer VMware ................................................................10
virtual machine ............................................................. 34
Avaya Aura application
deploy ........................................................................... 16
D
upgrade ........................................................................ 16 data replication .................................................................... 64
Avaya Aura Virtualized Appliance offer ............................... 11 verifying ........................................................................ 64
Avaya Aura Virtualized Software ......................................... 20 deleting a snapshot ..............................................................59
Avaya virtualization platform ................................................11 deny new service ................................................................. 58
Avaya Virtualized offers ....................................................... 10 deploying
Avaya Virtualized Software ..................................................20 using vSphere connected directly .................................32
deploying copies .................................................................. 23
B deploying Session Manager OVA
using vCenter ............................................................... 30
Backup and Restore page ................................................... 63 deployment
backup and restore service; access .................................... 62 thick .............................................................................. 81
best practices thin ................................................................................81
performance and features ............................................ 73 deployment configuration verification .................................. 30
VMware networking ...................................................... 76 deployment guidelines ......................................................... 22
BIOS .................................................................................... 73 deployment procedures
BIOS for HP servers ............................................................ 74 checklist ........................................................................29
BIOS settings deployment process overview ............................................. 22
for Dell servers ............................................................. 74 downloading software
using PLDS ...................................................................60
C
E
capabilities
Solution Deployment Manager client ......................14, 15 Enrollment Password status ................................................ 47
change history ....................................................................... 8 Entity Link Connection Status ..............................................66
change service state
deny new service ..........................................................58
checklist

November 2016 Deploying Avaya Aura® Session Manager 90


Comments on this document? infodev@avaya.com
Index

F Virtualized Environment ................................................10


OOBM
features best practices .........................................................73 conditions ..................................................................... 27
flexible footprint Out of Band Management
reconfiguring hardware resources ................................ 36 ports ..............................................................................54
overview ...............................................................................10
G
P
guidelines
deployment ................................................................... 22 PCNs
viewing ..........................................................................85
PCN updates ....................................................................... 85
H performance best practices ................................................. 73
hardware resources planning procedures
reconfiguring for flexible footprint ................................. 36 checklist ........................................................................24
PLDS
downloading software ...................................................60
I post-installation
checklist ........................................................................42
install Appliance Virtualization Platform ...............................50
preserved
Installed Patches ................................................................. 40
data ...............................................................................47
installing
upgrade ........................................................................ 47
authentication file ..........................................................57
product notification enrollment .............................................86
license file .....................................................................27
product notifications
software patches .......................................................... 37
e-notifications ............................................................... 86
Intel Virtualization Technology .............................................73
PSNs
viewing ..........................................................................85
K PSN updates ........................................................................85

knowledge required ............................................................... 7


R
L resources
server ............................................................................20
legal notices ............................................................................. restart
virtual machine ............................................................. 61
M restart virtual machine from SDM ........................................ 61
restoring a snapshot ............................................................ 60
migrating Session Manager ................................................. 44 restoring dmutility backup file .............................................. 49
migration procedures
checklist ........................................................................44
multiple vSwitches ............................................................... 80
S
SAL Gateway .......................................................................27
N SDM client ........................................................................... 14
SDM client capabilities .........................................................15
networking Security Module sanity failure
Appliance Virtualization Platform ..................................52 troubleshooting ............................................................. 65
new service server hardware and resources ........................................... 20
changing state to accept ...............................................57 Session Manager
notices, legal ............................................................................ configuring .................................................................... 37
notifications ..........................................................................85 does not power up ........................................................ 35
NTP time source .................................................................. 74 Out of Band Management ports ................................... 54
Session Manager OVA
deployment using vCenter ............................................30
O shutdown or reboot the server
offer using the CLI ................................................................ 48
Avaya appliance ........................................................... 10 skills required .........................................................................7

November 2016 Deploying Avaya Aura® Session Manager 91


Comments on this document? infodev@avaya.com
Index

snapshot Virtualized components ....................................................... 18


creating .........................................................................58 Virtualized Environment .................................................10, 11
deleting ......................................................................... 59 virtual machine
restoring ........................................................................60 automatic restart configuration ..................................... 34
snapshots ............................................................................ 83 restart ........................................................................... 61
Solution Deployment Manager ...................................... 13, 16 vMotion ................................................................................ 82
deploying using .............................................................33 VMware components ........................................................... 18
restart virtual machine .................................................. 61 VMware High Availability ..................................................... 82
Solution Deployment Manager client ............................. 13, 14 VMware networking
Solution Deployment Manager client capabilities .......... 14, 15 best practices ............................................................... 76
status VMware software
Enrollment Password ....................................................47 supported ......................................................................19
storage .................................................................................81 VMware tools
support .................................................................................72 upgrading ......................................................................43
supported versions VMware Tools ......................................................................76
VMware ........................................................................ 19 vSphere
System Manager Solution Deployment Manager and client deployment ................................................................... 32
capabilities ........................................................................... 14 VT support ........................................................................... 73

T
thick deployment ..................................................................81
thin deployment ................................................................... 81
timekeeping ......................................................................... 74
tools required ......................................................................... 7
troubleshooting .................................................................... 64
power on problem .........................................................35
Security Module sanity failure Alarms .......................... 65

U
upgrade
elements ....................................................................... 40
upgrade Avaya Aura application ..........................................16
upgrading
VMware tools ................................................................43
upgrading Session Manager
using data migration utility ............................................ 45
using
CLI to shut down or reboot the server .......................... 48
using, shutdown using GUI
GUI to shut down or reboot the server ......................... 48
reboot using GUI .......................................................... 48

V
verifying
Active Call Count .......................................................... 64
connections .................................................................. 42
data replication ............................................................. 64
videos .................................................................................. 71
viewing
Entity Link Connection Status .......................................66
PCNs ............................................................................ 85
PSNs ............................................................................ 85
Virtualized Appliance ........................................................... 11

November 2016 Deploying Avaya Aura® Session Manager 92


Comments on this document? infodev@avaya.com

You might also like