Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Download as pdf or txt
Download as pdf or txt
You are on page 1of 101

Deploying Avaya Breeze

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

Chapter 1: Introduction............................................................................................................ 8
Purpose..................................................................................................................................8
Chapter 2: Architecture overview............................................................................................9

Avaya Breeze overview......................................................................................................... 9
Snap-in types..................................................................................................................10
System interactions......................................................................................................... 13
Topology.............................................................................................................................. 13
Chapter 3: Deployment process............................................................................................15

Avaya Breeze deployment checklist......................................................................................15

Avaya Aura Media Server deployment checklist..................................................................... 17

Avaya Breeze SIP high availability deployment checklist........................................................ 19
Chapter 4: Planning and preconfiguration........................................................................... 20
Key customer configuration information...................................................................................20

Out of Band Management in Avaya Breeze ........................................................................... 24
Network latency.................................................................................................................... 24
Latest software updates and patch information........................................................................ 24
Chapter 5: Avaya Breeze OVA Deployment...................................................................... 25
OVA deployment requirements...............................................................................................25
Downloading software from PLDS.......................................................................................... 26
Verifying Enrollment Password status..................................................................................... 26

Deploying Avaya Breeze OVA with VMware vSphere Web Client............................................27

Deploying Avaya Breeze OVA with VMware vSphere Client connected to vCenter................... 31

Deploying Avaya Breeze OVA with VMware vSphere Client connected to ESXi host................ 36

Deploying Avaya Breeze OVA with Solution Deployment Manager..........................................43

Configuring Avaya Breeze after changing the IP address or FQDN using AvayaNetSetup or
CEnetSetup.......................................................................................................................... 45
Configure virtual machine automatic startup settings................................................................ 46
Configuring virtual machine automatic startup settings using vSphere desktop client............ 46
Configuring virtual machine automatic startup settings using vSphere Web Client................ 47
Changing the customer password on first login........................................................................ 48

Patching Avaya Breeze ........................................................................................................48
Creating multiple privileged user accounts ..............................................................................49
Enhanced Access Security Gateway.......................................................................................50
Enabling and disabling EASG...........................................................................................50
Viewing the EASG certificate information...........................................................................50
EASG site certificate........................................................................................................51
Chapter 6: Avaya Breeze System Manager Administration.............................................52

Installing the Avaya Breeze license file..................................................................................52

Administering an Avaya Breeze SIP Entity............................................................................ 52

May 2017 Deploying Avaya Breeze 5


Comments on this document? infodev@avaya.com
Contents


Administering the Avaya Breeze Entity Link...........................................................................53
Enabling implicit users applications for SIP users.....................................................................54

Administering an Avaya Breeze instance...............................................................................54

Verifying the Avaya Breeze Entity Link connection................................................................. 55
Verifying replication status..................................................................................................... 56
Verifying the management link................................................................................................56
Creating a new cluster........................................................................................................... 57
Accepting new service........................................................................................................... 59
Cluster Database backup and restore..................................................................................... 59
Backing up a cluster........................................................................................................ 59
Restoring a cluster.......................................................................................................... 60
Cancelling a pending job..................................................................................................61
Purging a backup............................................................................................................ 61
Reliable Eventing administration.............................................................................................61
Creating a Reliable Eventing group...................................................................................62
Editing a Reliable Eventing group..................................................................................... 63
Deleting a Reliable Eventing group................................................................................... 63
Viewing the status of Reliable Eventing destinations.......................................................... 63
Deleting a Reliable Eventing destination............................................................................64
Executing maintenance test for a broker............................................................................64
Chapter 7: Avaya Aura Media Server Deployment.............................................................. 65

Avaya Aura Media Server OVA deployment........................................................................... 65

Administering Avaya Aura Media Server for REST................................................................. 65

Assigning Avaya Aura Media Server for use with Avaya Breeze ............................................ 66

Licensing the Avaya Aura Media Server................................................................................ 66

Installing the Avaya Aura Media Server license file................................................................. 67
Adding the System Manager IP address..................................................................................67

SIPS and SRTP on Avaya Aura Media Server........................................................................68

Avaya Aura Media Server host name resolution..................................................................... 69

Configuring Avaya Aura Media Server name resolution (alternative 1)................................70
Configuring connection security options (alternative 2)....................................................... 70

Avaya Aura Media Server trust configuration..........................................................................71

Exporting an Avaya Aura Media Server certificate.................................................................. 71
Enabling and configuring digit relay settings............................................................................ 72
Chapter 8: Certificate administration....................................................................................74
Trust and Identify Certificate administration............................................................................. 74
Viewing Identity Certificate details...........................................................................................75

Adding a Trust Certificate to all Avaya Breeze servers in a cluster...........................................75
Adding trusted certificates...................................................................................................... 76
Replacing an identity certificate.............................................................................................. 77
Chapter 9: High Availability Administration.........................................................................79

Avaya Breeze high availability administration.........................................................................79
SIP high availability......................................................................................................... 79

May 2017 Deploying Avaya Breeze 6


Comments on this document? infodev@avaya.com
Contents

HTTP high availability............................................................................................................ 84



HTTP load balancing in an Avaya Breeze cluster............................................................. 84

Enabling HTTP load balancing in an Avaya Breeze cluster............................................... 85
Chapter 10: Communication Manager Administration........................................................87
Communication Manager call routing...................................................................................... 87
Routing inbound ISDN calls....................................................................................................87
Routing outbound ISDN calls..................................................................................................88
Chapter 11: Resources...........................................................................................................89
Documentation......................................................................................................................89
Finding documents on the Avaya Support website............................................................. 91
Training................................................................................................................................ 92

Avaya Breeze videos...........................................................................................................92
Support................................................................................................................................ 93

Appendix A: Avaya Aura Media Server configuration for Avaya Engagement
Assistant Snap-in....................................................................................................................94

Administering an Avaya Aura Media Server SIP Entity............................................................ 94

Administering the Avaya Aura Media Server Entity Link.......................................................... 95

Creating the Avaya Aura Media Server Routing Pattern.......................................................... 95

Verifying the Avaya Aura Media Server Entity Link connection.................................................96

Configuring Avaya Aura Media Server Host Name Resolution................................................. 97

Administering Avaya Aura Media Server URI......................................................................... 98

May 2017 Deploying Avaya Breeze 7


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

Purpose
This document contains Avaya Breeze installation, configuration, initial administration, and basic
maintenance checklist and procedures.
This document is intended for people who install and configure a verified Avaya Breeze reference
configuration at a customer site.

May 2017 Deploying Avaya Breeze 8


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

Avaya Breeze overview


Avaya Breeze provides a virtualized and secure application platform where Workflow developers
and Java programmers can develop and dynamically deploy advanced collaboration capabilities that
extend the power of Avaya Aura. Customers, business partners, and Avaya developers can use
the platform as the deployment vehicle for their snap-ins.
Avaya Breeze acts as the platform for many Avaya products such as the Avaya Oceana Solution,
Presence Services, Engagement Designer, and Context Store.
Avaya Breeze provides the following benefits:
Customers, partners, and Avaya organizations can rapidly develop snap-ins and applications
that are deployed on Avaya Breeze.
Developers can focus on building the collaboration snap-ins they need, without the need to
develop a robust platform on which snap-ins are deployed and invoked.
A robust Software Development Kit (SDK) with an easy-to-use API. Developers need not
understand the details of call processing to develop new capabilities.
The ability to perform operations such as:
- Intercepting calls in to and out of the enterprise.
- Redirecting calls to an alternate destination.
- Blocking calls and optionally playing an announcement to the caller.
- Changing the presented caller ID of the calling or called party.
The ability to place an outbound call for the purpose of playing announcements and collecting
digits.
The ability to invoke web services for added functionality.
The ability to expose webpages and web services for invocation by remote browsers and
applications.
A Collaboration Bus that allows snap-ins to leverage each others capabilities through point-to-
point and publish/subscribe messaging patterns.
A Common Data Manager framework that snap-ins use to access common information stored
on System Manager.
Connector snap-ins that provide access to email and Scopia (conferencing) host applications.

May 2017 Deploying Avaya Breeze 9


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

Multiple SMS snap-ins are available from Snapp Store.


Zang Call Connector to interact with Zang.
Zang SMS Connector for Avaya Breeze snap-ins to interact with Zang to send and receive
messages.
The ability to add or replace Trust and Identity Certificates for increased security.
Tools that log and monitor operations and provide troubleshooting support.
High availability. For more information on high availability, see the High Availability section in
Avaya Breeze Overview and Specification.
Third party ability to create custom Connectors that provide access to their (external)
application or service.
Avaya Breeze is a powerful snap-in delivery platform that provides Unified Communications and
Contact Center customers and partners the ability to quickly deliver capabilities using the skill sets
of todays enterprise and cloud application developers.

Snap-in types
Snap-ins that deploy on Avaya Breeze can be categorized as follows. A given snap-in can fall into
more than one category. The categories are not mutually exclusive.
Avaya and third-party snap-ins are available in the Avaya Snapp Store at http://
snappstore.avaya.com/.
Call Intercept snap-ins Called Party and Calling Party snap-ins
All incoming and outgoing calls between the PSTN and the enterprise can take full advantage of
Call Intercept snap-ins that run on Avaya Breeze. This is true regardless of the type of endpoint (H.
323 or SIP) and the type of trunk (ISDN or SIP). Station-to-station calls within the enterprise cannot
invoke Call Intercept snap-ins even if the endpoints are SIP endpoints. There are two types of Call
Intercept snap-ins:
Based on who is being called, a Called Party snap-in looks at the configuration data for that
called party to determine how to handle the call.
Based on who is placing a call, a Calling Party snap-in looks at the configuration data for that
calling party to determine how to handle the call.
The Hello World snap-in, delivered with the standard product software image, is an example of a
Call Intercept snap-in.
Outbound Calling snap-ins
Outbound Calling snap-ins can initiate calls to phone numbers for the purpose of playing pre-
recorded announcements and optionally detecting button presses from the called phone. The Multi-
channel Broadcast snap-in is an example of a one-party Outbound Calling snap-in.
Outbound Calling snap-ins can also initiate two-party calls to join two participants together in a call.
The calling party is called first, and after answer a call is initiated to the called party. After the called
party answers both the participants talk to each other. The Click to Call application, delivered with
the standard product software image, is an example of a two-party Outbound Calling snap-in.

May 2017 Deploying Avaya Breeze 10


Comments on this document? infodev@avaya.com
Avaya Breeze overview

Callable Services:
Callable Services are the services whose features are invoked to originate or receive a call. For
information about administering Callable Service, see Administering Avaya Breeze.
HTTP-invoked snap-ins
HTTP-invoked snap-ins perform some action on receipt of an incoming HTTP request. For example,
when it receives an incoming HTTP request, the Dynamic Team Formation snap-in creates a Scopia
video conference, then sends the conference URL to specified email and / or SMS recipients.
The Multi-channel Broadcast snap-in, delivered with the standard product software image, is
another example of an HTTP-invoked service.
Collaboration Bus-invoked snap-ins
The Collaboration Bus is a core module within Avaya Breeze that enables snap-ins to send
messages to other snap-ins for the purpose of leveraging the functionality of the other snap-ins.
Collaboration Bus-invoked snap-ins perform some action when they receive a message from
another snap-in on the Collaboration Bus.
The email connector snap-in is an example of a Collaboration Bus-invoked snap-in.

Connector Snap-ins
Avaya Breeze includes several connector Snap-ins that provide access to external host
applications. These built-in connector snap-ins communicate over the Collaboration Bus with snap-
ins that request them. Connector snap-ins are available for:
Email
Zang SMS (Text Messaging)
Other vendors, such as WebText provide similar connector snap-ins for SMS services.
Scopia (conferencing)
Zang Call Connector
Email
The email connector allows snap-ins to send emails. The email connector is an email client that
sends SMTP requests to one or more email hosts, which in turn send the email. The email
connector is a send-only email client. Snap-ins communicate with the email connector by using the
email API of the Collaboration Bus framework.
The email API can handle a total of 10,000 recipients per request, which can be any combination of
primary, carbon-copy, or blind-copy recipients.
The email connector supports the following multipart body content types: HTML, Plain Text, XML,
Rich Text Format, and Vcard.
Zang SMS Snap-in
The Zang connector snap-in provides the capability to send, but not receive, SMS messages. The
Zang connector snap-in uses the HTTP-based SMS gateway. The Zang SMS provides the following
parameters:

May 2017 Deploying Avaya Breeze 11


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

Note:
Snap-ins available from third party vendors may provide additional capabilities not currently
available in the Zang SMS snap-in. For more information, see The Avaya Snapp Store.
Destination phone number
Source phone number (Optional)
User credentials (Optional)
Message body (supports extended character sets)
Scopia (conferencing)
The Scopia connector uses the Conferencing API to access the Scopia Management Server for
audio and video conferencing. The snap-in can schedule a conference, cancel a conference, or
retrieve a list of all the active and scheduled conferences. Video conferences include video
participants, audio-only participants, or a mixture of both.
To support both video and audio-only participants, conference requests from the snap-in include:
A participant URL
A host URL
Dial-in phone number
Meeting ID
Host code
Participant code
Eventing Framework
The Eventing Framework connector allows remote systems to publish events into the Avaya
Breeze Eventing Framework using REST web services. The publisher simply specifies the event
family, type, metadata, and the message body. The Eventing Framework then delivers the event to
all the subscribers. The Eventing Framework provides the easiest way to publish events to
Engagement Designer workflows.
Remote applications can also subscribe to events by using the Eventing Framework. These
applications must be able to receive the incoming HTTP POST messages when the events are
generated.
Zang Call Connector
Zang Call Connector is an Avaya Breeze snap-in used to interact with Zang. Zang Call Connector
takes instructions from Avaya Breeze CMA API through Avaya Breeze Normalized Interaction
Protocol to sends http(s) messages to Zang for handling voice call operations and other media
operations.

May 2017 Deploying Avaya Breeze 12


Comments on this document? infodev@avaya.com
Topology

System interactions
System Manager manages the administration, management, and troubleshooting aspects of Avaya
Breeze.
Avaya Breeze 3.3 interoperates with:
Avaya Aura Session Manager Releases 6.3.8, 6.3.9, 7.0, 7.0.1, and 7.1.
Avaya Aura System Manager Release 7.1.
Avaya Aura Communication Manager Releases 5.2.1, 6.3.2, 6.3.6, and 7.0, 7.0.1, and 7.1.
Note:
Communication Manager Release 5.2.1 to 6.3.1 supports sequencing of a snap-in for an
originating call or a terminating call, but not both. Communication Manager Release 6.3.2
and later supports sequencing of a snap-in for both originating and terminating call.
Avaya Aura Application Enablement Services Releases 6.3.3, 7.0, 7.0.1, and 7.1.
Avaya Aura Media Server Release 7.8.
Avaya Aura Messaging Releases 6.3.3 and 7.0.
Avaya Scopia Release 8.3 to 8.5.
Engagement Call Control solution Releases 3.2.2.
Traditional H.248 gateways provide access to the PSTN and provide support for H.323 and legacy
endpoints. Connection to SIP service provider trunks is provided through Session Border Controller
to Session Manager.
Snap-ins
Avaya Breeze snap-ins interoperate with other Avaya products. For example, WebRTC Snap-in
interoperates with Avaya Session Border Controller for Enterprise Releases 6.3 to 7.1.

Topology
The following diagram provides a high-level illustration of the components of an Avaya Breeze
solution.

May 2017 Deploying Avaya Breeze 13


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

May 2017 Deploying Avaya Breeze 14


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

Avaya Breeze deployment checklist


The following table lists the procedures required to deploy Avaya Breeze.
Note:
You must deploy Avaya Aura Media Server before Avaya Breeze.
# Action Reference/Notes

1 Record information that you will require Key customer configuration


