Professional Documents
Culture Documents
Deploying Avaya Breeze 3 3
Deploying Avaya Breeze 3 3
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
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
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.
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.
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:
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.
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.
# Action Reference/Notes
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
# Action Reference/Notes
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
# 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
# Action Reference/Notes
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
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.
Virtual Machine
The Avaya Breeze profile you select has default values, which can be adjusted, for these settings.
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.
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.
7. On the Review Details page, confirm the properties of the OVA file you selected and click
Next.
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.
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:
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.
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.
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.
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.
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.
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.
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.
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
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.
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.
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.
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
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.
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.
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.
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.
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.
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 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
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
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
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.
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.
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.
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
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
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
6. Click Save.
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.
8. Click Commit .
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.
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.
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
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.
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.
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
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.
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.
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
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
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.
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.
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.
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
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
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