for the deployment. information on page 20
2 Install or upgrade to the latest System Verify that System Manager is running
Manager. on the correct release. For more details
on the System Manager version, see
the Product Change Notice (PCN) and
the Release Notes for Avaya Breeze.
3 Download software from PLDS. Downloading software from PLDS on
page 26
Download the Avaya Breeze License
file from PLDS.
Download the patch file (if required)
from PLDS.
4 Verify that the Enrollment Password is Verifying Enrollment Password
not expired. status on page 26
5 Deploy the Avaya Breeze OVA. Choose the procedure that corresponds
to your OVA deployment method.
Deploying Avaya Breeze OVA with
VMware vSphere Web Client on
page 27
Deploying Avaya Breeze OVA with
VMware vSphere Client connected to
vCenter on page 31
Deploying Avaya Breeze OVA with
VMware vSphere Client connected to
ESXi host on page 36
Table continues

May 2017 Deploying Avaya Breeze 15


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

# Action Reference/Notes

Deploying Avaya Breeze OVA with


Solution Deployment Manager on
page 43

Note:
Avoid installing multiple OVAs on
the same LAN simultaneously
unless you are using VCenter for
the installation. If you install an
OVA with vSphere, it boots with a
static, fixed IP address associated
with eth0. If you load a second
OVA on the same network before
running CEnetSetup on the first,
an address conflict occurs. One or
both VMs will not be configurable.

Note:
The Avaya Breeze node where
Engagement Designer is installed
and System Manager must be in
the same domain.
6 Change the customer password on first Changing the customer password on
login. first login on page 48
7 Configure virtual machine automatic Configure virtual machine automatic
startup settings. startup settings on page 46
8 Install the patch file. Patching Avaya Breeze on page 48
9 Create multiple privileged user Creating multiple privileged user
accounts. (optional) accounts on page 49
10 Install the Avaya Breeze license file. Installing the Avaya Breeze license
file on page 52
11 Administer the SIP Entity. Administering an Avaya Breeze SIP
Entity on page 52
12 Administer the SIP Entity Link. Administering the Avaya Breeze Entity
Link on page 53
13 Enable implicit users applications for Enabling implicit users applications for
SIP users. SIP users on page 54
14 Administer the Avaya Breeze Administering an Avaya Breeze
Instance. instance on page 54
15 Verify the Entity Link connection. Verifying the Avaya Breeze Entity Link
connection on page 55
16 Verify the replication status. Verifying replication status on
page 56
Table continues

May 2017 Deploying Avaya Breeze 16


Comments on this document? infodev@avaya.com
Avaya Aura Media Server deployment checklist

# Action Reference/Notes

17 Verify management link. Verifying the management link on


page 56
18 Assign the server to an Avaya Breeze Creating a new cluster on page 57
cluster. If one does not already exists
for this server, create the cluster.
19 Add a trust certificate to all servers. Adding a Trust Certificate to all Avaya
Breeze servers in a cluster on
page 75
20 Add individual trust certificates. Adding trusted certificates on page 76

Note:
Step 19 adds the trust certificates
to all Avaya Breeze server in the
cluster. This step is required only if
you are provisioning a new server
to be added to the cluster or have
redeployed an existing server
using an OVA.
21 Replace an identity certificate. Replacing an identity certificate on
page 77
22 Change the state of the server to Accepting new service on page 59
accept new service.
23 Configure the Alarming setup. See SNMP Support for Avaya Breeze
Configure System Manager to receive in Maintaining and Troubleshooting
the Avaya Breeze alarms. Avaya Breeze.
24 For Communication Manager route Routing inbound ISDN calls on
inbound ISDN calls. page 87
25 For Communication Manager route Routing outbound ISDN calls on
outbound ISDN calls. page 88

Avaya Aura Media Server deployment checklist


The following table lists the procedures required to deploy Avaya Aura Media Server.
# Action Reference/Notes

1 Download software from PLDS. Downloading software from PLDS on


page 26
Download the Avaya Aura Media
Server License file from PLDS.
Table continues

May 2017 Deploying Avaya Breeze 17


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

# Action Reference/Notes

2 Deploy the Avaya Aura Media Server See Deploying and Updating Avaya
OVA. Aura Media Server Appliance.
3 Configure virtual machine automatic Configuring virtual machine automatic
startup settings. startup settings using vSphere desktop
client on page 46
4 License the Avaya Aura Media Licensing the Avaya Aura Media
Server. Server on page 66
Installing the Avaya Aura Media Server
license file on page 67
5 Enroll Avaya Aura Media Server on Refer to the System Manager
System Manager. enrollment section in Implementing and
Administering Avaya Aura Media
Before enrolling, ensure to follow the
Server.
pre-enrollment checklist included in
Implementing and Administering Avaya Note:
Aura Media Server.
Note the following during enrolling:
The element and cluster names
must not contain the following
special characters: "[^<>\\^%
$@*#]*").
The Avaya Aura Media Server
FQDN and the System Manager
FQDN must be registered in
DNS or must have an entry
in /etc/hosts.
System Manager and Avaya
Aura Media Server need to be
on the same domain.
6 Administer Avaya Aura Media Server Administering Avaya Aura Media Server
for REST. for REST on page 65
7 Assign Avaya Aura Media Server for Assigning Avaya Aura Media Server for
use with Avaya Breeze. use with Avaya Breeze on page 66
8 Create a new certificate on Avaya See Security Configuration in the
Aura Media Server, or import an Configuration chapter of Implementing
existing certificate to establish a trust and Administering Avaya Aura Media
relationship with Avaya Breeze. Server for additional information.
9 Add the System Manager IP address. Adding the System Manager IP
address on page 67
10 Configure name resolution. Avaya Aura Media Server host name
resolution on page 69
Table continues

May 2017 Deploying Avaya Breeze 18


Comments on this document? infodev@avaya.com
Avaya Breeze SIP high availability deployment checklist

# Action Reference/Notes

11 Configure MRCP server on Avaya See Implementing and Administering


Aura Media Server to support Avaya Aura Media Server.
Automatic Speech Recognition (ASR)
and to stream Text-To-Speech (TTS).

Avaya Breeze SIP high availability deployment checklist


The following table lists the procedures required to deploy Avaya Breeze in a SIP high availability
configuration.
# Action Reference/Notes

1 Create an FQDN SIP Entity. Creating an FQDN SIP Entity on


page 80
2 Create the FQDN Entity Link. Creating the FQDN Entity Link on
page 80
3 Create a high availability Application Creating an Application and Application
and Application Sequence. Sequence for high availability on
page 81
4 Resolve the local host name. Resolving the local host name for high
availability on page 83
5 Enable load balancing for the cluster. Enabling HTTP load balancing in an
Avaya Breeze cluster on page 85

May 2017 Deploying Avaya Breeze 19


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

Key customer configuration information


You require the following information to install and configure Avaya Breeze. Have this information
before you begin the installation.
Network Settings
Field Information to enter Notes
IP Address Enter servers IP address Management IP address to be
assigned to Avaya Breeze.
Short Hostname Enter servers hostname
Network Domain Enter network domain or
none
Netmask Enter netmask
Default gateway Enter gateway IP address Default gateway for Avaya Breeze
management network interface.
DNS servers Enter the Primary, You can have up to three DNS
Secondary, and Tertiary DNS servers.
server IP address

Proxy settings
Field Information to enter Notes
HTTP Proxy Server Enter the IP address or FQDN
of the HTTP proxy server.
HTTP Proxy Port Enter the HTTP proxy port.
HTTPS Proxy Server Enter the IP address or FQDN
of the HTTPS proxy server.
HTTPS Proxy Port Enter the HTTPS proxy port.
HTTP Proxy exclusion list Enter the HTTPS proxy severs
with a delimiter of |.
For example, *ca.avaya.com|
*.us.avaya.com|135.9.95.*
Table continues

May 2017 Deploying Avaya Breeze 20


Comments on this document? infodev@avaya.com
Key customer configuration information

Field Information to enter Notes


By default, the customer domain will
be added to the proxy exclusion list.
The proxy exclusion list can be added
with the CEnetSetup command or
using the OVA properties during
deployment. If the destination for the
HTTP request matches any address in
the exclusion list, the HTTP request
will be sent directly to the destination
instead of the proxy.

System Time Settings


Field Information to enter Notes
Timezone Select the timezone from This configuration is mandatory for
this field. Avaya Breeze to function. The
timezone configured on Avaya
Breeze must match the timezone on
System Manager.
NTP Servers Enter IP/FQDN of Primary NTP You can have up to three NTP
Server servers.
Enter a value in this field only when
the VMware host does not
synchronize on its own.

User access
Field Information to enter Notes
Enhanced Access Enter one of the following:
Security Gateway
1 to enable EASG.
(EASG)
2 to disable EASG.

Customer Login Settings


Field Information to enter Notes
Login Name Enter Login ID to use for Login ID and password for customer
the customer account (cust). account you will create during OVA
deployment.
Enter Password Enter the customer account
password.

May 2017 Deploying Avaya Breeze 21


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

System Manager Settings


Field Information to enter Notes
Primary System Manager Enter the IP Address of the Primary
IP System Manager that will be used to
manage this Avaya Breeze server.
Enrollment Password Enter the Enrollment Password Note:
that matches the value in System
Manager administration. You must know the Enrollment
Password, and the password
must not have expired.
The password is set on System
Manager at Security >
Certificates > Enrollment
Password.
On this page, verify that the Time
Remaining is greater than zero.
If you do not know the password,
create a new one.

Flexi Footprint values


Consult your Avaya Breeze Snap-in Reference documents for specific profile and disk sizing
requirements for snap-ins you intend to install. Some snap-ins require higher disk space
provisioning than the default of 50GB. This requires the customer to make this modification
manually in the VM settings.
Profile CPU Available Disk Storage (GB) Notes
(cores) Memory
(GB)
1 4 (default) 6 (default) 50 GB Default size for General Purpose cluster
profile, maximum active SIP application
sessions: 29,900 sessions. This deployment
requires 4 CPUs, 6 GB Memory and 50 GB
disk space.
2 4 8 50 GB The 8 GB size is required for Avaya
Engagement Designer . Maximum active SIP
application sessions: 29,900 sessions. This
deployment requires 4 CPUs, 8 GB Memory
and 50 GB disk space.
3 6 10 50 GB This profile is targeted as a migration path for
the Presence Services application on
Midsize Enterprise to Presence Services 7.0
with Avaya Breeze. Maximum active SIP
application sessions: 44,880 sessions. This
deployment requires 6 CPUs, 10 GB Memory
and 50 GB Disk space.
Table continues

May 2017 Deploying Avaya Breeze 22


Comments on this document? infodev@avaya.com
Key customer configuration information

Profile CPU Available Disk Storage (GB) Notes


(cores) Memory
(GB)
4 8 16 50 GB Maximum active SIP application sessions:
59,840 sessions. This deployment requires 8
For Solution
CPUs, 16 GB Memory and 150 GB disk
Deployment
space.
Manager
deployments this
increases to 150 GB.
5 12 27 50 GB Presence Services Environment: Dell R610
with: 2 x 6 cores CPU, cpu speed clock > =
For Solution
2.925 GHz, 32 GB RAM, 3 x 300 GB hard
Deployment
drive configured using RAID 5. 27 GB
Manager
memory based on CSR1 server with AVP
deployments this
using 5 GB. This deployment requires 12
increases to 150 GB.
CPUs, 27 GB Memory and 300 GB disk
space.

Virtual Machine
The Avaya Breeze profile you select has default values, which can be adjusted, for these settings.

Field Information to enter Notes


DataStore location Select the datastore location to store
the virtual machine files.
Host networking
assignments

vCenter and ESXi Host


Field Information to enter Notes
vCenter Host Name If the chosen OVA deployment method
is without vCenter, the vCenter
information is not needed.
vCenter IP Address
vCenter Login
vCenter Password
ESXi Host Name If the chosen OVA deployment method
uses vCenter, the host name is the
only field needed from this table.
ESXi IP Address Host IP Address
ESXi host user name
ESXi host password

May 2017 Deploying Avaya Breeze 23


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

SIP Entity (Security Module Interface) Networking Information


This information is required for administering Avaya Breeze SIP Entity and Avaya
Breezeinstance.

Required information Value


IP address
Subnet Mask
Gateway

Out of Band Management in Avaya Breeze


Avaya Breeze always has two IP addresses that reside on the same or different IP networks
depending on the Out of Band Management network.
The IP addresses for the security and management interface must be on:
Same IP network if Out of Band Management is disabled.
Different IP networks if Out of Band Management is enabled.

Network latency
Avaya Breeze tolerates the following maximum network latencies without call failures under load:
150ms for the WAN connection between the endpoint and the data center (one way delay).
42ms for the LAN connection among components in the data center, such as Avaya Breeze
to Session Manager and Avaya Breeze to Avaya Breeze.

Latest software updates and patch information


Before you start the deployment or upgrade of a solution or product, download the latest software
updates or patches. For more information, see the latest release notes, Product Support Notices
(PSN), and Product Correction Notices (PCN) for the product or solution on the Avaya Support
website at https://support.avaya.com/.
After deploying or upgrading a solution or a product, by using the instructions in the release notes,
PSNs, or PCNs install the software updates or patches if any.

May 2017 Deploying Avaya Breeze 24


Comments on this document? infodev@avaya.com
Chapter 5: Avaya Breeze OVA
Deployment

OVA deployment requirements


This section leads you through the steps to deploy the Avaya Breeze Open Virtual Appliance
(OVA). You can deploy it with:
The VMware vSphere Web Client. See Deploying Avaya Breeze OVA with VMware vSphere
Web Client.
The VMware vSphere Client
- connected to the VMware vCenter. See Deploying Avaya Breeze OVA with VMware
vSphere Client connected to vCenter.
- connected to ESXi Host. See Deploying Avaya Breeze OVA with VMware vSphere Client
connected to ESXi host.
Solution Deployment Manager. See Deploying Avaya Breeze OVA with Solution Deployment
Manager.
Select the procedure that applies to you.
You must have the following to complete a procedure:
A VMware host with sufficient available resources. For a description of required resources see,
Avaya Breeze Overview and Specification.
The vSphere Client software.
A downloaded copy of the Avaya Breeze OVA.
The information recorded in the Customer Configuration Information Worksheet.
After deploying Avaya Breeze OVA, you can run the CEnetSetup command to change the value
of any OVA property specified during deployment.
If you change the IP address or FQDN of Avaya Breeze using the CEnetSetup or the
AvayaNetSetup script, you must follow the steps in the Configuring Avaya Breeze after
changing the IP address or FQDN using AvayaNetSetup or CEnetSetup section.
Related links
Deploying Avaya Breeze OVA with VMware vSphere Web Client on page 27
Deploying Avaya Breeze OVA with VMware vSphere Client connected to vCenter on page 31
Deploying Avaya Breeze OVA with VMware vSphere Client connected to ESXi host on page 36
Deploying Avaya Breeze OVA with Solution Deployment Manager on page 43

May 2017 Deploying Avaya Breeze 25


Comments on this document? infodev@avaya.com
Avaya Breeze OVA Deployment

Downloading software from PLDS


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. Select View Downloads.
5. If you are a customer, skip this step.
a. In the %Name field, either Enter Avaya or the Partner company name, or click on the
search icon (magnifying glass) and select the appropriate company from the drop-down
menu.
b. Click on Apply Company.
6. Click the Search by Download tab.
7. Enter any information specific to the download, or leave the fields blank to view all
downloads.
8. Click Search Downloads.
9. Locate the appropriate download.
10. Click the Download link in the left-most column of the download row.
11. In the Download Manager dialogue 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.
12. If you receive an error message, click on the install ActiveX message at the top of the page
and continue with the download.
13. Select a location where you want to save the file and click Save .
14. If you used the Download Manager, click Details to view the download progress.

Verifying Enrollment Password status


Avaya Breeze requires an Enrollment Password during the initial installation and deployment
process. Enrolling a password establishes trust between System Manager and Avaya Breeze. The
Enrollment Password is also known as the certificate enrollment password.
If the Enrollment Password has expired, renew the existing password for the upgrade to succeed.

May 2017 Deploying Avaya Breeze 26


Comments on this document? infodev@avaya.com
Deploying Avaya Breeze OVA with VMware vSphere Web Client

If the Time Remaining is not zero, the password is valid. Verify that the time remaining is sufficient
for the upgrade.
Procedure
1. On System Manager, in Services , click Security > Certificates > Enrollment Password.
2. If the value of the Time Remaining field is zero, renew 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 the password in the Password field.
c. Reenter the password in the Confirm Password field.
d. Click Commit.
The system updates the Time Remaining field.

Deploying Avaya Breeze OVA with VMware vSphere Web


Client
Before you begin
The steps in this procedure use vSphere Web Client connected to vCenter. It runs in a web browser.
Get the Avaya Breeze 3.3 OVA file, and save it on the workstation where you will be running the
vSphere web client to configure the new virtual machine (VM).
Use the Customer Configuration Information to get the required network settings for deployment.
You can obtain the settings from an existing system if you are redeploying the OVA.
If you are redeploying an instance of Avaya Breeze, ensure that you deny new service to and
power off the instance that is being redeployed.
Verify that the Enrollment Password is administered and not expired.
Procedure
1. Log in to the vCenter using the VMware vSphere Web Client. The format for ESXi 5.x is
https://<IP Address:9443>/vsphere-client. (For example, https://
xxx.xxx.xxx.xxx:9443/vsphere-client/.)
2. From the left navigation pane, click vCenter.
3. Click Inventory Trees > Hosts and Clusters.
4. Expand Hosts and Clusters to locate and select the target deployment host.
5. Right-click the on the host and select Deploy OVF Template.
6. On the Select Source page, enter the URL or path for installing the OVA, and click Next.

May 2017 Deploying Avaya Breeze 27


Comments on this document? infodev@avaya.com
Avaya Breeze OVA Deployment

7. On the Review Details page, confirm the properties of the OVA file you selected and click
Next.

8. To accept the End User License Agreement, click Accept.


9. Click Next.
10. Enter a name for the Avaya Breeze VM and select the required datacenter folder for the
VM.
11. Click Next.
12. On the Select a resource page, select the location to run the deployed template and click
Next.

May 2017 Deploying Avaya Breeze 28


Comments on this document? infodev@avaya.com
Deploying Avaya Breeze OVA with VMware vSphere Web Client

13. Select the configuration profile that best fits the deployment, and click Next.

14. Select the virtual disk format you want and click Next.
While Avaya Breeze works with either thick or thin provisioned disk, Avaya recommends
using a Thick Provision Lazy Zeroed disk.
15. Select the destination network for each Avaya Breeze interface and click Next.

May 2017 Deploying Avaya Breeze 29


Comments on this document? infodev@avaya.com
Avaya Breeze OVA Deployment

16. On the Setup networks page, configure the network settings for your VM and click Next.

See the Customer Configuration Information you collected for the network configuration
values.
17. On the Customize template page, enter the configuration details for your VM and click Next.
18. On the Ready to Complete page, verify the options for the VM:

If the values are incorrect, click Back to make the changes.


If the values are correct, click Finish.

May 2017 Deploying Avaya Breeze 30


Comments on this document? infodev@avaya.com
Deploying Avaya Breeze OVA with VMware vSphere Client connected to vCenter

Tip:
To alter the configuration settings later, see Maintaining and Troubleshooting Avaya
Breeze.
Wait for the deployment to complete. The time taken depends on the speed of your network
connection.
After the deployment is complete, the system updates the Inventory list and displays the new
VM.
19. Select the new VM and click the Summary tab.
20. Click Actions > Power On.
21. Click Summary > Launch Console to open a new console.
The system displays the progress of the VM system initialization.
22. After the VM initialization is complete, log in by using the customer account that you set up
earlier.

Deploying Avaya Breeze OVA with VMware vSphere


Client connected to vCenter
Before you begin
The steps in this procedure use the vSphere Client connected to VMware vCenter.
Get the Avaya Breeze 3.3 OVA file, and save it on the workstation where you will be running the
vSphere Client to configure the new virtual machine (VM).
Use the Customer Configuration Information to get the required network settings for deployment.
You can obtain the settings from an existing system if you are redeploying the OVA.
Verify that the Enrollment Password is administered and not expired.
If you are redeploying an instance of Avaya Breeze, ensure that you deny new service to and
power off the instance that is being redeployed.
Procedure
1. Log in to the vCenter using the VMware vSphere Client.
2. Click File > Deploy OVF Template
3. Click Browse and find the Avaya Breeze OVA. Click Next.
4. Verify that the details displayed match the version of the Avaya Breeze that you are
expecting to deploy.
If the details do not match, you may have chosen the wrong OVA. Click Back and choose
the correct OVA.
If the details match, click Next.

May 2017 Deploying Avaya Breeze 31


Comments on this document? infodev@avaya.com
Avaya Breeze OVA Deployment

5. If you wish to accept the End User License Agreement click Accept, then click Next.
6. On the Name and Location page, enter a name for the Avaya Breeze Virtual Machine (VM).
Select the inventory location for your VM , then click Next.

May 2017 Deploying Avaya Breeze 32


Comments on this document? infodev@avaya.com
Deploying Avaya Breeze OVA with VMware vSphere Client connected to vCenter

7. On the Deployment Configuration page, select the configuration profile that best fits the
deployment, then click Next.

8. On the Host/Cluster page, select the specific host on which you want to deploy this VM, and
click Next.
9. On the Disk Format page, select the disk provisioning format you want, then click Next.
While Avaya Breeze works with either thick or thin provisioned disk, Avaya recommends
using a Thick Provision Lazy Zeroed disk.
10. On the Network Mapping page, select the destination network for each Avaya Breeze
interface, and click Next.

May 2017 Deploying Avaya Breeze 33


Comments on this document? infodev@avaya.com
Avaya Breeze OVA Deployment

We recommend that you use different physical networks for each of the Avaya Breeze
interfaces.
Public (eth1) - Asset/security module
Out of band management (eth0) - management NIC

11. On the Properties page, enter the configuration details for your VM. Click Next.
See the Customer Configuration Information you collected for the values to enter in these
fields.

May 2017 Deploying Avaya Breeze 34


Comments on this document? infodev@avaya.com
Deploying Avaya Breeze OVA with VMware vSphere Client connected to vCenter

12. On the Ready to Complete page, verify the listed properties.

Important:
Do not check the Power on after deployment box.
If the values are incorrect, click Back to modify the values.
If the values are correct, click Finish.
Tip:
To alter the configuration settings later, see Maintaining and Troubleshooting Avaya
Breeze.

May 2017 Deploying Avaya Breeze 35


Comments on this document? infodev@avaya.com
Avaya Breeze OVA Deployment

A status window pops up after clicking Finish. Wait for the deployment to complete. The
time this takes depends on the speed of your network connection. Once completed, you can
close the window.
13. Locate your new VM in the inventory list in the vSphere Client window, right click and click
Virtual Machine > Power > Power On.
14. (Optional) To open a console window to your VM, right-click the VM and click Open
Console.

Deploying Avaya Breeze OVA with VMware vSphere


Client connected to ESXi host
Before you begin
The steps in this procedure use the VMware vSphere Client connected to the ESXi host.
Get the Avaya Breeze 3.3 OVA file, and save it on the workstation where you will be running the
VMware vSphere client to configure the new virtual machine (VM).
Use the Customer Configuration Information to get the required network settings for deployment.
You can obtain the settings from an existing system if you are redeploying the OVA.
Verify that the Enrollment Password is administered and not expired.
If you are redeploying an instance of Avaya Breeze, ensure that you deny new service to and
power off the instance that is being redeployed.
Procedure
1. Log in to the VMware host using the VMware vSphere client.
2. Click File > Deploy OVF Template
3. Click Browse and find the Avaya Breeze OVA.
4. Click Next.
5. Verify that the details displayed match the version of the Avaya Breeze that you are
expecting to deploy.
If the details do not match, you may have chosen the wrong OVA. Click Back and find the
correct OVA.
If the details do match, click Next.

May 2017 Deploying Avaya Breeze 36


Comments on this document? infodev@avaya.com
Deploying Avaya Breeze OVA with VMware vSphere Client connected to ESXi host

6. If you accept the End User License Agreement click Accept, and click Next.
7. Enter a name for the Avaya Breeze Virtual Machine (VM) on the Name and Location page,
and click Next.

May 2017 Deploying Avaya Breeze 37


Comments on this document? infodev@avaya.com
Avaya Breeze OVA Deployment

8. On the Deployment Configuration page, select the configuration profile that best fits the
deployment, then click Next.

9. On the Disk Format page, select the disk provisioning format you want, then click Next.
While Avaya Breeze works with either thick or thin provisioned disk, Avaya recommends
using a Thick Provision Lazy Zeroed disk.
10. On the Network Mapping page, select the destination network for each Avaya Breeze
interface, then click Next.
We recommend that you use different physical networks for each of the Avaya Breeze
interfaces.
Public (eth1) - Asset/security module

May 2017 Deploying Avaya Breeze 38


Comments on this document? infodev@avaya.com
Deploying Avaya Breeze OVA with VMware vSphere Client connected to ESXi host

Out of band management (eth0) - management NIC

May 2017 Deploying Avaya Breeze 39


Comments on this document? infodev@avaya.com
Avaya Breeze OVA Deployment

11. On the Ready to Complete page, verify the options listed.

Important:
Do not check the Power on after deployment box.
If the values are incorrect, click Back to modify the values.
If the values are correct, click Finish.
A status window pops up after clicking Finish. Wait for the deployment to complete. The
time this takes depends on the speed of your network connection. Once completed, you can
close the window.
12. Locate your new VM in the inventory list in the vSphere Client window.
13. Right-click to go to Power > Power On.

May 2017 Deploying Avaya Breeze 40


Comments on this document? infodev@avaya.com
Deploying Avaya Breeze OVA with VMware vSphere Client connected to ESXi host

14. To open a console window to your VM, right-click the VM and click Open Console.
15. During the boot, you will see the End User License Agreement. Scroll down through this
document using the spacebar. At the bottom, enter yes if you agree to the terms.
The VM continues to boot.
16. Towards the end of the boot sequence you are prompted to configure the VM. Enter y to
proceed.
17. When the system prompts, enter the management interface network parameters, date and
time information, customer user information, and System Manager information.
See the Customer Configuration Information you collected for the values to enter in these
fields.
Tip:
To alter the configuration settings later, see Maintaining and Troubleshooting Avaya
Breeze.
18. Run the CEnetSetup command to change the value of any OVA property specified during
deployment.
Refer to the following screenshots.

May 2017 Deploying Avaya Breeze 41


Comments on this document? infodev@avaya.com
Avaya Breeze OVA Deployment

May 2017 Deploying Avaya Breeze 42


Comments on this document? infodev@avaya.com
Deploying Avaya Breeze OVA with Solution Deployment Manager

Deploying Avaya Breeze OVA with Solution Deployment


Manager
Before you begin
Install the Avaya Appliance Virtualization Platform if necessary.
The steps in this procedure use the Solution Deployment Manager.
Use the Customer Configuration Information to get the required network settings for deployment.
You can obtain the settings from an existing system if you are redeploying the OVA.
Download the Avaya Breeze Open Virtual Appliance (OVA).
Verify that the Enrollment Password is administered and not expired.
Procedure
1. Copy the previously downloaded Avaya Breeze OVA file to the System Manager /
swlibrary/staging/sync/ directory. (If necessary, add the staging/sync folders to
the directory structure.)

May 2017 Deploying Avaya Breeze 43


Comments on this document? infodev@avaya.com
Avaya Breeze OVA Deployment

2. Navigate to Home > Services > Solution Deployment Manager > Software Library
Management and click Manage Files.
3. In the list of Sync Files from directory, enter the SHA256 checksum and select a software
library. For Product Family, Device Type, and Software Type, select others.
4. Click Sync and wait for the operation to complete.
5. Verify completion of the file sync to the library.
a. Navigate to Home > Services > Scheduler > Completed Jobs.
b. Observe for Job Name = IUM_syncFiles, and Job Status = SUCCESSFUL.
6. Navigate to Home > Services > Solution Deployment Manager > Software Library
Management.
7. Check SMGR_DEFAULT_LOCAL, click Manage Files, and confirm that the OVA file
appears in the list of files under Software Library Files.
8. Add a location to Solution Deployment Manager.
a. On System Manager navigate to Services > Solution Deployment Manager.
b. Click VM Management.
c. Select New under Locations.
d. Populate the location properties and click Save.
9. Add a host to a location. The VMware host or AVP must be accessible to the System
Manager to perform this step.
a. In the VM Management Tree, select the location to add the host to.
b. Click the Hosts tab.
c. Click Add on the Hosts tab.
d. Populate the Host Name, Host FQDN or IP, User Name, and Password fields. Use
the same information that was used during installation of the Appliance Virtualization
Platform.
Note:
For the Host FQDN or IP field, use the FQDN of the VMware host or the FQDN of
the Appliance Virtual Platform.
10. Navigate to Home > Services > Solution Deployment Manager > VM Management.
11. Select VM Management under the VM Management Tree, click on the Virtual Machines
tab, and click New.
12. In the Select Location and Host section, perform the following steps:
a. In Select Location, select a location.
b. In Select Host, select a host.
c. In Host FQDN, type the virtual machine name.
13. Click Next.

May 2017 Deploying Avaya Breeze 44


Comments on this document? infodev@avaya.com
Configuring Avaya Breeze after changing the IP address or FQDN using AvayaNetSetup or CEnetSetup

14. In the Deploy OVA section, perform the following steps:


a. In Select Software Library, select the local and remote library where the OVA file is
available. To deploy the OVA file using Solution Deployment Manager client, use the
default software library that is set during client installation.
b. In Select OVAs, select the OVA file that you want to deploy.
c. In Flexi Footprint, select a footprint.
15. Click the Configuration Parameters tab and populate the Configuration Parameters fields.
16. Click Deploy to begin the OVA deployment.
17. Click Accept the license terms.
18. Click the Virtual Machines tab.
19. Click the Status Details link to display the VM deploy Status window.
When all status points display green check marks, deployment is complete and the VM is
started.

Configuring Avaya Breeze after changing the IP address


or FQDN using AvayaNetSetup or CEnetSetup
About this task
If you configure the IP address or FQDN of Avaya Breeze using the AvayaNetSetup or the
CEnetSetup script, you must perform the following steps.
Procedure
1. Wait for the Avaya Breeze server to be up and running.
2. Wait for all services to be up on Avaya Breeze.
3. Run statapp to confirm that all services are up.
4. Run was restartw if websphere is not up and running.
5. Run initTM -f.
6. Run was restartw.
7. Add the Avaya Breeze server to the cluster.
8. Import certificates to the cluster.

May 2017 Deploying Avaya Breeze 45


Comments on this document? infodev@avaya.com
Avaya Breeze OVA Deployment

Configure virtual machine automatic startup settings


You do not need to configure the virtual machine automatic startup settings if you deploy the OVA
using Solution Deployment Manager. With Solution Deployment Manager the automatic startup
configuration is part of the VM deployment.
With other OVA deployment methods, all virtual machines must be configured to start automatically
when the vSphere ESXi host starts. Complete the procedure that corresponds to your OVA
deployment method.
In high availability (HA) clusters, the VMware HA software ignores the startup selections.

Configuring virtual machine automatic startup settings using


vSphere desktop client
Before you begin
Confirm that you have the proper level of permissions to configure the automatic startup settings. If
you do not have the proper level of permissions, contact your system administrator.
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 under Automatic Startup.
8. Click OK.
Example
The following is an example of the Virtual Machine Startup/Shutdown screen.

May 2017 Deploying Avaya Breeze 46


Comments on this document? infodev@avaya.com
Configure virtual machine automatic startup settings

Configuring virtual machine automatic startup settings using


vSphere Web Client
Before you begin
Confirm that you have the proper level of permissions to configure the automatic startup settings. If
you do not have the proper level of permissions, contact your system administrator.
Procedure
1. Select the host where the virtual machine is located.
2. Click Manage > Settings.
3. Click Virtual Machine Startup/Shutdown.
4. Click Edit.
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. Move the Avaya Breeze VM to be included for Automatic Startup.

May 2017 Deploying Avaya Breeze 47


Comments on this document? infodev@avaya.com
Avaya Breeze OVA Deployment

Changing the customer password on first login


Before you begin
Set a temporary password while deploying the Avaya Breeze OVA:
If using vCenter, set a temporary customer password during initial deployment. Regardless
what you set here, you will be prompted to change it upon first login
If using the Standalone client, set a temporary customer password post deployment during the
first boot where you are prompted to configure the Avaya Breeze node.
Procedure
1. Log in to the deployed and configured Avaya Breeze node.
2. Enter the customer login.
3. Enter the temporary customer password created while deploying the OVA.
4. When the system prompts to change the password for the customer login, enter the new
password.
The new password:
Must have at least eight characters.
Should not be based on a dictionary word or username.
Must contain a mix of numbers, letters, and at least one special character.
Must have a mix of upper and lower case letters.
Cannot be the same as the temporary password.
5. When the system prompts to confirm the password, reenter the same password that you
entered in Step 4

Patching Avaya Breeze


About this task
This procedure provides general patching steps. Refer to the Release Notes and PSN to determine
if there are patch-specific installation instructions.
Caution:
With Avaya Breeze Release 3.3 and later releases, you cannot remove a patch after it is
installed.
Before you begin
The server must be in a deny service state. You must have downloaded the patch file and copied it
to the Avaya Breeze server. The patch should have the following Linux permissions: rw-r---
r---.

May 2017 Deploying Avaya Breeze 48


Comments on this document? infodev@avaya.com
Creating multiple privileged user accounts

Procedure
1. Log in to Avaya Breeze using the customer account.
2. Execute the patchCE command.
For example: $ patchCE i /home/cust/<patchname>.bin
3. When prompted that the patch is service interrupting, answer Yes and press Enter.
The patch installs. Wait for the patch installation to complete. Depending on the patch,
Avaya Breeze may reboot.
4. Verify the version of the installed patch. The version can be viewed in one of the following
ways:
Log in to Avaya Breeze and execute the command patchCE s.
Log in to Avaya Breeze and execute the command swversion.
On System Manager, in Elements, click Avaya Breeze > Server Administration.
5. On System Manager, in Elements, Avaya Breeze > Server Administration , identify the
row for the Avaya Breeze server you are patching. Verify the following information:
The Service Install Status is a green checkmark
The Security Module is Up
The License mode is a green checkmark
The Version displays the new release

Creating multiple privileged user accounts


Procedure
1. Log in to Avaya Breeze with the login credentials created during the OVA deployment.
2. Type the custAccounts -a command.
The system prompts you to add this user as an EASG administrator. Accept the default
value, or enter y. Selecting y enables the user to run the EASG commands. The system
prompts you to enter the login credentials for a new customer user account you are creating.
3. Enter the user name and password for the new customer user account you are creating.
This password is a temporary password that you must change at the first login attempt for
the new account.
4. Reenter the password for confirmation.

May 2017 Deploying Avaya Breeze 49


Comments on this document? infodev@avaya.com
Avaya Breeze OVA Deployment

Enhanced Access Security Gateway


Avaya Breeze supports Enhanced Access Security Gateway (EASG). EASG is a certificate based
challenge-response authentication and authorization solution. Avaya uses EASG to securely access
customer systems and provides support and troubleshooting.
EASG provides a secure method for Avaya services personnel to access the Avaya Breeze
remotely and onsite. Access is under the control of the customer and can be enabled or disabled at
any time. EASG must be enabled for Avaya Services to perform tasks necessary for the ongoing
support, management and optimization of the solution. EASG is also required to enable remote
proactive support tools such as Avaya Expert Systems and Avaya Healthcheck. EASG must be
enabled for Avaya Services to perform the required maintenance tasks.
EASG only supports Avaya services logins, such as init, inads, and craft.

Enabling and disabling EASG


About this task
By enabling Avaya Services Logins, you are granting Avaya access to your system. This setting is
required to maximize the performance and value of your Avaya support entitlements, allowing Avaya
to resolve product issues in a timely manner. The product must be registered using the Avaya
Global Registration Tool (GRT) at https://grt.avaya.com for Avaya remote connectivity. See the
Avaya support site https://support.avaya.com/registration for additional information for registering
products and establishing remote access and alarming. By disabling Avaya Services Logins, you
are denying Avaya access to your system. This setting is not recommended, as it can impact
Avayas ability to provide support for the product. Unless the customer can manage the product,
Avaya Services Logins should not be disabled.
Procedure
1. Log in to the Avaya Breeze CLI interface using customer account.
2. To check the status of EASG, run the following command: EASGStatus.
3. To enable EASG, run the following command: EASGManage -enableEASG.
4. To disable EASG, run the following command: EASGManage -disableEASG.

Viewing the EASG certificate information


About this task
Use this procedure to view information about the product certificate, which includes information
about when the certificate expires.
Procedure
1. Log in to the Avaya Breeze CLI interface using customer account.

May 2017 Deploying Avaya Breeze 50


Comments on this document? infodev@avaya.com
Enhanced Access Security Gateway

2. Run the following command: EASGProductCert --certInfo.

EASG site certificate


EASG site certificates are used by the onsite Avaya technicians who do not have access to the
Avaya network to generate a response to the EASG challenge. The technician will generate and
provide the EASG site certificate to the customer. The customer loads this EASG site certificate on
each Avaya Breeze server to which the customer has granted the technician access. The EASG
site certificate will only allow access to systems on which it has been installed, and will only allow
access to the given Avaya technician and cannot be used by anyone else to access the system
including other Avaya technicians. Once this is done, the technician logs in with the EASG challenge
and response. After the technician is done, the customer can remove the EASG site certificate from
the server or it will be removed by the EASG software after the site certificate expires.

Managing site certificates


Before you begin
Obtain the site certificate from the Avaya support technician and install it to Avaya Breeze. Note
the location of this file and use it in place of installed_pkcs7_name in the following commands.
Procedure
1. Log in to the Avaya Breeze CLI interface using customer account.
2. To install the site certificate:
a. Run the following command: EASGSiteCertManage add
<installed_pkcs7_name>.
b. Save the Site Authentication Factor to share with the technician once on site.
3. To view information about a particular certificate: run the following command:
EASGSiteCertManage --list: To list all the site certificates that are currently installed
on the system.
EASGSiteCertManage --show <installed_pkcs7_name>: To display detailed
information about the specified site certificate.
4. To delete the site certificate, run the following command:
EASGSiteCertManage --delete <installed_pkcs7_name>: To delete the
specified site certificate.
EASGSiteCertManage --delete all: To delete all the site certificates that are
currently installed on the system.

May 2017 Deploying Avaya Breeze 51


Comments on this document? infodev@avaya.com
Chapter 6: Avaya Breeze System Manager
Administration

Installing the Avaya Breeze license file


Procedure
1. On the System Manager web console, click Services > Licenses.
2. Click Install license and Browse to the location of the Avaya Breeze license file on your
computer.
3. Click Install.

Administering an Avaya Breeze SIP Entity


Before you begin
To complete this task, you will need the IP address of the Avaya Breeze Security Module interface
and the SIP Entity name.
About this task
Administer Avaya Breeze as a SIP Entity so that you can configure Session Manager to route
traffic through Avaya Breeze.
Procedure
1. On System Manager, in Elements, click Routing > SIP Entities and click New.
2. In the Name field, type the name of your SIP Entity.
The SIP Entity name is automatically used as your Avaya Breeze instance name when you
create the Avaya Breeze instance.
3. In the FQDN or IP Address field, type the IP address of your Avaya Breeze Security
Module.
You must only enter the IP address.
4. From the Type drop-down menu, select Avaya Breeze.
5. From the SIP Link Monitoring drop-down menu, select Link Monitoring Enabled.

May 2017 Deploying Avaya Breeze 52


Comments on this document? infodev@avaya.com
Administering the Avaya Breeze Entity Link

6. Click Commit to save your changes.


Next steps
Administer an Entity Link to connect Session Manager and Avaya Breeze.
Related links
Creating an FQDN SIP Entity on page 80

Administering the Avaya Breeze Entity Link


Before you begin
Administer Avaya Breeze as a SIP Entity.
About this task
Create an Entity Link to connect Session Manager to Avaya Breeze. You must administer separate
Entity links for Avaya Breeze servers in order to open SIP listeners on the designated ports.
Note:
You must use a common protocol for the entity links between Avaya Breeze and Session
Manager, and between Session Manager and Avaya Aura Media Server. If you have multiple
Avaya Aura Media Servers with different protocols, configure two Entity Links between Avaya
Breeze and Session Manager for TLS and TCP.
Note:
TLS is the recommended protocol for production environments since it is secure and encrypted.
Should the need arise to take a network trace between Session Manager and Avaya Breeze,
change the protocol to TCP. If this is a production environment, change the protocol back to
TLS as soon as the trace is complete.
Procedure
1. On System Manager, in Elements , click Routing > Entity Links and click New.
2. In the Name field, type a name for the Avaya Breeze SIP Entity Link.
3. For the SIP Entity 1 select the Session Manager.
4. For the SIP Entity 2 select the Avaya Breeze SIP Entity that you created.
5. Edit Protocol and Connection policy fields if necessary.
6. Press Commit to save your changes.

May 2017 Deploying Avaya Breeze 53


Comments on this document? infodev@avaya.com
Avaya Breeze System Manager Administration

Enabling implicit users applications for SIP users


About this task
This procedure is required for calling-party and called-party snap-ins.
Note:
You must perform this procedure only once.
Procedure
1. On System Manager, in Elements, click Session Manager > Session Manager
Administration.
2. Under Global Settings, select Enable Implicit Users Applications for SIP users.
3. Click Save.

Administering an Avaya Breeze instance


Before you begin
To complete this task you will need:
The IP address of the Avaya Breeze Management Network Interface.
This is the same IP address you used when deploying the Virtual Machine (VM).
The IP address including the network mask, and default gateway for the Avaya Breeze
Security Module.
The SIP entity name associated to the Avaya Breeze Security Module.
Note:
In accordance with the Avaya End User License Agreement (EULA) you can administer only the
number of Avaya Breeze instances allowed by your Avaya Breeze license.
Procedure
1. On the System Manager web console, click Elements > Avaya Breeze.
2. Click Server Administration.
3. In the Avaya Breeze Server Instances list, click New.
4. In the SIP Entity field, select the SIP Entity that you created.
5. Ensure that the value in the UCID Network Node ID field is unique across the solution
deployment so that it does not conflict with other UCID-generating entities like Avaya Aura
Communication Manager or Avaya Aura Experience Portal.
UCID Network Node ID is a unique, numeric node ID that is assigned to each Avaya
Breeze server provisioned.

May 2017 Deploying Avaya Breeze 54


Comments on this document? infodev@avaya.com
Verifying the Avaya Breeze Entity Link connection

6. In the Management Network Interface FQDN or IP Address field, type the IP address or
FQDN of the Avaya Breeze Management Network Interface.
7. In the Security Module Network Mask field, type the network mask used for the SIP
(Security Module) network.
8. In the Security Module Default Gateway field, type the default gateway used for the SIP
(Security Module) network.
9. Click Commit to save your changes.
Note:
The Commit fails if the Avaya Breeze license file on WebLM does not have the
sufficient capacity to allow addition of another Avaya Breeze server.
10. To put the Avaya Breeze instance in service complete the following steps:
Note:
If an in-service cluster does not exist, you must create a new cluster.
a. On System Manager, in Elements, click Avaya Breeze > Cluster Administration.
b. Select a cluster and assign your Avaya Breeze server to the cluster.
For more information, see Creating a new cluster.
c. Click Cluster State > Accept New Service.
For more information, see Accepting new service.

Verifying the Avaya Breeze Entity Link connection


About this task
Complete this task to verify that Session Manager can connect with Avaya Breeze using the SIP
Entity Link. To do this you must first verify the status of SIP link monitoring on the Session Manager
instance.
Procedure
1. Modify the Session Manager Instance.
a. On System Manager, in Elements , click Session Manager > Session Manager
Administration.
b. Select the Session Manager instance that you linked to Avaya Breeze. Click Edit.
c. Check Enable Monitoring in the Monitoring section.
d. Click Commit.
2. Test the Entity Link.
a. On System Manager, in Elements , click Session Manager > System Status > SIP
Entity Monitoring.

May 2017 Deploying Avaya Breeze 55


Comments on this document? infodev@avaya.com
Avaya Breeze System Manager Administration

b. Click the name of the Session Manager Instance that you linked to Avaya Breeze.
The system displays a list with the status of all the Entity Links for the selected Session
Manager.
c. Locate the Avaya Breeze SIP Entity and check the Conn. Status column.
If you see UP, the link to Session Manager is successful.
If you do not see UP, for additional information, see Avaya Breeze FAQ and
Troubleshooting for Service Developers.

Verifying replication status


About this task
Complete this task to verify that the System Manager database replicated to Avaya Breeze.
Procedure
1. On System Manager, in Services, click Replication.
2. Locate the Avaya Breeze in the Replica Group list.
3. In the Synchronization Status column, verify that the Avaya Breeze status is
Synchronized.
Depending on the amount of data, the replication might take some time to complete. Refresh
the page or periodically recheck the status.
If the status is not Synchronized, for more information, see Maintaining and
Troubleshooting Avaya Breeze.

Verifying the management link


Procedure
1. On the System Manager web console, click Elements > Avaya Breeze.
2. Click Server Administration.
3. Check the Tests Pass column.
A green check mark indicates that the management link is up and healthy.
Dashes indicate that the management link is still initializing and is not up yet.
A red cross indicates that the management link is down.
For more information, see Maintaining and Troubleshooting Avaya Breeze.

May 2017 Deploying Avaya Breeze 56


Comments on this document? infodev@avaya.com
Creating a new cluster

Creating a new cluster


Before you begin
Load the required services or bundles for your cluster on the Service Management page.
About this task
Use the Cluster Editor page to:
Select a cluster profile.
Configure the cluster attributes.
Add Avaya Breeze servers to a cluster.
Install snap-ins on a cluster.
Subscribe to Reliable Eventing groups that are already created.
You must set up user name and password for Avaya Aura Media Server if basic authentication is
used in Avaya Aura Media Server administration.
Procedure
1. On the System Manager web console, click Elements > Avaya Breeze.
2. In the navigation pane, click Cluster Administration.
3. On the Cluster Administration page, click New.
4. On the Cluster Editor page, select the cluster profile of your choice.
Note:
You must select a cluster profile to view the appropriate cluster attributes.
For example, select the general purpose cluster profile or a product specific cluster profile.
Use the Context Store profile for the Context Store snap-in, Work Assignment profile for
the Work Assignment snap-ins, Customer Engagement profile for Avaya Oceana
Solution, Core Platform profile for Presence Services, General Purpose Large profile for
the Engagement Call Control snap-in and the General Purpose profile for other snap-ins.
Refer to the snap-in reference documentation for the cluster profile appropriate for the use
case being deployed.
5. Enter the cluster attributes for your cluster. You can edit the default cluster attributes the
system displays.
The name and the IP address of a cluster must be unique.
You cannot edit all the cluster attributes. Some attributes are read-only.
Note:
Do not assign a Cluster IP for a single-node cluster.
6. If you will be installing snap-ins that use the cluster database, check Enable Cluster
Database.

May 2017 Deploying Avaya Breeze 57


Comments on this document? infodev@avaya.com
Avaya Breeze System Manager Administration

Note:
If you attempt to install a snap-in using the cluster database on a cluster that has the
Enable Cluster Database feature disabled, the installation will be blocked.
7. (Optional) Click the Servers tab to assign Avaya Breeze servers to the cluster.
Important:
Do not assign servers with different releases to the same cluster. All servers in the
cluster should be running the same Avaya Breeze version.
For more information on upgrading clusters, see Upgrading Avaya Breeze.
8. (Optional) Click the Services tab to assign snap-ins to this cluster.
When you assign snap-ins to a cluster, the highest version of the required snap-ins are
automatically assigned to the cluster for installation. For the product specific cluster profiles,
you must load the required snap-ins from the Service Management page before you install
the snap-in.
In the Select TLS Version for Selected Snap-in field, select the TLS version of the
snap-in.
By default, Avaya Breeze uses the value of the Minimum TLS Version field set in
System Manager global configuration. The following values for TLS are acceptable:
TLS: Denotes TLS 1.0 and TLS 1.1.
TLS 1.2: Denotes TLS 1.2.
9. (Optional) Click the Reliable Eventing Groups tab to add the Reliable Eventing Groups
that you have already created.
In the Available Reliable Eventing Groups table, click the + icon adjacent to a group.
Selecting a Reliable Eventing Group would enable the snap-ins installed in the cluster to get
connection details to the eventing group and use that to send/receive inter-cluster events.
10. Click Commit to create the cluster.
The Service Install Status in the Cluster Administration page displays a green tick symbol
after all the assigned snap-ins are successfully installed on all the servers in the cluster.
To view the Avaya Breeze servers in the cluster, click Show in the Details column of the
cluster. The system displays the members of the cluster, and the status of each instance in
the cluster.
Click a specific Avaya Breeze server to go to the Avaya Breeze Instance Editor page.
You can view and edit the properties of the Avaya Breeze server from this page.
Note:
When you administer a new Avaya Breeze server, you must add the server to a cluster.
If you do not add the Avaya Breeze server to a cluster, you cannot install snap-ins on
that server.

May 2017 Deploying Avaya Breeze 58


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

Accepting new service


About this task
The steps for returning the server to service are different depending on if the server is being added
to an existing in-service cluster or if it is being added as part of a new cluster. Follow the steps
appropriate to your situation.
Procedure
1. On the System Manager web console, click Elements > Avaya Breeze.
2. In the navigation pane, click Cluster Administration.
3. Select a cluster and assign your Avaya Breeze server to the cluster.
4. If this is a new cluster, put the cluster in service.
a. From the Cluster State drop-down menu, select Accept New Service.
b. Verify that the Cluster State column for the cluster changed to Accepting.
5. If you are adding the server to an existing cluster that is in service, accept service for the
server.
a. On System Manager, in Elements, click Avaya Breeze > Server Administration.
b. Click the checkbox in front of the new server.
c. From the System State drop-down menu, select Accept New Service.
d. Verify that the System State column for the server changed to Accepting.

Cluster Database backup and restore

Backing up a cluster
About this task
The backup feature allows databases in the Cluster database to be backed up. The Cluster
database contains all different databases defined by the snap-in that are installed on the cluster.
You can backup on one cluster and restore on another.
Note:
Windows CoreFTP server is incompatible with the Cluster Backup and Restore feature and
should not be used as an archive server.
Procedure
1. On the System Manager web console, navigate to Elements > Avaya Breeze.
2. In the navigation pane, click Cluster Administration.

May 2017 Deploying Avaya Breeze 59


Comments on this document? infodev@avaya.com
Avaya Breeze System Manager Administration

3. Click Backup and Restore > Configure.


4. Enter the backup server details.
5. Click Test Connection to verify the connection of the backup server.
6. Click Commit.
7. Select the cluster that you want to backup, and click Backup and Restore > Backup.
The system displays the Cluster DB Backup page.
8. In the Backup section, select the services to back up.
9. In the Job schedule section, enter the following details:
In the Backup password field, enter a password.
In the Schedule Job field, select Run immediately or Schedule later.
If you select Schedule later, enter the appropriate details in the Task Time, Recurrence,
and Range fields.
10. Click Backup.
11. To monitor the status of the backup, click Backup and Restore > Job Status.
12. To cancel the backup operation, click Backup and Restore > Cancel.

Restoring a cluster
About this task
Restore can be performed on any cluster where Cluster database is enabled.
Note:
Windows CoreFTP server is incompatible with the Cluster Backup and Restore feature and
should not be used as an archive server.
Before you begin
Cluster database must be enabled.
Procedure
1. On the System Manager web console, navigate to Elements > Avaya Breeze.
2. In the navigation pane, click Cluster Administration.
3. Click Backup and Restore > Restore.
The system lists the backup and restore jobs.
4. Select a completed backup, and click Restore.
5. Select the cluster on which you want to restore the backup, and click Continue.

May 2017 Deploying Avaya Breeze 60


Comments on this document? infodev@avaya.com
Reliable Eventing administration

Cancelling a pending job


Procedure
1. On the System Manager web console, navigate to Elements > Avaya Breeze.
2. In the navigation pane, click Cluster Administration.
3. Click Backup and Restore > Cancel
The system displays the Backup and Restore Status page.
4. Select the pending job to be cancelled, and click Cancel.
5. Click Continue.

Purging a backup
Before you begin
The backup to be purged must be complete.
Procedure
1. On the System Manager web console, navigate to Elements > Avaya Breeze.
2. In the navigation pane, click Cluster Administration.
3. Click Backup and Restore > Purge
The system displays the Backup and Restore Status page.
4. Select the backup and click Purge.
The system displays Warning: Purged backups will no longer be available
for restore.
5. Click Confirm.

Reliable Eventing administration


Reliable Eventing Framework provides a new mechanism for delivering messages. The current
Eventing Framework uses Collaboration Bus as a point-to-point delivery mode for intra-node
asynchronous events with high performance. The Reliable Eventing Framework adopts Apache
ActiveMQ that provides a richer set of capabilities like reliability, asynchronous events, inter-node,
and inter-cluster which are not available in Eventing Framework.

May 2017 Deploying Avaya Breeze 61


Comments on this document? infodev@avaya.com
Avaya Breeze System Manager Administration

Reliable Eventing Framework provides the following features beyond what Eventing Framework
provides:
Enables delivery of events across servers and clusters.
Guarantees event delivery with event persistence, acknowledgement, and durable
subscriptions.
Master/Slave high availability with replicated persistent messages.
Related links
Creating a Reliable Eventing group on page 62
Editing a Reliable Eventing group on page 63
Deleting a Reliable Eventing group on page 63
Viewing the status of Reliable Eventing destinations on page 63
Deleting a Reliable Eventing destination on page 64
Executing maintenance test for a broker on page 64

Creating a Reliable Eventing group


Procedure
1. On the System Manager web console, navigate to Elements > Avaya Breeze.
2. In the navigation pane, click Reliable Eventing Administration > Dashboard.
3. Click New.
4. Enter the following details:
Cluster: Select the cluster on which you want to create the Reliable Eventing group.
Group Name: Assign a name to the Reliable Eventing group.
Description: Enter a brief description.
Type: Select the type of Reliable Eventing group: HA or Standalone.
5. In the Unassigned Brokers table, click + to assign the Avaya Breeze nodes or brokers to
the Reliable Eventing group.
6. Click the Associated clusters tab:
a. In the Unassigned associated clusters table, click the + icon to add an associated
cluster.
b. In the Assigned associated clusters table, click the X icon to remove an associated
cluster.
7. Click Commit.
The Status column shows one of the following:
Green checkmark: Indicates that the status of the broker is up and running for subscription
and event transfers.

May 2017 Deploying Avaya Breeze 62


Comments on this document? infodev@avaya.com
Reliable Eventing administration

Red cross icon: Indicates that the status of the broker is down.
8. To view the status of the brokers, click the green checkmark.
Related links
Reliable Eventing administration on page 61

Editing a Reliable Eventing group


Procedure
1. On the System Manager web console, navigate to Elements > Avaya Breeze.
2. In the navigation pane, click Reliable Eventing Administration > Dashboard.
3. Select the Reliable Eventing group and click Edit.
4. Assign new brokers or remove existing brokers.
5. Click the Associated clusters tab:
a. In the Unassigned associated clusters table, click the + icon to add an associated
cluster.
b. In the Assigned associated clusters table, click the X icon to remove an associated
cluster.
6. Click Commit.
Related links
Reliable Eventing administration on page 61

Deleting a Reliable Eventing group


Procedure
1. On the System Manager web console, navigate to Elements > Avaya Breeze.
2. In the navigation pane, click Reliable Eventing Administration > Dashboard.
3. Select the Reliable Eventing group and click Delete.
4. In the Confirm Delete window, click Continue.
Related links
Reliable Eventing administration on page 61

Viewing the status of Reliable Eventing destinations


Procedure
1. On the System Manager web console, navigate to Elements > Avaya Breeze.

May 2017 Deploying Avaya Breeze 63


Comments on this document? infodev@avaya.com
Avaya Breeze System Manager Administration

2. In the navigation pane, click Reliable Eventing Administration > Destination Status.
3. In the Group field, select the Reliable Eventing group.
The system displays the destination status.
Related links
Reliable Eventing administration on page 61

Deleting a Reliable Eventing destination


Procedure
1. On the System Manager web console, navigate to Elements > Avaya Breeze.
2. In the navigation pane, click Reliable Eventing Administration > Destination Status.
3. In the Group field, select the Reliable Eventing group.
The system displays the destination status.
4. Select a Destination and click Delete.
5. Click Commit.
The system will purge the messages and delete the destination.
Related links
Reliable Eventing administration on page 61

Executing maintenance test for a broker


Procedure
1. On the System Manager web console, navigate to Elements > Avaya Breeze.
2. In the navigation pane, click System Tools And Monitoring > Maintenance Tests.
3. Select Test Eventing Broker Status.
4. Click Execute Selected Tests.
The system displays the status as:
Failure when Reliable Eventing is down. That is, publishing and receiving messages by
Reliable Eventing is failing.
Success when Reliable Eventing is up and running. That is. publishing and receiving
messages by Reliable Eventing is working fine.
Related links
Reliable Eventing administration on page 61

May 2017 Deploying Avaya Breeze 64


Comments on this document? infodev@avaya.com
Chapter 7: Avaya Aura Media Server
Deployment

Avaya Aura Media Server OVA deployment


The Avaya Aura Media Server deployment checklist contains the high level deployment procedure.
There are several different ways to deploy the Avaya Aura Media Server. The detailed procedure
used to deploy the Avaya Aura Media Server Open Virtual Appliance (OVA) can be found in the
Deploying and Updating Avaya Media Server using VMware in the Virtualized Environment.
The following sections lead you through the steps to configure Avaya Aura Media Server for use
with Avaya Breeze after the Avaya Aura Media Server OVA is deployed.

Administering Avaya Aura Media Server for REST


About this task
Use this procedure to configure Avaya Aura Media Server to allow REST access using HTTP.
Note:
It is not recommended to use 1+1 HA clustering for Avaya Aura Media Server.
For more information, see Implementing and Administering Avaya Aura Media Server.
Procedure
1. Log on to the Avaya Aura Media Server web console.
2. Navigate to System Configuration > Signaling Protocols > REST > General Settings.
3. To enable TLS for REST services, select the Enable TLS Transport check box.
4. To enable two-way authentication for an extra level of security, select the Enable TLS
Mutual Authentication check box.
5. To use plaintext usernames and passwords, select Basic Authentication. Alternatively, to
include an authentication realm and encrypt the credentials before sending them over the
network, select Digest Authentication.
a. Enter the required username and password credentials in the Authentication
Username and Authentication Password fields.

May 2017 Deploying Avaya Breeze 65


Comments on this document? infodev@avaya.com
Avaya Aura Media Server Deployment

b. If you selected Digest Authentication, then enter the name of the required
authentication realm in the Authentication Realm field.
6. Click Save.
Changes to the transport settings require a restart to take effect.
7. Navigate to System Configuration > Network Settings > General Settings > Connection
Security.
8. Select the Verify Host Name of TLS Client Connections check box.
9. Click Save.
10. Navigate to Security > Certificate Management > Key Store.
11. Assign System Manager signed certificate to all service profiles.
12. Click Save.
13. Restart Avaya Aura Media Server:
a. Navigate to System Status > Element Status.
b. Click Restart.

Assigning Avaya Aura Media Server for use with Avaya


Breeze
Procedure
1. On the System Manager web console, click Elements > Media Server.
2. Click Application Assignment.
3. Select the check box next to Avaya Breeze, and click Edit.
4. Select the check box next to Avaya Aura Media Server and click Commit.
The system can take up to two minutes to update Avaya Breeze.
You cannot assign Avaya Aura Media Server to multiple applications.

Licensing the Avaya Aura Media Server


About this task
The license file installed on the System Manager WebLM and Avaya Aura Media Server gets the
license from System Manager WebLM.

May 2017 Deploying Avaya Breeze 66


Comments on this document? infodev@avaya.com
Installing the Avaya Aura Media Server license file

Note:
In accordance with the Avaya End User License Agreement (EULA) you can administer only the
number of Avaya Aura Media Server instances allowed by your Media Server license.
For more information, see Implementing and Administering Avaya Aura Media Server.
Procedure
1. Get the Avaya Aura Media Server license from PLDS.
2. Install the Avaya Aura Media Server license file on System Manager WebLM.
3. To configure Avaya Aura Media Server with the System Manager WebLM IP address,
perform the following steps:
a. Navigate to Licensing > General Settings.
b. From the Licensing drop-down list, select WebLM Server.
c. Enter the address of the WebLM Server that you plan to use in the Server Host Name
or IP Address field.
d. Enter the port to use with the WebLM Server in the Server Port field.
e. Enter the URL suffix used to identify the WebLM Server. The default URL suffix is /
WebLM/LicenseServer.
f. In the License Details , set the Maximum Number and Minimum Number based on
the number of sessions the cluster supports.
g. Click Save.

Installing the Avaya Aura Media Server license file


Procedure
1. On the System Manager web console, click Services > Licenses.
2. Click Install license and Browse to the location of the Avaya Breeze license file on your
computer.
3. Click Install.

Adding the System Manager IP address


Procedure
1. Type https://<fqdn>:8443/emlogin in a Web browser.
2. Log on to the Avaya Aura Media Server Element Manager interface using the customer
login ID and password created when you deployed the OVA.

May 2017 Deploying Avaya Breeze 67


Comments on this document? infodev@avaya.com
Avaya Aura Media Server Deployment

3. Navigate to System Configuration > Network Settings > General Settings.

4. In the SOAP section, Trusted Nodes field, type the IP address of the primary System
Manager that is used to manage Avaya Breeze. If this is a geo-redundant deployment, type
the secondary System Manager IP addresses in the second text field in the Trusted Nodes
box.
5. Click Save .
6. Repeat this procedure for each Avaya Aura Media Server.
Next steps
Configure announcements for services on each Avaya Aura Media Server. For additional
information, see Media File Provisioning in Implementing and Administering Avaya Aura Media
Server. All Media Servers must be configured with the same announcement files.

SIPS and SRTP on Avaya Aura Media Server


The Secure Real Time Protocol (SRTP) administration is described in detail in the Implementation
and Administering Avaya Aura Media Server document, specifically the topics on Configuring SIP
general settings and Media security configuration. Refer to the Avaya Aura Media Server Element
Manager example below for interoperability with Avaya Aura.

May 2017 Deploying Avaya Breeze 68


Comments on this document? infodev@avaya.com
Avaya Aura Media Server host name resolution

The SIPS settings are found under Home > System Configuration > Signaling Protocols > SIP >
General Settings.

The SRTP settings are found under Home > System Configuration > Media Processing > Media
Security.
If you set the Security Policy field to BEST EFFORT, you must select the following fields in the SIP
Settings section:
Enforce SIPS for security enforced calls
Require SIPS for best effort calls

Avaya Aura Media Server host name resolution


This section is applicable only to snap-ins using SIP to communicate with Avaya Aura Media
Server.
In cases where the Avaya Aura Media Server is retrieving announcements or storing recordings for
an Avaya Breeze snap-in via HTTPS, you must ensure that the Media Server can communicate
with the Avaya Breeze server. You can accomplish this in several ways:
Map the FQDN of each Avaya Breeze server on your DNS server.
Enter the IP Address and Hostname of each Avaya Breeze server in the Avaya Aura Media
Server Network Settings.

May 2017 Deploying Avaya Breeze 69


Comments on this document? infodev@avaya.com
Avaya Aura Media Server Deployment

Disable host name verification in the Avaya Aura Media Server Network Settings. This is a
less secure option. It is acceptable for a lab deployment, but is not recommended for a
production environment.
Related links
Configuring Avaya Aura Media Server name resolution (alternative 1) on page 70
Configuring connection security options (alternative 2) on page 70

Configuring Avaya Aura Media Server name resolution


(alternative 1)
About this task
Complete this procedure to allow communication between the Avaya Aura Media Server and
required Avaya Breeze servers. You must enter a mapping for each Avaya Breeze that the Avaya
Aura Media Server accesses. The mappings are preserved in the local hosts file on the Avaya
Aura Media Server. This procedure is not necessary if you have mapped the FQDN of each Avaya
Breeze server on your DNS server or if you have disabled host name verification (alternative 2).
Procedure
1. On the Avaya Aura Media Server web console, click System Configuration > Network
Settings > Name Resolution.
2. Click Add.
3. Add the IP Address and the Hostname of an Avaya Breeze server.
The Hostname must match the one specified in the identity certificate for the Avaya Breeze
server.
IP Address is the management IP address of Avaya Breeze server.
4. Continue adding the IP Address and the Hostname for each additional Avaya Breeze
server.
5. Click Save.
Related links
Avaya Aura Media Server host name resolution on page 69

Configuring connection security options (alternative 2)


About this task
This procedure is recommended only in a lab deployment. It is not recommended for a production
environment. This procedure is not necessary if you have mapped the FQDN of each Avaya
Breeze server on your DNS server or if you have configured host name resolution (alternative 1).

May 2017 Deploying Avaya Breeze 70


Comments on this document? infodev@avaya.com
Avaya Aura Media Server trust configuration

Procedure
1. On the Avaya Aura Media Server web console, click System Configuration > Network
Settings > General Settings > Connection Security.
2. Clear Verify Host Name.
3. Click Save.
4. Restart the Avaya Aura Media Server for the changes to take effect.
5. On the web console, click System Status > Element Status.
6. Click Restart.
7. Click Confirm.
Related links
Avaya Aura Media Server host name resolution on page 69

Avaya Aura Media Server trust configuration


Only secure (https) connection is supported between Avaya Breeze and Avaya Aura Media
Server. The Subject Name or Subject Alternate Name in the certificate must be valid, and the
security options for the connection must be appropriately configured. Refer to the following sections
of the Implementing and Administering Avaya Media Server document:
Configuring connection security options
Security configuration

Exporting an Avaya Aura Media Server certificate


Procedure
1. On the System Manager web console, in Services, click Inventory > Manage Elements.
2. Select an Avaya Aura Media Server instance.
3. Click More Actions > Configure Trusted Certificates.
4. Select the appropriate certificate to export.
5. Click Export.

May 2017 Deploying Avaya Breeze 71


Comments on this document? infodev@avaya.com
Avaya Aura Media Server Deployment

Enabling and configuring digit relay settings


About this task
Avaya Aura MS uses digit relay settings and the order of the enabled relay methods when
negotiating digit relay with a client endpoint. These settings apply for inbound or outbound sessions.
Avaya Aura MS also supports in-band DTMF. The system defaults to this option if no other option
is configured or negotiated by Avaya Aura MS. The preferred method of digit transmission is RFC
2833.
Perform the following procedure to enable and configure the digit relay support on Avaya Aura MS.
Procedure
1. Navigate to EM > System Configuration > Media Processing > Digit Relay (DTMF).
2. On the Digit Relay (DTMF) page, select one or more methods from the Available list.
3. Click Add to move the methods to the Enabled list.
4. To change the priority rank of a method within the Enabled list, select a method and use the
Up or Down buttons to move it within the list.
5. Choose the required payload type option:
In most cases, a dynamic payload type is highly desirable. The default selection of Assign
RFC 2833 Format Type Dynamically will suffice.
When dealing with older endpoints or gateways, a fixed payload type may be required.
Select Specify Type. In the Specify Type field, enter a value from 100 to 127 to use in
the payload type field of the RTP header when transmitting RFC2833 encoded digits.
The recommended value varies by endpoint. 101 is the preferred value for certain
endpoints or gateways.

May 2017 Deploying Avaya Breeze 72


Comments on this document? infodev@avaya.com
Enabling and configuring digit relay settings

6. Click Save.

May 2017 Deploying Avaya Breeze 73


Comments on this document? infodev@avaya.com
Chapter 8: Certificate administration

Trust and Identify Certificate administration


You can administer both Trust Certificates and Identity Certificates for Avaya Breeze.
Identity Certificates are administered individually for Avaya Breeze clusters. Five default Identity
Certificates are generated as part of the Avaya Breeze OVA deployment process. You can replace
a default certificate with a certificate from a well-known certificate authority.
The Security Module (ASSET) HTTP certificate is the one that is visible to applications and
endpoints. If using HTTPS with hostname validation checks, you will need to replace the default
ASSET HTTP certificate. When replacing the certificate, edit the Subject Alternative Name field to
include both the FQDN assigned to the Avaya Breeze server and the FQDN assigned to the
cluster.
For instructions for replacing a certificate and changing the Subject Alternative Name (SAN), see
Replacing an identity certificate on page 77.
Entities that access Avaya Breeze via HTTPS must be able to resolve the Common Name (CN) or
SAN fields in the certificate with the FQDN of the Avaya Breeze node. If you use the default
certificates generated by System Manager, the CN in the certificate will look like:
<serverHostName>-sm100.<domain>, where host and domain are those specified when you
installed theAvaya Breeze server (or specified during CEnetSetup). If a different certificate has
been installed, the FQDN is whatever was specified in CN and/or SAN when generating that
certificate.
To view the Security Module HTTPS Certificate details, including the CN, for the Avaya Breeze
server, see Viewing Identity Certificate details on page 75.
To resolve the certificate CN or SAN fields with the FQDN, take one of the following actions:
Enter the FQDN of each Avaya Breeze node in your DNS server.
Populate the host file of each entity with the FQDN of each Avaya Breeze node that it will
access.
Note:
You can edit the Avaya Aura Media Server host files through the Avaya Aura MS
Element Manager. For more information, see Configuring Avaya Aura Media Server name
resolution (alternative 1) on page 70.
You can administer the Trust Certificates for each Avaya Breeze cluster or a single Trust
Certificate can be assigned simultaneously to all the clusters.

May 2017 Deploying Avaya Breeze 74


Comments on this document? infodev@avaya.com
Viewing Identity Certificate details

For more information about Trust and Identify Certificates, click Help on the System Manager
interface and select Managing Certificates. For detailed information about migrating from the
Avaya Certificate Authority to a Well-known Certificate Authority, see Avaya Aura Certificate
Migration.

Viewing Identity Certificate details


Procedure
1. On System Manager, in Services, click Inventory > Manage Elements.
2. Click the checkbox in front of the Avaya Breeze server.
3. From the More Actions menu, select Configure Identity Certificates.
4. In the list of certificate, click the Security Module HTTPS certificate.
Certificate Details for the Security Module HTTPS certificate display below the certificate list.
5. To exit the screen, click Done.

Adding a Trust Certificate to all Avaya Breeze servers in


a cluster
Before you begin
Certificates that you intend to add as trusted certificates must be accessible to System Manager.
Procedure
1. On the System Manager web console, click Elements > Avaya Breeze.
2. In the navigation pane, click Cluster Administration.
3. Select the cluster to which you want to administer the trusted certificates.
4. Click Certificate Management > Install Trust Certificate (All Avaya Breeze Instances)
to download the trusted certificate for all the servers in the cluster.
Note:
The Trust Certificate that you are about to add will apply to all the Avaya Breeze
servers assigned to the cluster.
5. From the Select Store Type to install trusted certificate menu, select the appropriate
store type.
6. Click Browse to the location of your Trust Certificate, and select the certificate.
7. Click Retrieve Certificate, and review the details of the Trusted Certificate.

May 2017 Deploying Avaya Breeze 75


Comments on this document? infodev@avaya.com
Certificate administration

8. Click Commit .

Adding trusted certificates


About this task
Using one of the described methods, import the certificates that you want to add as trusted
certificate in the trust store of the element.
Procedure
1. On the System Manager web console, click Services > Inventory.
2. In the left navigation pane, click Manage Elements.
3. On the Manage Elements page, select an element, and click More Actions > Manage
Trusted Certificates.
4. On the Trusted Certificates page, click Add.

5. On the Add Trusted Certificates page, in Select Store Type to add trusted certificate,
select a store type or select All if you are unsure of the store type.
6. To import certificates from a file, do the following:
a. Click Import from file.
b. Type the file name or click Browse to select a file.
Note:
System Manager validates the file type. If you provide an invalid file type, the
system displays an error message.
c. Click Retrieve Certificate.

May 2017 Deploying Avaya Breeze 76


Comments on this document? infodev@avaya.com
Replacing an identity certificate

7. To import certificates in the PEM format, do the following:


a. Locate the PEM certificate.
b. Open the certificate in the Notepad application.
c. Select and copy the contents in the file.
d. On the Add Trusted Certificates page, click Import as PEM certificate.
e. Paste the contents from the PEM file in the text box provided on the Add Trusted
Certificates page.
8. To import certificates from existing certificates, do the following:
a. Click Import from existing certificates.
b. In the Global Trusted Certificate section, select a certificate.
9. To import certificates by using TLS, do the following:
a. Click Import using TLS.
b. In IP Address, type the IP address of the computer.
c. In Port, type the port of the computer.
d. Click Retrieve Certificate.
10. Click Commit.
11. Restart the JBoss service on System Manager.

Replacing an identity certificate


Procedure
1. On the System Manager web console, click Services > Inventory.
2. In the left navigation pane, click Manage Elements.
3. On the Manage Elements page, select an element and click More Actions > Manage
Identity Certificates.
4. On the Manage Identity Certificates page, select the certificate that you want to replace.
5. Click Replace.
The system displays the Replace Identity Certificate page.
6. Click Replace this Certificate with Internal CA Signed Certificate, and do the following:
a. Select the common name (CN) check box and type the common name that is defined in
the existing certificate.
b. Select the key algorithm and key size from the respective fields.
System Manager uses the SHA2 algorithm for generating certificates.

May 2017 Deploying Avaya Breeze 77


Comments on this document? infodev@avaya.com
Certificate administration

c. (Optional) In Subject Alternative Name, select the relevant options and enter the
details.
d. (Optional) In OtherName, type the other name for the certificate signing request.
e. To replace the identity certificate with the internal CA signed certificate, click Commit.
7. Click Import third party certificate, and do the following:
a. In the Please select a file field, choose the file from your local computer.
b. In the Password field, type the password.
c. Click Retrieve Certificate.
The Certificate Details section displays the details of the certificate.
d. Review the details of the uploaded certificate.
e. To replace the certificate with the third-party certificate that you imported, click Commit.
8. Click Generate Certificate Signing Request (CSR) for third party certificate, and do the
following:
a. Select the common name (CN) check box and type the common name that is defined in
the existing certificate.
b. Select the key algorithm and key size from the respective fields.
System Manager uses the SHA2 algorithm for generating certificates.
c. (Optional) In Subject Alternative Name, select the relevant options and enter the
details.
d. In OtherName, type the other name for the certificate signing request.
e. Click Generate CSR.
f. Ensure that the downloaded CSR is third-party signed.
g. Import the signed certificate using the Import third party certificate option.
9. For the newly generated certificates to take effect, restart JBoss on System Manager.

May 2017 Deploying Avaya Breeze 78


Comments on this document? infodev@avaya.com
Chapter 9: High Availability Administration

Avaya Breeze high availability administration


High availability is achieved for Avaya Breeze by sending traffic to a cluster with multiple servers.
Load balancing determines what percentage of traffic each server will receive. Clusters are auto
configured with the datagrid and the HTTP load balancing functionality. The SIP load balancers are
not configured in these servers and clusters. Therefore, for SIP high availability, you must manually
configure load balancing. You must enable HTTP load balancing for a cluster; by default load
balancing is not enabled.

SIP high availability


SIP high availability is possible with Avaya Breeze by administering a cluster of Avaya Breeze
servers and connecting each member of the cluster to each Session Manager. You can then route
users of a service to the cluster rather than to a specific Avaya Breeze server so it is likely that at
least one will be available.
When you administer a Avaya Breeze cluster, each Avaya Breeze server is entered in a table of
local host names, along with a priority and weight for each.
When the cluster database is enabled with three or more servers, assign weights to servers for
load balancing in the recommended percentages. See Local load balancing
recommendation on page 83.
In a geographical redundant scenario, with two clusters located in two different geographical
locations, the servers appear multiple times in the table with different host names and different
weights. The system must be appropriately sized such that one cluster is able to assume the
traffic for a failed cluster. To equally distribute traffic among servers with the same Priority,
assign an equal weight to each server. When the cluster database is enabled in this scenario,
additional considerations are needed. See Geo-redundancy example configuration on
page 84.
The cluster load balancer is only used for HTTP, not for SIP. Session Manager acts as the load
balancer for SIP traffic. In order to enable Session Manager to fulfill this function, an FQDN must be
populated in the Local Host Name Resolution table, and each Avaya Breeze Security IP Address
must be associated with this FQDN. This FQDN must be used when creating the FQDN SIP Entity
in the following procedure.

May 2017 Deploying Avaya Breeze 79


Comments on this document? infodev@avaya.com
High Availability Administration

Creating an FQDN SIP Entity


Before you begin
To complete this task, you will need the FQDN of the Avaya Breeze cluster. In addition to creating
this FQDN SIP Entity for the cluster, you must also create a separate SIP entity for each Avaya
Breeze instance in the cluster.
Procedure
1. On System Manager in Elements click Routing > SIP Entities and click New.
2. In the Name field, type the name of your SIP Entity.
3. In the FQDN or IP Address field, type the FQDN of your Avaya Breeze cluster.

Caution:
Do not use the Load Balancer IP Address for the FQDN SIP Entity. The cluster load
balancer is only used for HTTP traffic, not SIP traffic.
4. In the Type field select Other.
5. Click Commit to save your changes.
Related links
Administering an Avaya Breeze SIP Entity on page 52

Creating the FQDN Entity Link


Before you begin
Create the FQDN SIP Entity.
About this task
For a Avaya Breeze cluster, create a single Entity Link for the FQDN SIP Entity. You must create
an Entity Link for each Avaya Breeze server in the cluster using the high availability configuration.
Do not use the default port 5061 on Session Manager for the entity link between the cluster and the
Session Manager server.
Note:
TLS is the recommended protocol for production environments since it is secure and encrypted.
Should the need arise to take a network trace between Session Manager and Avaya Breeze,
change the protocol to TCP. If this is a production environment, change the protocol back to
TLS as soon as the trace is complete.
Procedure
1. On System Manager in Elements, click Routing > Entity Links.
2. Click New.
3. In the Name field, type a name for the SIP Entity Link.
4. In the SIP Entity 1 field, select the Session Manager.
5. In the Protocol field, select the desired protocol.

May 2017 Deploying Avaya Breeze 80


Comments on this document? infodev@avaya.com
Avaya Breeze high availability administration

6. In the Port field, enter a unique port number. Do not use the Session Manager port number
that is administered for the Entity Link connecting Session Manager and Avaya Breeze.
See Administering the Avaya Breeze Entity Link on page 53 for information about the
Session Manager and Avaya Breeze Entity Link.
For example, if you used 5061 as the Session Manager port in the entity link administration
representing your Session Manager to your specific Avaya Breeze server, use a different
port value here, like 5091. This represents the Session Manager side of the High Availability
FQDN entity link.

Caution:
The consequences for using a non-unique port can be severe. If you use the same port
number, the system will generate the error message 500 Server Internal Error
(Indeterminate originating entity). This error causes Session Manager to try to alternate
route to another server in the cluster.
7. In the SIP Entity 2 field, select the Avaya Breeze High Availability FQDN SIP Entity that
you created.
8. In the Port field, enter the same port that you specified in Administering the Avaya Breeze
Entity Link on page 53.
For example if you used 5061 as the Avaya Breeze port of the Session Manager to your
specific Avaya Breeze entity link, then use 5061 as the Avaya Breeze port in the High
Availability FQDN entity link as well.
9. Click Commit to save your changes.
10. In the System Manager web console, click Elements > Routing > SIP Entities.
11. Select the Session Manager SIP entity that you created a link to and click Edit.
Repeat these steps for each SIP entity that you created a link to.
12. Under Listen Port, click Add.
13. Enter the port number and protocol that you selected for the entity link above.
14. From the Default Domain, select the root domain used for call routing.
15. Click Commit.

Creating an Application and Application Sequence for high availability


By administering the Avaya Breeze cluster as an application you can add it to an Application
Sequence.
About this task
By administering the Avaya Breeze cluster as an application you can add it to an Application
Sequence. You can then add this Application Sequence to the Implicit User Table so that called and
caller application requests route to a cluster of Avaya Breeze servers rather than an individual
Avaya Breeze server.

May 2017 Deploying Avaya Breeze 81


Comments on this document? infodev@avaya.com
High Availability Administration

Procedure
1. On System Manager in Elements click Session Manager > Application Configuration >
Applications, and click New.
2. Type a name for the Application.
3. For the SIP Entity, select the Avaya Breeze cluster.
4. To save your changes, click Commit.
5. On the Session Manager menu under Application Configuration click Application
Sequences and click New.
6. Type the name of your new Application Sequence.
7. In the list of Available Applications click + by the Avaya Breeze Application that you
created.
8. Uncheck the Mandatory box if necessary.
Session Manager stops processing a call if it cannot reach a mandatory application.
9. To save your Application Sequence, click Commit.

Determining active and standby database servers


About this task
For load balancing configuration, you must be able to identify your active and standby cluster
database servers. Use this information to determine what weight you will specify for each server for
load balancing.
Procedure
1. On the System Manager web console, click Elements > Avaya Breeze.
2. In the navigation pane, click Cluster Administration.
3. Click Show in front of the cluster you are administering to see the servers in the cluster.

4. In the Cluster Database column, identify the active and standby database servers.
Active is the primary server
Standby is the secondary server
All additional servers in the cluster are marked as Idle

May 2017 Deploying Avaya Breeze 82


Comments on this document? infodev@avaya.com
Avaya Breeze high availability administration

Resolving the local host name for high availability


Procedure
1. Verify that at least one entity link has been defined for each FQDN and Transport entry.
2. On the home page of the System Manager Web Console, in Elements, click Session
Manager > Network Configuration > Local Host Name Resolution.
3. Click New.
4. Enter the host information on the New Local Host Name Entries page. You can enter a
maximum of ten host names.
a. For the Host Name (FQDN), enter the Fully Qualified Domain Name or IP address of
the host. The host name entries override the information provided by DNS.
b. Enter the IP Address that the host name is mapped to. A host can be mapped to more
than one IP addresses and each of these mappings are a separate entry.
c. Enter the Port that the host should use for routing using the particular IP address.
d. Enter a value for the Priority. If there are multiple IP address entries for a given host,
Session Manager tries the administered IP addresses in the order of the priority.
e. Enter a value for the Weight. If there are multiple IP address entries for a given host,
and if some entries have the same priority, then for each priority level, the Session
Manager chooses a host according to the specified weights.
For systems with the cluster database enabled, see the local load balancing
recommendations. For systems with geographical redundancy, see the geo-redundancy
example configuration for Priority and Weight suggestions.
f. Select a Transport. The default is TLS.
5. Click Commit.
Related links
Local load balancing recommendation on page 83
Geo-redundancy load balancing example configuration on page 84

Local load balancing recommendation


When the cluster database is enabled, use the following table to determine the load balancing
weight to assign to each server in the cluster. Use this table only for local load balancing, not for
geographic redundancy clusters.
Number of servers in the 2 3 4 5
cluster
Initial primary database server 50 25 16 12
Initial backup database server 50 25 16 13
Server 3 50 34 25
Server 4 34 25
Server 5 25

May 2017 Deploying Avaya Breeze 83


Comments on this document? infodev@avaya.com
High Availability Administration

Geo-redundancy load balancing example configuration


The following is an example of cluster provisioning for a North American cluster and a European
cluster that are providing geo-redundancy for each other.
Avaya Breeze high availability is not call preserving but it is connection preserving. This example
assumes that the Cluster Database and Load Balancer are running on these clusters and that they
are assigned to the first two nodes ((NA-CE1-IP-Addr, NA-CE2-Addr for the North America cluster
and EU-CE1-IP-Addr, EU-CE2-IP-Addr for the European cluster).
Host Name IP Address Priority Weight
NA-CE.example.com <NA-CE1-IP-Addr> 1 25
NA-CE.example.com <NA-CE2-IP-Addr> 1 25
NA-CE.example.com <NA-CE3-IP-Addr> 1 50
NA-CE.example.com <EU-CE1-IP-Addr> 2 25
NA-CE.example.com <EU-CE2-IP-Addr> 2 25
NA-CE.example.com <EU-CE3-IP-Addr> 2 50
EU-CE.example.com <EU-CE1-IP-Addr> 1 25
EU-CE.example.com <EU-CE2-IP-Addr> 1 25
EU-CE.example.com <EU-CE3-IP-Addr> 1 50
EU-CE.example.com <NA-CE1-IP-Addr> 2 25
EU-CE.example.com <NA-CE2-IP-Addr> 2 25
EU-CE.example.com <NA-CE3-IP-Addr> 2 50

HTTP high availability

HTTP load balancing in an Avaya Breeze cluster


Enable load balancing for a cluster if you want to scale the HTTP services without targeting a
particular Avaya Breeze server. All the requests are sent to the cluster IP address. When you
enable load balancing, two Avaya Breeze servers are chosen as the active and standby load
balancing servers. The active load balancer distributes the HTTP requests to all the other servers in
the cluster in a round robin fashion.
The following cluster attributes must be configured for HTTP load balancing:
Name Description
HTTP Load Balancer backend server max failure The maximum timeout period of the failure response
response timeout period (seconds) of the HTTP Load Balancer backend server. The
default value is 15.
Table continues

May 2017 Deploying Avaya Breeze 84


Comments on this document? infodev@avaya.com
HTTP high availability

Name Description
Max number of failure responses from HTTP The maximum number of failure responses from the
Load Balancer backend server HTTP Load Balancer backend server. The default
value is 2.
Network connection timeout to HTTP Load The network connection timeout period from the
Balancer backend server (seconds) HTTP Load Balancer backend server. The default
value is 10.

Load balancing validations


The following are the validations when you enable load balancing in a cluster:
Load balancing is not supported in a single server cluster.
By default the load balancing check box is not selected.
For load balancing to function, the cluster must have two Avaya Breeze servers that have the
SIP Entity IP addresses in the same subnet as the cluster IP address. The active server starts
a network alias using the cluster IP address. If the active server is down, the standby starts a
network alias with the cluster IP address. The standby server takes over as the active load
balancer.
With load balancing, you cannot remove the active or the standby Avaya Breeze server from
the cluster unless another server in the cluster meets the subnet validation.
Session affinity
Session affinity ensures that all the requests from the same client are directed to the same back end
Avaya Breeze server in a cluster. Session affinity is mandatory for snap-ins like the WebRTC
Snap-in.
To enable session affinity, select the Is session affinity cluster attribute.
Use the Trusted addresses for converting to use X-Real-IP for session affinity cluster attribute to
enter trusted addresses that are known to send correct replacement addresses so thatAvaya
Breeze load balancer can use the real client IP when an HTTP request traverses through reverse
proxies like Avaya Session Border Controller for Enterprise. The header which is used to identify the
real client IP address is X-Real-IP
Multi-cluster geo-redundancy
With multi-cluster geo-redundancy, do not use round-robin for load balancing HTTP requests.
Rather use fixed list (rrset-order fixed), not the default. Each location should have its own DNS
server, and each DNS server should have A record entries with the name in different orders, putting
the more local cluster first.

Enabling HTTP load balancing in an Avaya Breeze cluster


Before you begin
When you select the load balancing option during Edit operation, you must first change the state of
the cluster to Deny New Service. After enabling the load balancing functionality, you can change
the state of the cluster back to Accept New Service.

May 2017 Deploying Avaya Breeze 85


Comments on this document? infodev@avaya.com
High Availability Administration

Note:
You need not enable load balancing if you use an external load balancer or if you are running a
single server cluster.
Procedure
1. On the System Manager web console, click Elements > Avaya Breeze.
2. In the navigation pane, click Cluster Administration.
3. If you are enabling load balancing for an existing cluster, on the Cluster Administration page
complete the following actions:
a. Click the checkbox in front of the cluster.
b. From the Cluster State drop-down menu, select Deny New Service.
c. Verify that the Cluster State column for the cluster changed to Denying.
d. Click Edit.
4. If you are creating a new cluster with load balancing enabled, on the Cluster Administration
page complete the following actions:
a. Click New.
b. Specify the attributes of the cluster.
5. In the Cluster Attributes section select the Is Load Balancer enabled check box to enable
load balancing.
6. In the Basic section Cluster IP field, assign the IP address for the cluster.
Note:
The Cluster IP address used for load balancing must be unique. That is, this IP address
must not match the Security Module IP address or the management IP address. The
Security Module IP address must be on the same subnet as the Avaya Breeze Cluster
IP address.
7. Click Commit.
Two Avaya Breeze servers are automatically designated as active and standby to perform
the load balancing functionality.
8. On the Cluster Administration page, from the Cluster State drop-down menu, select Accept
New Service to put the cluster in service.

May 2017 Deploying Avaya Breeze 86


Comments on this document? infodev@avaya.com
Chapter 10: Communication Manager
Administration

Communication Manager call routing


Calls to or from non-SIP endpoints on Communication Manager over ISDN trunks are not routed by
default through Session Manager and so do not have access to Avaya Breeze Call Intercept
services. However, you can administer Communication Manager to route Public Switched
Telephone Network (PSTN) ISDN calls through Session Manager for Avaya Breeze processing.
This procedure is necessary only when Call Intercept services are used on calls between stations
and ISDN trunks on the same Communication Manager instance.
For detailed instructions for any of the procedures described in this section, see your
Communication Manager documentation.

Routing inbound ISDN calls


To route incoming Communication Manager ISDN PSTN calls to Avaya Breeze for services, divert
all inbound calls to Session Manager using already configured SIP trunks. In this way the calls route
to Session Manager and from there to Avaya Breeze.
Before you begin
To complete this task you must have:
An administered Automatic Alternate Routing (AAR) and Feature Access Code (FAC)
A SIP trunk group between Communication Manager and Session Manager
A route pattern administered to route calls to this SIP trunk group
Procedure
1. Using the Incoming Call Handling Treatment table, prepend your AAR FAC to the received
digits of your ISDN trunk group. This will route calls from your ISDN trunk group to AAR
treatment.
2. Use AAR Analysis to route ISDN trunk group inbound calls to a route pattern that routes calls
to your SIP trunk group.

May 2017 Deploying Avaya Breeze 87


Comments on this document? infodev@avaya.com
Communication Manager Administration

Routing outbound ISDN calls


Route outbound calls to Session Manager instead of routing them to the PSTN ISDN trunk. Calls
route to Session Manager and from there to Avaya Breeze. Then route these calls back to the
Communication Manager ISDN trunk group with digits added to prevent the calls from looping back
to Session Manager.
Before you begin
To complete this task you must have:
An administered Automatic Route Selection (ARS) and Feature Access Code (FAC)
A route pattern administered to route calls to your SIP trunk group
A route pattern administered to route calls to your ISDN trunk group
About this task
Procedure
1. Set up your ARS Digit Analysis so that all outbound ISDN calls that dont route to a specific
Dialed String use a Route Pattern that directs them to your SIP trunk group. (This can be
done using a Dialed String value of x.)
2. In Session Manager create a Digit Conversion Adapter for the Communication Manager
entity . In the Insert Digits field, add the ARS FAC and steering digits, (999 for example)
that will not be confused with an area code.
3. In Communication Manager set up your AAR Digit Analysis so that calls with a dialed string
of your administered steering digits (999 for example) are directed to a Route Pattern that
directs calls to the ISDN trunk group.
4. Edit the Route Pattern for your ISDN trunk group to remove the steering digits you added.

May 2017 Deploying Avaya Breeze 88


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

Documentation
See the following related documents at http://support.avaya.com.
Title Description Audience
Understanding
Avaya Breeze Overview and Describes the Avaya Breeze from a Sales engineers
Specification functional view. Includes a high-level
Programmers
description of the platform as well as
topology diagrams, customer requirements, System
and design considerations. administrators
Services and support
personnel
Avaya Aura System Manager Describes tested product characteristics and Sales engineers
Overview and Specification capabilities, including product overview and
Programmers
feature descriptions, interoperability,
performance specifications, security, and System
licensing requirements. administrators
Services and support
personnel
Implementing
Deploying Avaya Breeze Describes the procedures to deploy and Services and support
administer Avaya Breeze. Also contains personnel
the procedures to deploy, administer, and
System
license an Avaya Media Server for use with
administrators
Avaya Breeze.
Deploying Zang-Enabled Avaya Describes the procedures to deploy and Services and support
Breeze. administer Zang-enabled Avaya Breeze. personnel
System
administrators
Upgrading Avaya Breeze Describes the procedures to upgrade Avaya Services and support
Breeze. personnel
Implementing and Administering Provides the procedures to install, configure, System
Avaya Aura Media Server use, and troubleshoot Avaya Aura Media administrators
Server.
Table continues

May 2017 Deploying Avaya Breeze 89


Comments on this document? infodev@avaya.com
Resources

Title Description Audience


Services and support
personnel
Deploying and Updating Avaya Aura Provides installation, configuration and System
Media Server Appliance administration information for Avaya Aura administrators
Media Server when it is installed on
Services and support
customer-provided servers.
personnel
Deploying Avaya Aura System Describes how to deploy Avaya Aura System
Manager System Manager in a virtualized administrators
environment using VMware.
Services and support
personnel
Avaya Aura System Manager Quick reference to using Solution System
Solution Deployment Manager Job- Deployment Manager. administrators
Aid
Services and support
personnel
Migrating and Installing Avaya Checklists and procedures for installing, System
Appliance Virtualization Platform migrating, configuring, administering, and administrators
troubleshooting Avaya Appliance
Services and support
Virtualization Platform.
personnel
Deploying Avaya Session Border Procedures for installing and configuring System
Controller for Enterprise Avaya Aura Session Border Controller. administrators
Services and support
personnel
Customizing
Getting Started with the Avaya Describes the procedures to install and Programmers
Breeze SDK configure the Eclipse IDE, Apache Maven,
and the Avaya Breeze SDK.
Avaya Breeze Snap-in Describes the key concepts needed to Programmers
Development Guide develop the different types of Avaya
Breeze snap-ins.
Avaya Breeze FAQ and Provides snap-in troubleshooting Programmers
Troubleshooting for Snap-in procedures. Answers questions such as
Developers Why did my SDK installation fail?
Avaya Breeze API Javadocs Overview and description of the API classes Programmers
and uses.
Supporting
Maintaining and Troubleshooting Contains the list of alarms and errors related Services and support
Avaya Breeze to Avaya Breeze and the procedures to personnel
troubleshoot and fix the problems.
System
administrators
Troubleshooting Avaya Aura Contains information for troubleshooting Services and support
Session Manager Avaya Aura Session Manager, alarm code personnel
Table continues

May 2017 Deploying Avaya Breeze 90


Comments on this document? infodev@avaya.com
Documentation

Title Description Audience


descriptions, and procedures for resolving
alarms.
Troubleshooting Avaya Aura Provides procedures for troubleshooting Services and support
System Manager errors for System Manager and the Avaya personnel
Aura applications that System Manager
supports.
Using
Quick Start to deploying the Walks through the steps to install, configure Programmers
HelloWorld Snap-in and test an Avaya Breeze snap-in service,
System
specifically the HelloWorld call-intercept
administrators
snap-in.
Administering Avaya Breeze Provides the procedures to administer and System
configure Avaya Breeze and snap-ins. Administrators
Services and Support
personnel
Administering Avaya Aura Session Describes the routing administration and System
Manager management of Avaya Aura Session Administrators
Manager instances.
Services and support
personnel
Administering Avaya Aura System Describes the administration and System
Manager management of Avaya Aura System Administrators
Manager.
Services and support
personnel
Administering Avaya Session Border Procedures for administering Avaya Aura System
Controller for Enterprise Session Border Controller. Administrators
Services and support
personnel

Finding documents on the Avaya Support website


Procedure
1. Navigate to http://support.avaya.com/.
2. At the top of the screen, type your username and password and click Login.
3. Click Support by Product > Documents.
4. In Enter your Product Here, type the product name and then select the product from the
list.
5. In Choose Release, select an appropriate release number.
6. In the Content Type filter, click a document type, or click Select All to see a list of all
available documents.

May 2017 Deploying Avaya Breeze 91


Comments on this document? infodev@avaya.com
Resources

For example, for user guides, click User Guides in the Content Type filter. The list displays
the documents only from the selected category.
7. Click Enter.

Training
The following courses are available on the Avaya Learning website at http://www.avaya-
learning.com. After logging in to the website, enter the course code or the course title in the Search
field, and click Go to search for the course.
Course code Course title
2016V Fundamentals of Avaya Breeze
3002V Design Avaya Breeze
7016W Avaya Breeze Implementation and Support
5105 Avaya Breeze Implementation and Maintenance Test
2024V Programming Avaya Breeze Snap-ins using Java SDK Bootcamp
2025V Creating Avaya Breeze Snap-ins using Engagement Designer Bootcamp
2035V Advanced Engagement Designer

Avaya Breeze videos


Avaya Breeze provides the following videos to help in the development and deployment of snap-
ins. Access these videos at http://www.avaya.com/breezedeveloper.
Title Audience

Getting Started with the Avaya Breeze SDK: Programmers
Windows
Getting Started with the Avaya Breeze SDK: Linux Programmers
Creating Your First Service Part 1 Programmers
Creating Your First Service Part 2 Programmers
Server Installation and Configuration with vCenter System Administrators, Services and Support
personnel
Server Installation and Configuration without vCenter System Administrators, Services and Support
personnel
Service Installation, Configuration, and Test Programmers
Understanding the Hello Sample Service Programmers
Table continues

May 2017 Deploying Avaya Breeze 92


Comments on this document? infodev@avaya.com
Support

Understanding the Multi-Channel Broadcast Sample Programmers


Service
Understanding the Whitelist Sample Service Programmers

Support
Platform support
Go to the Avaya Support website at www.avaya.com/Support for the most up-to-date product
documentation, and product notices. Also search for release notes, service packs, and patches. 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.
Developer support
Go to the Avaya DevConnect website at http://www.avaya.com/breezedeveloper to access the
Avaya Breeze API, SDK, sample applications, developer-oriented technical documentation, and
training materials.

May 2017 Deploying Avaya Breeze 93


Comments on this document? infodev@avaya.com
Appendix A: Avaya Aura Media Server
configuration for Avaya
Engagement Assistant Snap-
in

The procedures in this section are only required if Avaya Engagement Assistant Snap-in is one of
the deployed snap-ins. If a particular Avaya Breeze deployment does not include Avaya
Engagement Assistant Snap-in, these procedures may be omitted.

Administering an Avaya Aura Media Server SIP Entity


Before you begin
To complete this task, you need the FQDN of the Avaya Aura Media Server pool you set up when
configuring network connections.
Procedure
1. On System Manager navigate to Home > Elements > Routing > SIP Entities and click
New.
2. In the Name field, type the name of your SIP Entity. For example, type ams-cluster1.
3. In the FQDN or IP Address field, type the FQDN of your Avaya Aura Media Server pool.
Note:
If you leverage Avaya Aura Media Server high availability through the use of Local Host
Name resolution on System Manager, use the FQDN representing those Avaya Aura
Media Server set of servers here, or use the FQDN or IP address of a single Avaya
Aura Media Server server traffic interface.
4. In the Type field, select Media Server.
5. In the Location field, select an assigned location.
For

May 2017 Deploying Avaya Breeze 94


Comments on this document? infodev@avaya.com
Administering the Avaya Aura Media Server Entity Link

6. Click Commit to save your changes.

Administering the Avaya Aura Media Server Entity Link


Before you begin
Administer Avaya Aura Media Server as a SIP Entity.
About this task
Create an Entity Link to connect Session Manager to Avaya Aura Media Server.
Note:
You must use a common protocol for the entity links between Avaya Breeze and Session
Manager, and between Session Manager and Avaya Aura Media Server. If you have multiple
Avaya Aura Media Servers with different protocols, configure two Entity Links between Avaya
Breeze and Session Manager for TLS and TCP.
Note:
TLS is the recommended protocol for production environments since it is secure and encrypted.
Should the need arise to take a network trace between Session Manager and Avaya Aura
Media Server, change the protocol to TCP. If this is a production environment, change the
protocol back to TLS as soon as the trace is complete.
Procedure
1. On System Manager navigate to Home > Elements > Routing > Entity Links and click
New.
2. In the Name field, type a name for the Avaya Aura Media Server SIP Entity Link.
3. For the SIP Entity 1 select the Session Manager.
4. For the SIP Entity 2 select the Avaya Aura Media Server SIP Entity that you created.
5. Press Commit to save your changes.
Next steps
Create a Routing Pattern for Avaya Aura Media Server.

Creating the Avaya Aura Media Server Routing Pattern


About this task
This section is applicable only to snap-ins using SIP to communicate with Avaya Aura Media
Server.

May 2017 Deploying Avaya Breeze 95


Comments on this document? infodev@avaya.com
Avaya Aura Media Server configuration for Avaya Engagement Assistant Snap-in

Procedure
1. On System Manager, click Elements > Routing > Routing Policies .
2. Click New.
3. Type a Name for the Routing Policy.
4. From the SIP Entity as Destination field, click Select.
5. Select the Avaya Aura Media Server SIP Entity that you created.
Select the Local Host Name FQDN SIP Entity if you are using High Availability for the Avaya
Aura Media Server routing.
6. Click Commit .
7. Navigate to Home > Elements > Routing > Regular Expressions and click New.
8. In the Pattern field, type ce-msml@<sip-domain>.*
This sip-domain value must match:
The SIP domain that you entered in the Home > Elements > Routing > Domains page.
The default SIP domain that you entered on the Avaya Breeze Cluster Administration
page.
9. Click Commit.
Next steps
Verify the Avaya Aura Media Server entity link with Session Manager.

Verifying the Avaya Aura Media Server Entity Link


connection
About this task
Complete this task to verify that Session Manager can connect with Avaya Aura Media Server
using the SIP Entity Link. To do this you must make a couple of minor changes to the Avaya Aura
Media Server SIP entity, and the administered Session Manager instance.
Procedure
1. Enable SIP Link Monitoring on the Avaya Aura Media Server SIP Entity.
a. On System Manager navigate to Home > Elements > Routing > SIP Entities.
b. Select the Avaya Aura Media Server SIP Entity.
c. Click Edit.
d. From the SIP Link Monitoring drop-down menu select Link Monitoring Enabled.
e. Click Commit.

May 2017 Deploying Avaya Breeze 96


Comments on this document? infodev@avaya.com
Configuring Avaya Aura Media Server Host Name Resolution

2. Modify the Session Manager Instance.


a. Navigate to Home > Elements > Session Manager > Session Manager
Administration.
b. Select the Session Manager Instance that you linked to Avaya Aura Media Server.
Click Edit.
c. Check Enable Monitoring in the Monitoring section.
d. Click Commit.
3. Test the Entity Link.
a. Navigate to Home > Elements > Session Manager > System Status > SIP Entity
Monitoring.
b. Click the name of the Session Manager Instance that you linked to Avaya Aura Media
Server.
The system displays a list with the status of all the Entity Links for the selected Session
Manager.
c. Located the Avaya Aura Media Server SIP Entity and check the Conn. Status column.
If you see UP, congratulations! You have successfully configured your Avaya Aura
Media Server link.
If you do not see UP, for additional information, see Avaya Breeze FAQ and
Troubleshooting for Service Developers.

Configuring Avaya Aura Media Server Host Name


Resolution
About this task
In this task you are creating an FQDN Host Name for the pool of Avaya Aura Media Server servers
that will be used by Avaya Breeze. The pool can contain one to five servers. Add information for
each server as part of this task.
This section is applicable only to snap-ins using SIP to communicate with Avaya Aura Media
Server.
Procedure
1. In System Manager navigate to Home > Elements > Session Manager > Network
Configuration > Local Host Name Resolution and click New.
2. In New Local Host Name Entries, on each line type the Host Name (FQDN), IP Address
and Port for each Avaya Aura Media Server.
The Host Name is the same for each server in the pool.

May 2017 Deploying Avaya Breeze 97


Comments on this document? infodev@avaya.com
Avaya Aura Media Server configuration for Avaya Engagement Assistant Snap-in

3. Select a Priority, Weight, and Transport protocol for each server.


Priority: If there are multiple Avaya Media Servers for the single host, Session Manager
tries the administered IP addresses in the order of the priority.
Weight: If there are multiple Avaya Media Servers for the single host, and if some entries
have the same priority, then for each priority level, Session Manager picks a host
according to the specified weights.
4. Click Commit to save your changes.
For additional information about administering Local Host Names, see Administering Avaya
Aura Session Manager.

Administering Avaya Aura Media Server URI


About this task
Starting with Breeze 3.3 the configuration on this page is generally not needed. Only select snap-ins
require this page to be configured. Check the documentation and/or release notes for your snap-in
to confirm if this configuration is needed.
Procedure
1. On the System Manager web console, navigate to Elements > Avaya Breeze.
2. In the navigation pane, click Configuration > Avaya Aura Media Server.
The system displays the Avaya Aura Media Server Configuration page.
3. In the Avaya Aura Media Server URI field, enter the URI.

May 2017 Deploying Avaya Breeze 98


Comments on this document? infodev@avaya.com
Index
A Connectors
Eventing Framework .....................................................12
accepting new service ......................................................... 59 connector snap-ins ................................................................ 9
adding trusted certificates ....................................................76 conferencing ................................................................. 12
application for high availability ............................................. 81 email ............................................................................. 11
application sequence for high availability ............................ 81 overview ....................................................................... 11
assigning Scopia ...........................................................................12
media server .................................................................66 text messaging ............................................................. 11
automatic restart creating a new cluster ..........................................................57
virtual machine ....................................................... 46, 47 Creating multiple privileged user accounts .......................... 49
Avaya Aura Media Server customer configuration information ......................................20
adding the System Manager IP address ...................... 67 customer password ..............................................................48
deployment checklist .................................................... 17
entity link .......................................................................95
host name resolution .................................................... 97
D
network connections .....................................................97 deploying using SDM ...........................................................43
routing pattern .............................................................. 95 deploying using vSphere client ............................................ 31
SIP entity ...................................................................... 94 Deploying using web-based client ....................................... 27
Avaya Aura Media Server licensing .....................................66 deployment checklist
Avaya Aura Media Server OVA deployment ........................65 Avaya Aura Media Server .............................................17
Avaya SIP CA certificate ......................................................74 Avaya Breeze ............................................................ 15
high availability ............................................................. 19
B diagram of components ....................................................... 13
documents ........................................................................... 89
back up ................................................................................ 59 downloading software .......................................................... 26

C E
call intercept snap-in description ..................................... 9, 10 EASG
call interrupt services call routing .........................................87 certificate information ................................................... 50
cancel .................................................................................. 61 disabling ....................................................................... 50
certificates ............................................................................15 enabling ........................................................................ 50
cluster site certificates ..............................................................51
accepting new service .................................................. 59 EASG site certificate ............................................................51
cluster database servers email .................................................................................... 11
identifying ..................................................................... 82 Enhanced Access Security Gateway ...................................50
clusters Enrollment Password status ................................................ 26
create ............................................................................57 entity link
load balancing .............................................................. 85 Avaya Aura Media Server .............................................95
new ............................................................................... 57 for high availability ........................................................ 80
view .............................................................................. 57 FQDN ........................................................................... 80
view attributes ...............................................................57 verification .................................................................... 55
collaboration bus-invoked snap-in description .....................10 Entity link
Communication Manager Avaya Breeze ............................................................ 53
call routing .................................................................... 87 Eventing ...............................................................................12
component diagram ............................................................. 13 Eventing Framework ............................................................12
conferencing ........................................................................ 12 exporting certificate ..............................................................71
configuration information ..................................................... 20
configuring
VM automatic restart .............................................. 46, 47
H
configuring connection security options ...............................70 high availability
connection security options administration ............................................................... 79
configuring .................................................................... 70

May 2017 Deploying Avaya Breeze 99


Comments on this document? infodev@avaya.com
Index

high availability (continued) network connections for Avaya Aura Media Server .............97
application .................................................................... 81 network latency ....................................................................24
application sequence ....................................................81
deployment checklist .................................................... 19
planning ........................................................................ 79
O
SIP ................................................................................79 outbound calling snap-in description ................................... 10
traffic distribution .......................................................... 79 Out of Band Management
host name resolution for high availability .............................83 Avaya Breeze ............................................................... 24
HTTP-invoked snap-in description .......................................10 OVA ..................................................................................... 15
HTTP load balancing ........................................................... 84 OVA deployment
Avaya Aura Media Server .............................................65
I Avaya Breeze ............................................................ 25
without vCenter .............................................................36
identify certificates ............................................................... 75 with SDM ...................................................................... 43
identity certificates ........................................................... 9, 74 with vCenter ..................................................................31
replacing ....................................................................... 77 with VMware vSphere client connected to ESXi host ...36
implicit users applications for SIP users .............................. 54 with VMware vSphere web client ..................................27
Import as PEM certificate .....................................................76
Import from existing certificates ........................................... 76
import from file ..................................................................... 76
P
importing trusted certificates from file .................................. 76 patch information ................................................................. 24
Import using TLS ................................................................. 76 patching the server .............................................................. 48
install ....................................................................................15 PLDS ................................................................................... 15
trust certificates ............................................................ 75 downloading software ...................................................26
ISDN call routing purge ....................................................................................61
inbound .........................................................................87
outbound .......................................................................88
ISDN trunk routing ............................................................... 87 R
related documentation ......................................................... 89
L release notes ....................................................................... 93
release notes for latest software patches ............................ 24
latency ................................................................................. 24 Reliable Eventing .................................................................61
latest software patches ........................................................ 24 Reliable Eventing group
license file install ..................................................................66 creating .........................................................................62
Avaya Aura Media Server .............................................67 Reliable Eventing status ...................................................... 63
Avaya Breeze ............................................................ 52 replacing identity certificates ................................................77
licensing ...............................................................................15 replication status verification ................................................56
licensing Avaya Aura Media Server .....................................66 REST ................................................................................... 65
load balancing ......................................................................85 restore ..................................................................................60
restrictions .................................................................... 84 routing pattern for Avaya Aura Media Server ...................... 95
validations .....................................................................84

S
M
Scopia ..................................................................................12
maintenance test SDM OVA deployment .........................................................43
broker ........................................................................... 64 security
management link verification ............................................... 56 identify certificates ........................................................ 74
Media Server trust certificates ...................................................... 74, 75
configuration ................................................................. 94 service packs ....................................................................... 93
multiple user accounts setting up load balancing ..................................................... 85
configure .......................................................................49 SIP entity ............................................................................. 15
create ............................................................................49 Avaya Aura Media Server .............................................94
Avaya Breeze ............................................................ 52
N for high availability ........................................................ 80
FQDN ........................................................................... 80
name resolution ............................................................. 69, 70 SIP load balancing ...............................................................79

May 2017 Deploying Avaya Breeze 100


Comments on this document? infodev@avaya.com
Index

SIP load balancing (continued)


geo-redundancy ............................................................84
local .............................................................................. 83
SIPS .....................................................................................68
snap-ins
benefits ........................................................................... 9
call intercept description ............................................... 10
collaboration bus-invoked description .......................... 10
defined ............................................................................9
description .................................................................... 10
HTTP-invoked description ............................................ 10
outbound calling description ......................................... 10
types ............................................................................. 10
software patches ..................................................................24
SRTP ................................................................................... 68
status
Enrollment Password ....................................................26
support .................................................................................93
system interactions .............................................................. 13
System Manager IP address for AAMS ............................... 67

T
training ................................................................................. 92
trust certificates ..........................................................9, 74, 75
trust configuration ................................................................ 71
trusted certificates
add ................................................................................76

U
URI .......................................................................................98

V
verification
Avaya Aura Media Server entity link .............................96
entity link .......................................................................55
management link .......................................................... 56
replication status ...........................................................56
videos
Avaya Breeze ............................................................ 92
viewing cluster attributes ..................................................... 57
virtual machine
automatic restart .....................................................46, 47
vSphere client connect to ESXi host OVA deployment ....... 36
vSphere client OVA deployment ..........................................31
vSphere web client OVA deployment .................................. 27

Z
Zang Call Connector ............................................................12

May 2017 Deploying Avaya Breeze 101


Comments on this document? infodev@avaya.com

You might also like