DeployingAvayaCMS R21.0 November 2024 En-Us
DeployingAvayaCMS R21.0 November 2024 En-Us
System
Release 21.0
Issue 3
November 2024
© 2015-2024, Avaya LLC TERMS OF USE. IF YOU DO NOT HAVE SUCH AUTHORITY,
All Rights Reserved. OR IF YOU DO NOT WISH TO ACCEPT THESE TERMS OF
USE, YOU MUST NOT ACCESS OR USE THE HOSTED SERVICE
Notice OR AUTHORIZE ANYONE TO ACCESS OR USE THE HOSTED
While reasonable efforts have been made to ensure that the SERVICE.
information in this document is complete and accurate at the time Licenses
of printing, Avaya assumes no liability for any errors. Avaya reserves
the right to make changes and corrections to the information in this The Global Software License Terms (“Software License Terms”)
document without the obligation to notify any person or organization are available on the following website https://www.avaya.com/en/
of such changes. legal-license-terms/ or any successor site as designated by Avaya.
These Software License Terms are applicable to anyone who
Documentation disclaimer installs, downloads, and/or uses Software and/or Documentation. By
“Documentation” means information published in varying media installing, downloading or using the Software, or authorizing others to
which may include product information, subscription or service do so, the end user agrees that the Software License Terms create
descriptions, operating instructions and performance specifications a binding contract between them and Avaya. In case the end user is
that are generally made available to users of products. accepting these Software License Terms on behalf of a company or
Documentation does not include marketing materials. Avaya shall other legal entity, the end user represents that it has the authority to
not be responsible for any modifications, additions, or deletions bind such entity to these Software License Terms.
to the original published version of Documentation unless such Copyright
modifications, additions, or deletions were performed by or on the
express behalf of Avaya. End user agrees to indemnify and hold Except where expressly stated otherwise, no use should be made
harmless Avaya, Avaya's agents, servants and employees against of materials on this site, the Documentation, Software, Hosted
all claims, lawsuits, demands and judgments arising out of, or in Service, or hardware provided by Avaya. All content on this site, the
connection with, subsequent modifications, additions or deletions to documentation, Hosted Service, and the product provided by Avaya
this documentation, to the extent made by End user. including the selection, arrangement and design of the content is
owned either by Avaya or its licensors and is protected by copyright
Link disclaimer and other intellectual property laws including the sui generis rights
Avaya is not responsible for the contents or reliability of any linked relating to the protection of databases. You may not modify, copy,
websites referenced within this site or Documentation provided by reproduce, republish, upload, post, transmit or distribute in any way
Avaya. Avaya is not responsible for the accuracy of any information, any content, in whole or in part, including any code and software
statement or content provided on these sites and does not unless expressly authorized by Avaya. Unauthorized reproduction,
necessarily endorse the products, services, or information described transmission, dissemination, storage, or use without the express
or offered within them. Avaya does not guarantee that these links will written consent of Avaya can be a criminal, as well as a civil offense
work all the time and has no control over the availability of the linked under the applicable law.
pages. Virtualization
Warranty The following applies if the product is deployed on a virtual machine.
Avaya provides a limited warranty on Avaya hardware and software. Each product has its own ordering code and license types. Unless
Please refer to your agreement with Avaya to establish the terms of otherwise stated, each Instance of a product must be separately
the limited warranty. In addition, Avaya’s standard warranty language licensed and ordered. For example, if the end user customer or
as well as information regarding support for this product while under Avaya Channel Partner would like to install two Instances of the
warranty is available to Avaya customers and other parties through same type of products, then two products of that type must be
the Avaya Support website: https://support.avaya.com/helpcenter/ ordered.
getGenericDetails?detailId=C20091120112456651010 under the link Third Party Components
“Warranty & Product Lifecycle” or such successor site as designated
by Avaya. Please note that if the product(s) was purchased from an The following applies only if the H.264 (AVC) codec is distributed
authorized Avaya channel partner outside of the United States and with the product. THIS PRODUCT IS LICENSED UNDER THE AVC
Canada, the warranty is provided by said Avaya Channel Partner and PATENT PORTFOLIO LICENSE FOR THE PERSONAL USE OF A
not by Avaya. CONSUMER OR OTHER USES IN WHICH IT DOES NOT RECEIVE
REMUNERATION TO (i) ENCODE VIDEO IN COMPLIANCE WITH
“Hosted Service” means an Avaya hosted service subscription that THE AVC STANDARD (“AVC VIDEO”) AND/OR (ii) DECODE AVC
You acquire from either Avaya or an authorized Avaya Channel VIDEO THAT WAS ENCODED BY A CONSUMER ENGAGED IN A
Partner (as applicable) and which is described further in Hosted SAS PERSONAL ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO
or other service description documentation regarding the applicable PROVIDER LICENSED TO PROVIDE AVC VIDEO. NO LICENSE
hosted service. If You purchase a Hosted Service subscription, IS GRANTED OR SHALL BE IMPLIED FOR ANY OTHER USE.
the foregoing limited warranty may not apply but You may be ADDITIONAL INFORMATION MAY BE OBTAINED FROM MPEG LA,
entitled to support services in connection with the Hosted Service L.L.C. SEE HTTP://WWW.MPEGLA.COM.
as described further in your service description documents for the
applicable Hosted Service. Contact Avaya or Avaya Channel Partner Service Provider
(as applicable) for more information. WITH RESPECT TO CODECS, IF THE AVAYA CHANNEL
Hosted Service PARTNER IS HOSTING ANY PRODUCTS THAT USE OR
EMBED THE H.264 CODEC OR H.265 CODEC, THE AVAYA
THE FOLLOWING APPLIES ONLY IF YOU PURCHASE AN CHANNEL PARTNER ACKNOWLEDGES AND AGREES THE
AVAYA HOSTED SERVICE SUBSCRIPTION FROM AVAYA OR AVAYA CHANNEL PARTNER IS RESPONSIBLE FOR ANY AND
AN AVAYA CHANNEL PARTNER (AS APPLICABLE), THE TERMS ALL RELATED FEES AND/OR ROYALTIES. THE H.264 (AVC)
OF USE FOR HOSTED SERVICES ARE AVAILABLE ON THE CODEC IS LICENSED UNDER THE AVC PATENT PORTFOLIO
AVAYA WEBSITE, HTTPS://SUPPORT.AVAYA.COM/LICENSEINFO LICENSE FOR THE PERSONAL USE OF A CONSUMER
UNDER THE LINK “Avaya Terms of Use for Hosted Services” OR OTHER USES IN WHICH IT DOES NOT RECEIVE
OR SUCH SUCCESSOR SITE AS DESIGNATED BY AVAYA, AND REMUNERATION TO: (i) ENCODE VIDEO IN COMPLIANCE WITH
ARE APPLICABLE TO ANYONE WHO ACCESSES OR USES THE THE AVC STANDARD (“AVC VIDEO”) AND/OR (ii) DECODE AVC
HOSTED SERVICE. BY ACCESSING OR USING THE HOSTED VIDEO THAT WAS ENCODED BY A CONSUMER ENGAGED IN A
SERVICE, OR AUTHORIZING OTHERS TO DO SO, YOU, ON PERSONAL ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO
BEHALF OF YOURSELF AND THE ENTITY FOR WHOM YOU ARE PROVIDER LICENSED TO PROVIDE AVC VIDEO. NO LICENSE
DOING SO (HEREINAFTER REFERRED TO INTERCHANGEABLY IS GRANTED OR SHALL BE IMPLIED FOR ANY OTHER USE.
AS “YOU” AND “END USER”), AGREE TO THE TERMS OF USE. ADDITIONAL INFORMATION FOR H.264 (AVC) AND H.265 (HEVC)
IF YOU ARE ACCEPTING THE TERMS OF USE ON BEHALF A CODECS MAY BE OBTAINED FROM MPEG LA, L.L.C. SEE HTTP://
COMPANY OR OTHER LEGAL ENTITY, YOU REPRESENT THAT WWW.MPEGLA.COM.
YOU HAVE THE AUTHORITY TO BIND SUCH ENTITY TO THESE
Compliance with Laws
You acknowledge and agree that it is Your responsibility to comply
with any applicable laws and regulations, including, but not limited
to laws and regulations related to call recording, data privacy,
intellectual property, trade secret, fraud, and music performance
rights, in the country or territory where the Avaya product is used.
Preventing Toll Fraud
“Toll Fraud” is the unauthorized use of your telecommunications
system by an unauthorized party (for example, a person who is not a
corporate employee, agent, subcontractor, or is not working on your
company's behalf). Be aware that there can be a risk of Toll Fraud
associated with your system and that, if Toll Fraud occurs, it can
result in substantial additional charges for your telecommunications
services.
Avaya Toll Fraud intervention
If You suspect that You are being victimized by Toll Fraud and You
need technical assistance or support, please contact your Avaya
Sales Representative.
Security Vulnerabilities
Information about Avaya’s security support policies can be
found in the Security Policies and Support section of https://
support.avaya.com/security.
Suspected Avaya product security vulnerabilities are handled
per the Avaya Product Security Support Flow (https://
support.avaya.com/css/P8/documents/100161515).
Trademarks
The trademarks, logos and service marks (“Marks”) displayed in this
site, the Documentation, Hosted Service(s), and product(s) provided
by Avaya are the registered or unregistered Marks of Avaya, its
affiliates, its licensors, its suppliers, or other third parties. Users
are not permitted to use such Marks without prior written consent
from Avaya or such third party which may own the Mark. Nothing
contained in this site, the Documentation, Hosted Service(s) and
product(s) should be construed as granting, by implication, estoppel,
or otherwise, any license or right in and to the Marks without the
express written permission of Avaya or the applicable third party.
Avaya is a registered trademark of Avaya LLC.
All non-Avaya trademarks are the property of their respective owners.
Linux® is the registered trademark of Linus Torvalds in the U.S. and
other countries.
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 Cloud Service notices and articles, or to report a
problem with your Avaya Product or Cloud 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: Purpose................................................................................................................... 7
Change history........................................................................................................................ 7
Chapter 2: Deployment planning............................................................................................. 9
Planning checklist.................................................................................................................... 9
Deployment guidelines........................................................................................................... 10
Functional differences when installing CMS in a virtualized environment.................................... 11
High Availability for customer-provided VMware....................................................................... 12
Virtual machine resource requirements and average utilization ................................................ 12
Capacities............................................................................................................................. 14
Customer configuration data worksheets................................................................................. 15
Chapter 3: Deploying CMS software using an OVA file...................................................... 17
Deploying CMS software checklist.......................................................................................... 17
Cloned and copied OVAs are not supported............................................................................ 17
Activating the license for a CMS server................................................................................... 18
Installing a license file on a WebLM server.............................................................................. 19
Downloading software from PLDS.......................................................................................... 20
Deploying the OVA................................................................................................................ 21
Deploying the OVA on a customer-provided VMware server............................................... 21
Deploying the OVA on an Avaya Solutions Platform server................................................. 23
Configuring the virtual machine automatic startup settings on VMware...................................... 25
Configuring the virtual machine for different configuration sizes................................................. 26
Configuring the virtual machine as a small configuration..................................................... 26
Configuring the virtual machine as a medium configuration................................................. 27
Configuring the virtual machine as a large configuration..................................................... 28
Chapter 4: Deploying the CMS KVM..................................................................................... 31
Planning checklist for CMS KVM deployment.......................................................................... 31
Activating the license for a CMS server................................................................................... 32
Installing a license file on a WebLM server.............................................................................. 34
Downloading software from PLDS.......................................................................................... 35
Preparing the CMS KVM file................................................................................................... 36
Importing the CMS virtual machine......................................................................................... 37
Chapter 5: Configuring system features.............................................................................. 39
Configuring system features checklist..................................................................................... 39
Verifying that CMS is installed................................................................................................ 40
Initializing the CMS database................................................................................................. 40
Setting the root password....................................................................................................... 41
Configuring the system network.............................................................................................. 42
Disk encryption..................................................................................................................... 45
Configuring WebLM, EASG, and the encryption passphrase..................................................... 45
This document is for implementation engineers and other personnel who deploy CMS. They can use
this document to install a Avaya Call Management System (CMS) server as a virtual machine on an
Avaya supplied hypervisor server.
The supported options are:
Change history
The following table outlines the key changes in this document for Release 21.x:
This chapter provides planning information and other deployment guidelines. You can deploy CMS
on an Avaya Solutions Platform ASP 130 R6 server or in a customer-provided virtual environment.
As of CMS R21.x, the VMware information in this document only applies to customer-provided
systems. New CMS deployments on an Avaya Solutions Platform server use Red Hat KVM on the
ASP 130 R6.
Note:
• The profile of the Avaya Solutions Platform hardware server you install depends on the
sizing tool specification. You must determine the configuration size before starting the
deployment because the configuration is based on whether the system is small, medium,
or large.
Related links
Planning checklist on page 9
Deployment guidelines on page 10
Functional differences when installing CMS in a virtualized environment on page 11
High Availability for customer-provided VMware on page 12
Virtual machine resource requirements and average utilization on page 12
Capacities on page 14
Customer configuration data worksheets on page 15
Planning checklist
Ensure that the following activities are complete before deploying the virtual appliance:
No Task Notes
Note:
You can deploy a configuration that consists of a mixture of CMS servers hosted on VMware
platforms and CMS servers hosted on non-VMware platforms.
Deployment guidelines
• Deploy the virtualized environment on the same cluster if the cluster goes beyond the host
boundary.
• Segment redundant elements on a different cluster, or ensure that the redundant elements
are not on the same host.
• Create a tiered or segmented cluster infrastructure that isolates critical applications, such as
CMS, from other virtual machines.
• Plan for rainy day scenarios. Do not configure resources only for traffic or performance on an
average day.
• Do not oversubscribe resources because this affects performance.
• Monitor the server, host, and virtualized environment performance.
Important:
The values for performance, occupancy, and usage can vary. A virtual machine might
run at 50% occupancy. If the CPU occupancy exceeds 60% or the CMS real-time report
mismatches the refresh rates, you could experience performance issues.
Note:
For medium and large
configurations, you will
configure two disks.
IOPS 200 300 600 600 The IOPS data is based on real
CMS hardware machines with 50%
read and 50% write data.
Shared NICs Two @ Two @ Two @ Two @ A typical CMS deployment only
1000 1000 1000 1000 requires two Ethernet ports, but
Mbps Mbps Mbps Mbps many hardware options provide a
four-port NIC.
The OVA contains many of the virtual machine resource requirements, such as vCPU reservation
and memory reservation. The target virtual machine confirms that the required resources in the
OVA are available before deploying the OVA.
Average resource and network utilization for standard configurations
Average resource usage Small Medium Large Notes
CPU consumed 600 MHz 2 GHz 8 GHz
Memory consumed 500 MB 2 GB 4 GB
Network consumed 0.252 Mbps 0.512 Mbps 1.696 Mbps
IOPS 12 18 28 IOPS is higher during nightly
summarization.
Capacities
Use this table to determine the configuration to use for your deployment.
• Select the size that provides the capacities you require.
• If any capacity requires a larger configuration, use the larger configuration option.
- For example: If you need 100000 agent skill pairs but your peak busy-hour call volume is
200000, you must select the medium configuration.
• The Extended capacity option is only applicable for the AXP Private – Extended Scale ACD.
• Deployments on Avaya Solutions Platform support the small, medium, and large
configuration options only.
1. This value is the total number of active CMS Supervisor PC Client and Web Client
sessions.
2. For actual capacity details, see Avaya Call Management System Overview and
Specification.
3. For actual capacity details, see Avaya Call Management System Overview and
Specification.
4. For a definition of Report elements, see Avaya Call Management System Overview and
Specification.
Related links
Deployment planning on page 9
The following worksheet identifies the key customer networking information that you must enter
when you run the /cms/toolsbin/netconfig command.
Parameter Example Your value
Network interface name eth0
Hostname for the CMS server vm_cms1
Use only the short hostname, not the
FQDN. The hostname cannot have
upper-case letters.
Important:
The CMS backup process
automatically assigns time-stamped
file names that truncate the CMS
server hostname if it is longer than
15 characters. To avoid confusion
between the backup files for
multiple CMS servers, do not use
the same first 15 characters for a
hostname when you have multiple
CMS servers in your deployment.
Domain name example.com
IP address 123.45.67.89
Netmask 255.255.255.0
Default gateway IP address 123.45.67.254
DNS IP addresses 123.1.0.1 123.1.0.2
123.1.0.3
Uup to 3 addresses separated with a
space
DNS search domains AltCompanyName.com
OtherCompanyName.co
Separated with a space
m
1. Activate the license for the CMS Activating the license for a CMS server on page 18
server.
2. Install the license file on the Installing a license file on a WebLM server on
WebLM server. page 19
3. Download the OVA software. Download the software from the Avaya PLDS website
at https://plds.avaya.com. For more information, see
Downloading software from PLDS on page 20.
4. Deploy the OVA software. For more information, see Deploying the OVA on
page 21.
5. Configure the virtual machine for Configuring the virtual machine automatic startup
automatic startup. settings on VMware on page 25
6. Configure the virtual machine Configuring the virtual machine as a small
configuration. configuration on page 26
Configuring the virtual machine as a medium
configuration on page 27
Configuring the virtual machine as a large
configuration on page 28
7. Power up the virtual machine for For more information, see Initializing the CMS
the first time. database on page 40.
Note:
You can also download a license file and install the file manually. For more information,
see Installing a license file on a WebLM server on page 19.
9. Select one of the displayed license hosts or create a new host by clicking Add a License
Host.
10. Click Next.
PLDS displays a registration summary screen.
11. Click Next.
PLDS displays the Activate Entitlements screen.
12. Select the quantity of each entitlement you want to activate.
13. Click Next.
14. Add notes for the activation, if needed.
15. Click Finish.
Related links
Deploying the CMS KVM on page 31
older license file during installation. If you experience problems while installing the license file, see
the information about license file installation errors in Administering standalone Avaya WebLM.
Procedure
1. Log in to the standalone WebLM web console or the System Manager console with
administrator privilege credentials.
2. In the navigation pane, click Install license.
3. On the Install license page, click Choose File and browse to the directory of the XML
license file that you saved on your computer.
4. Read the terms and conditions and click Accept the License Terms & Conditions.
5. Click Install.
WebLM displays a message on successful installation of the license file. The installation
of the license file might fail for various reasons. For example, the digital signature on the
license file is invalid. If you get such an error, request PLDS to redeliver the license file.
An error can also occur if the current capacity use exceeds the capacity in the installed
license.
6. Enable Centralized licensing as described in WebLM documentation.
With Centralized licensing, you must assign every license file to the license ID in WebLM.
7. Click New.
8. Enter a name to assign to the CMS.
9. Select the license file to associate with the CMS.
Related links
Deploying the CMS KVM on page 31
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.
10. If you use the Download Manager, click Details to view the download progress.
11. Select a location where you want to save the file, and click Save.
12. (Optional) When the system displays the security warning, click Install.
When the installation is complete, PLDS displays the downloads again with a check mark
next to the downloads that have completed successfully.
Related links
Deploying the CMS KVM on page 31
Determine the web browser. VMware recommends using Google Chrome or Mozilla Firefox.
Important:
Customers that deploy an OVA on their own VMware systems can initially choose to start with
the minimum memory allocation, minimum memory reservation allocation, and minimum disk
space. However, to maintain support from Avaya, Avaya might require you to later increase
the memory allocations (to no more than the recommended maximum value) if Avaya finds
that problems related to memory usage occur and cause failures on the CMS.
Important:
You must separately license each CMS instance, that is, each installation of OVA. To install
multiple instances of CMS, customers or business partners must order a separate CMS
license for each instance.
Procedure
1. To start the vSphere client software, do one of the following:
b. Browse to the location of the CMS OVA file, select the OVA file, and then click Open.
c. Click Next.
d. In the Select a name and folder window, enter the virtual machine name and click
Next.
e. Select the destination compute resource and click Next.
f. In the Review Details window, verify the details of the OVA file, including the CMS
version number, and then click Next.
10. In the End User License Agreement window, review the license agreement.
11. In the End User License Agreement window, click Accept and click Next.
12. From the Select virtual disk format drop-down list, select Thick Provision.
Important:
Customers that deploy an OVA on their own VMware systems can initially choose to
start with the minimum memory allocation, minimum memory reservation allocation,
and minimum disk space. However, to maintain support from Avaya, Avaya might
require you to later increase the memory allocations (to no more than the
recommended maximum value) if Avaya finds that problems related to memory usage
occur and cause failures on the CMS.
13. From the VM Storage Policy drop-down list, select Datastore Default.
14. From the Datastore table, select Datastore and click Next.
Important:
The data store type that you select must use the VMFS5 or VMFS6 format.
15. In the Select networks window, choose a network from the Destination Network drop-
down, and then click Next.
16. In the Ready to Complete window verify the deployment settings and click Finish.
The Deploy OVF window closes and installation begins, the Recent Tasks pane displays
information for tasks Deploy OVF template and Import OVF package, the Status column
shows the percentage complete, and the installation should last 10-20 minutes depending
on the processing power of the server.
Note:
For an Avaya Solutions Platform server, Avaya or Business Partner personnel downloads the
OVA from PLDS and deploy the OVA on the Avaya Solutions Platform server.
Procedure
1. On your web browser, type the VMware ESXi URL.
2. In the User name field, type your user name.
3. In the Password field, type your password.
4. Click Login.
5. (Optional) If the VMware ESXi client browser displays a warning message about an
untrusted SSL certificate, select the appropriate action based on your security policy
below:
• To ignore the security for this login session only, click Ignore.
• To ignore the security warning for this login session, and install the default certificate
so that the warning does not appear again, select Install this certificate and do not
display any security warnings for this server and click Ignore.
Select this option only if the default certificate does not present a security problem in
your environment.
• To install a signed certificate before proceeding, click Cancel and ensure that a signed
certificate is installed on the vCenter Server system before you attempt to connect
again.
6. In the Home navigation pane, click Host.
7. In the Host window, select Create/Register VM.
8. In the Select creation type window, select Deploy a virtual machine from an OVF or
OVA file and then click Next.
9. In the Select OVF and VMDK files window, do the following:
a. Enter the name of the virtual machine.
b. Select the Click to select files or drag/drop check box.
c. Browse to the location of the CMS OVA file, select the OVA file, click Open.
d. Click Next.
10. In the Select storage window, click the storage resource and then click Next.
11. In the End User License Agreement window, review the license agreement. If you agree to
the terms, click I agree and then click Next.
12. In the Deployment options window, implement the following settings.
a. From the Network Mapping drop-down list, select a subnetwork.
b. From the Disk Provisioning drop-down list, select Thick.
f. Click OK.
f. Click OK.
9. In the vSphere Web Client left pane, select the CMS virtual machine.
10. On the vSphere Client browser, click Actions and select Edit Settings.
The system displays the Edit Settings window.
11. In the Edit Settings window, click ADD NEW DEVICE.
The system displays a drop-down list.
12. From the drop-down list, select Hard Disk.
13. Select New Hard disk and click to expand.
14. Enter 400 in the Size field.
15. Click Disk Provisioning and select Thick Provision.
Important:
Customers that deploy an OVA on their own VMware systems can initially choose to
start with the minimum memory allocation, minimum memory reservation allocation,
and minimum disk space. However, to maintain support from Avaya, Avaya might
require you to later increase the memory allocations (to no more than the
recommended maximum value) if Avaya finds that problems related to memory usage
occur and cause failures on the CMS.
16. Select OK.
Procedure
1. On your web browser, type the vSphere vCenter URL and press Enter.
2. In the User name field, type your user name.
3. In the Password field, type your password.
4. Click Login.
5. On the vSphere Web Client home page, select one of the following icons:
• Hosts and Clusters
• VMs and Templates
6. In the navigation pane, click CMS Virtual Machine.
7. Click Actions > Edit Settings.
8. In the Edit Settings dialog box, do the following:
a. In the navigation pane, select CPU and then click 16.
b. In the content pane, select Cores per Socket that then click 16.
c. In the navigation pane, select Reservation and then click 9600 MHz.
d. In the content pane, select Memory and then click 64 GB.
For a customer-provided OVA deployment, the minimum value allowed is 16 GB.
e. Select Reservation and then click 65,536 MB.
For a customer-provided OVA deployment, the minimum value allowed is 16,384 MB.
f. Click OK.
9. In the vSphere Web Client left pane, select the CMS virtual machine.
10. On the vSphere Client browser, click Actions and select Edit Settings.
The system displays the Edit Settings window.
11. In the Edit Settings window, click ADD NEW DEVICE.
The system displays a drop-down list.
12. From the drop-down list, select Hard Disk.
13. Select New Hard disk and click to expand.
14. Enter 1000 in the Size field.
15. Click Disk Provisioning and select Thick Provision.
Important:
Customers that deploy an OVA on their own VMware systems can initially choose to
start with the minimum memory allocation, minimum memory reservation allocation,
and minimum disk space. However, to maintain support from Avaya, Avaya might
require you to later increase the memory allocations (to no more than the
recommended maximum value) if Avaya finds that problems related to memory usage
occur and cause failures on the CMS.
16. Select OK.
This section of the document covers the processes for deploying the CMS server as a new KVM
virtual machine on an Avaya ASP 130 R6 server.
Note:
• For the ASP 130 R6 you cannot use Solution Deployment Manager for the installation of
CMS KVM images, Feature Packs, Service Packs, Patches, and Hot fixes. You must follow
the CLI instructions for installation of those artifacts.
Related links
Planning checklist for CMS KVM deployment on page 31
Activating the license for a CMS server on page 18
Installing a license file on a WebLM server on page 19
Downloading software from PLDS on page 20
Preparing the CMS KVM file on page 36
Importing the CMS virtual machine on page 37
1. Check the hardware platform For ASP 130 R6, A1SC configurator output should
be utilized to determine which applications are to be
deployed on which server/host.
2. Activate the license for the CMS –
server.
3. Install the license file on the –
WebLM server.
4. Download the latest CMS The deployment process for Feature Packs, Service
software Packs, patches, and hot-fixes is the same regardless
of the underlying hypervisor.
Table continues…
5. Plan the staging and verification This must include network topology, IP addressing,
activities and assign the naming conventions, and application specific
resources configuration and administration.
6. Purchase the appropriate order Reach out to the Avaya account team for detailed
codes information on ordering ASP 130 R6.
Note that with the introduction of ASP 130 R6, there
is no longer a license key present on the server.
However, it is imperative that customers have a record
in PLDS for each instance of the ASP 130 R6 server
as customers and Avaya are subject to audits to
ensure right to use royalties have been paid.
7. Read the Avaya server Navigate to https://support.avaya.com and search for
documentation Avaya Solutions Platform, Release ASP 130 R6.
8. Download the latest CMS Reference the CMS R21 Release Notes, Product
software Correction Notices, and software downloads for
specific PLDS IDs links to the CMS KVM images.
The deployment process for Feature Packs, Service
Packs, patches, and hot-fixes is the same regardless
of the underlying hypervisor.
Related links
Deploying the CMS KVM on page 31
Procedure
1. In a browser window, navigate to the PLDS site:
https://plds.avaya.com
2. Log on to PLDS using your customer ID and password.
3. Navigate to Assets > View Entitlements.
PLDS displays the Search Entitlements screen.
4. Search for your license entitlement using one of the following criteria:
• SAP order number
• Sold to number
• License activation code
You can also use Advanced Search to find a license entitlement.
5. Click Search Entitlements.
PLDS displays the known license entitlements based on the search criteria.
6. For the customer’s entitlement record, click Options > Activate.
PLDS displays a list of possible entitlements.
7. Select the entitlement for CMS release for which you are installing or upgrading.
8. Click Activate.
PLDS displays the Search License Hosts screen. The available license hosts for the
Company ID are displayed on this screen.
Note:
You can also download a license file and install the file manually. For more information,
see Installing a license file on a WebLM server on page 19.
9. Select one of the displayed license hosts or create a new host by clicking Add a License
Host.
10. Click Next.
PLDS displays a registration summary screen.
11. Click Next.
PLDS displays the Activate Entitlements screen.
12. Select the quantity of each entitlement you want to activate.
13. Click Next.
14. Add notes for the activation, if needed.
15. Click Finish.
Related links
Deploying the CMS KVM on page 31
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.
10. If you use the Download Manager, click Details to view the download progress.
11. Select a location where you want to save the file, and click Save.
12. (Optional) When the system displays the security warning, click Install.
When the installation is complete, PLDS displays the downloads again with a check mark
next to the downloads that have completed successfully.
Related links
Deploying the CMS KVM on page 31
• If the permissions do not match, change them using the following command. This allows
custadm to write into the directory folder using sudo commands.
• sudo chown custadm:wheel /var/lib/libvirt/staging
5. Verify there is sufficient free-space to copy the size of the KVM image. There needs to be a
minimum of 800 GB free space.
6. Copy the downloaded CMS-R21.0.0.1.ab.b-kvm-e810-00-1.ova file into
the /var/lib/libvirt/staging directory.
7. Extract the contents of the ova using the command:
tar -xvf CMS-R21.0.0.1.ab.b-kvm-e810-00-1.ova
This extracts the following files
• CMS-R21.0.0.1.ab.b-kvm.ovf
• CMS-R21.0.0.1.ab.b-kvm.mf
• CMS-R21.0.0.1.ab.b-kvm-1.qcow2
8. The .qcow2 file is in thin provisioning format. To create a copy that is thick provisioned file,
run the command:
sudo qemu-img convert -O qcow2 -o preallocation=full CMS-
R21.0.0.1.ab.b-kvm-1.qcow2 CMS-R21.0.0.1.ab.b-kvm-1-THICK.qcow2
9. Verify that the thick provision copy is 800 GB by running the command:
sudo qemu-img info CMS-R21.0.0.1.ab.b-kvm-1-THICK.qcow2
10. Move the thick provisioned file image to the virtual machine images directory:
sudo mv -i CMS-R21.0.0.1.ab.b-kvm-1-THICK.qcow2 /var/lib/libvirt/
images
11. Change the file owner and file permission by running following commands:
sudo chown qemu:qemu /var/lib/libvirt/imagesCMS-R21.0.0.1.ab.b-kvm-1-THICK.qcow2
sudo chmod 640 /var/lib/libvirt/images/CMS-R21.0.0.1.ab.b-kvm-1-THICK.qcow2
4. In the Disk Image field, enter /var/lib/libvirt/images and select the CMS-
R21.0.0.1.ab.b-kvm-1-THICK.qcow2 image.
5. In the Operating system field, select RHEL 8.10.
6. In the Memory field, select the required memory in MB format.
• For more information on footprints, see Virtual machine resource requirements and
average utilization on page 12.
7. Click Import and edit.
8. Under the Disks section:,
a. Check that the CMS-R21.0.0.1.ab.b-kvm-1-THICK.qcow2 image disk image
size is correctly displayed in the Capacity field.
b. Click Edit.
c. In the Bus field select scsi.
d. In the Cache field select directsync.
e. Click Save.
9. In the Firmware field, select BIOS and click Save.
10. In the CPU field, click edit.
a. Increase the values in the vCPU Maximum and vCPU Count fields to match
the footprint requirement (see Virtual machine resource requirements and average
utilization on page 12). Set the same value in each field.
b. Click Apply.
11. In the Networking section:
a. Click on Edit.
b. Select the required Network Bridge and click Save.
12. On the virtual machine, click Run to start the CMS virtual machine.
Related links
Deploying the CMS KVM on page 31
Following deployment of a new CMS virtual machine, use the processes in this section of the
documentation to start and initially configure CMS.
Related links
Configuring system features checklist on page 39
Verifying that CMS is installed on page 40
Initializing the CMS database on page 40
Setting the root password on page 41
Configuring the system network on page 42
Configuring WebLM, EASG, and the encryption passphrase on page 45
Installing CMS patches on page 47
Updating Linux RPMs on page 47
Running the CMS security script on page 48
Turning on IDS and adding disk space for medium and large configurations on page 48
Verifying system startup and remote access on page 49
8. Turn on IDS and initialize Informix. Turning on IDS and adding disk space for medium and
large configurations on page 48
9. Verify that the CMS system starts Verifying system startup and remote access on
up properly and that you can page 49
access it remotely.
10. Proceed to configuring CMS See Configuring CMS features checklist on page 51.
features.
Related links
Configuring system features on page 39
4. Enter the new password for the root user ID a second time.
The system displays the following message:
passwd: all authentication tokens updated successfully.
Related links
Configuring system features on page 39
Important:
You cannot directly log on as root from a remote connection. You must log on using an
administered CMS user ID, then use su - root to log on with root privileges.
2. Enter the following command:
/cms/toolsbin/netconfig
The system displays the following prompt:
Enter the network interface name from following name(s): eth0 eth1 eth2 eth3
(default <ethX>)
ENTER>
ENTER>
5. Enter the host name of the CMS server and press Enter.
Hostname for the CMS server
Important:
The CMS backup process automatically assigns time-stamped file names that truncate
the CMS server hostname if it is longer than 15 characters. To avoid confusion
between the backup files for multiple CMS servers, do not use the same first 15
characters for a hostname when you have multiple CMS servers in your deployment.
The system displays the following prompt:
You have entered [ <cms_hostname> ]. Is this correct? (y|n)
6. If you have entered the correct host name, enter y, then press Enter.
The system displays the following prompt:
Enter the domain name of the CMS system (default <cms.domain.com>)
ENTER>
7. Enter the domain name of the CMS server and press Enter.
The system displays the following prompt:
You have entered [ <cms.domain.com> ]. Is this correct? (y|n)
8. If you have entered the correct domain name, enter y, then press Enter.
The system displays the following prompt:
Enter the IP address of the network interface (default <IP_address>)
ENTER>
9. Enter the IP address of the CMS server network interface and press Enter.
The system displays the following prompt:
You have entered [ <IP_address> ]. Is this correct? (y|n)
10. If you entered the correct IP address, enter y, then press Enter.
The system displays the following prompt:
Enter the netmask for the subnet of the network interface (default <netmask_IP>)
ENTER>
11. Enter the netmask for the subnet of the CMS server network interface and press Enter.
The system displays the following prompt:
You have entered [ <netmask_IP> ]. Is this correct? (y|n)
12. If you entered the correct IP address, enter y, then press Enter.
ENTER>
13. Enter the gateway for the CMS server network interface and press Enter.
The system displays the following prompt:
You have entered [ <Gateway_IP> ]. Is this correct? (y|n)
14. If you entered the correct default gateway, enter y, then press Enter.
The system displays the following prompt:
Enter the DNS server(s) seperated by space (up to three servers) (default
<Maximum_Three_DNS_Servers_IP>)
ENTER>
15. Enter the DNS servers of the CMS server and press Enter.
The system displays the following prompt:
You have entered [ <Maximum_Three_DNS_Servers_IP> ]. Is this correct? (y|n)
16. If you entered the correct DNS server(s), enter y, then press Enter.
The system displays the following prompt:
Enter the search domains separated by space (default <Search_Domains>, "" for
none)
ENTER>
17. Enter the search domain(s) of the CMS server and press Enter.
The system displays the following prompt:
You have entered [ <Search_Domains> ]. Is this correct? (y|n)
18. If you entered the correct search domains, enter y, then press Enter.
The system displays the network configuration options you have entered, for example:
Interface: eth0
CMS Hostname: cmshostname
Domainname: tmp.domain.com
CMS IP address: 10.10.10.10
Netmask: 255.255.255.0
Gateway: 10.20.30.40
DNS Server1: 40.30.20.10
DNS Server2: 100.200.300.400
DNS Server3:
Search domains: tmp.domain1.com tmp.domain2.com
The system attempts to bring up the network and if successful, displays a successfully
finished message.
Bring the network up. Please wait...
20. If the network configuration was not successful, troubleshoot the network for outages and
repeat this procedure. If the network configuration fails again, escalate through normal
channels. Test your network settings to ensure that the network settings are working
properly using the following commands:
ifconfig <ethX> (use your actual Ethernet port)
ping <system on your local network>
Press Control+C to exit the ping command.
Note:
If the network does not respond, enter ifup <ethX>. If the network still does not
respond, repeat this procedure and verify that the values entered are correct.
Disk encryption
By default, CMS no longer encrypts disks and partitions with CMS data using LUKS encryption.
This encryption is generally redundant because supported cloud providers encrypt by default and
VMware supports disk encryption natively.
administrative or maintenance procedures such as turning FIPS on and off, CMSADM restore,
LAN restore, RPM update, software upgrades, and regular maintenance reboots. It also includes
unplanned shutdowns such as a system crash.
Before you begin
• After deploying CMS, set up the root password.
• Log in to the CMS server with root privileges.
Procedure
1. Run the cmssvc command for the first time after deploying CMS.
When you run this command for the first time, a message such as the following is
displayed:
cmssvc: Warning IDS off-line. It will take approx 45 seconds to
start cmssvc. IDS can be turned on with the run_ids command on
the cmssvc menu.
You are required to set the WebLM server before proceeding.
2. Enter the hostname or IP address of the WebLM server where the CMS license is installed.
3. Press Enter.
If the information you entered is incorrect, you are prompted to enter another hostname.
After entering a valid hostname or IP address, proceed to the next step.
4. When prompted, enter the CMS server license ID.
This is an ID created when the license is installed on the WebLM server.
5. Press Enter.
A message such as the following is displayed:
Web hostname is now authorized as https://<Host_Name or IP_Address>:<Port_Number>/
WebLM/LicenseServer.
Tip:
If you do not enable EASG now, you can use the cmssvc command to enable it
later.
The message displayed confirms whether EASG is enabled and it indicates that disk
encryption is implemented. You are prompted to choose an option for the encryption
passphrase.
7. Choose one of the following options for the encryption passphrase:
• Enter 1 to require users to manually enter the encryption passphrase on the system
console after every shutdown or reboot.
• Enter 2 to enable auto-unlocking through a CMS-generated local key file. If you select
this option, CMS starts up without an encryption passphrase.
Related links
Configuring system features on page 39
Related links
Configuring system features on page 39
Important:
You cannot directly log on as root from a remote connection. You must log on using an
administered CMS user ID, then use su - root to log on with root privileges.
2. Enter:
cmssvc
The system displays the following menu:
Avaya(TM) Call Management System Services Menu
Important:
Do not run this command on a small configuration.
Verify that the disk space was added successfully. If the procedure fails, contact Avaya
support.
Related links
Configuring system features on page 39
Important:
You cannot directly log on as root from a remote connection. You must log on using an
administered CMS user ID, then use su - root to log on with root privileges.
4. From another system, verify that you can access the new system using tools such as
puTTY or SSH.
Important:
You cannot directly log on as root from a remote connection. You must log on using an
administered CMS user ID, then use su - root to log on with root privileges.
Related links
Configuring system features on page 39
1. Assign passwords for the CMS Assigning passwords to the default CMS login IDs on
login IDs. page 51
2. View the CMS authorizations to Viewing CMS authorizations on page 52
confirm that your licensed features
are authorized.
3. Activate the Supervisor web client. Activating the CMS Supervisor Web Client software on
page 52
4. Calculate storage requirements for Calculating data space requirements for CMSADM
backups. backups on page 56
Calculating data space requirements for CMS full
maintenance backups on page 57
5. Set up the Alarm Origination Setting up the Alarm Origination Manager on
Manager to report alarms to Avaya page 58
support or customer management
systems.
4. To assign a password for the cmssvc login ID, enter: passwd cmssvc
The system displays the following message:
New password
Installing the root certificate and any intermediate certificate for the Web Client software on
page 55
Starting the Web Client software on page 56
Important:
• You cannot directly log on as root from a remote connection. You must log on using
an administered CMS user ID, then use su - root to log on with root privileges.
2. To create and move to a temporary work directory, use the following commands:
mkdir /opt/cmsweb/cert/custom
cd /opt/cmsweb/cert/custom
3. To generate a private key, use the following command:
keytool -genkey -alias cmsweb1
-keyalg RSA -keysize 2048
-keystore cmsweb.p12
-dname "CN=[fqdn],OU=CMS,O=Avaya,L=Thornton,ST=Colorado,C=US"
-ext "SAN=IP:[ip],DNS:[fqdn]"
• In the -dname part, replace the [fqdn] with the FQDN for CMS.
• In the -ext part, replace the [fqdn] and [ip] with the values for CMS.
• The -alias value must be cmsweb1 as shown.
• The -keystore value must be cmsweb.p12 as show.
• All other values (-keyalg, -kesize) must be as shown.
4. Enter the keystore password: cmsweb.
5. To generate a Certificate Signing Request (CSR), enter:
keytool -certreq -keyalg RSA -alias cmsweb1 -file cmsweb.csr
-keystore cmsweb.p12
6. To obtain a signed certificate, submit the CSR to the Certificate Authority (CA) using your
organization's regular certificate signing procedure.
• You can use the Avaya System Manager CA function to sign the certificate.
7. Obtain a copy of the root certificate of the CA used in the previous step. For example,
<CARootCert>.pem.
Procedure
1. If using Google Chrome or Microsoft Edge:
a. Open the browser.
b. Navigate to Settings > Privacy and security > Security > Manage device
certificates.
c. On the Certificates window, click the Trusted Root Certification Authorities tab.
d. In the list of certificates, select the CA root certificate and click Import.
2. For Mozilla Firefox:
a. Import the CA to the Firefox certificate store. If you use Windows, you can open the
command line cmd.exe using the Run as Administrator option.
Important:
You cannot directly log on as root from a remote connection. You must log on using an
administered CMS user ID, then use su - root to log on with root privileges.
2. Enter the following command to start the Web Client software:
cmsweb start
The system displays the following message:
starting cmsweb...
3. Enter the following command to verify that the correct version of the Web Client software is
installed:
rpm –q cmsweb
The system displays a message similar to the following example:
cmsweb-R{XX}-web{XX}xx.x.x
3. Add the disk space from the Used column for all ext4 file systems, except for the /
storage and /tmp directories.
4. Calculate the space you need.
The example in the following table shows the used space for the relevant ext4 file system
directories:
Important:
• If using a remote connection, you cannot directly log on as root. Instead, log on
using an administered CMS user ID and then then use su - root to log on with
root privileges.
2. Run the following command to set the Informix environment: ./opt/informix/bin/
setenv
3. Run onstat -d
4. Use the output generated from running this command to estimate how much database
space is required for a CMS full maintenance backup. The data in this table is dynamic and
changes as database space is used.
Note:
• Bytes to GB conversion factor = 1,073,741,824.
• Full Maintenance Backup compression ratio = 30 (approximation). The onstat -d
command gives a current snapshot of disk space usage of the CMS server.
• You must run additional checks periodically to see if your storage needs have
changed to ensure that you have enough backup space.
Note:
During AOM configuration, use the Alarm ID referred to here as the Alarm ID and use the
Sold To Functional Location (FL) number as the Customer ID.
• Log on as root.
Important:
You cannot directly log on as root from a remote connection. You must log on using an
administered CMS user ID, then use su - root to log on with root privileges.
Related links
Configuring an Alarm Destination on page 59
Configuring an SNMP User on page 62
Configuring an Alarm ID on page 65
Configuring a Customer ID on page 65
Sending an AOM Test Alarm on page 66
Clearing SNMP Alarms on page 66
CMS SNMP alarm information on page 67
Locating and installing the CMS-MIB.txt file on page 71
Setting up AOM configuration for alarming using Socket/SAL on page 71
2. Enter the number associated with the Configure the Alarm Destination option, and press
Enter.
The system displays the following message:
Welcome to Avaya CMS Alarm Origination main menu.
1) SNMP/SAL
2) Socket/SAL
q) Quit
Enter choice (1-2, q):
Note:
Avaya recommends using SNMP/SAL for alarming.
3. Enter the number associated with the SNMP/SAL option, and press Enter.
4. Enter the number associated with the Add an SNMP connection option, and press Enter.
The system displays the Adding an SNMP connection option followed by an input prompt
for destination type:
Adding an SNMP connection
Select a destination type:
1) SAL
2) NMS
Enter choice (1-2):
5. Enter the number associated with SAL or NMS, and press Enter.
The system displays the input prompt for the destination IP address:
What is the destination IP address?
6. Enter the destination IP address, for example, 192.168.123.256, and press Enter.
The system displays the input prompt for the port number:
What is the destination port number?
7. Enter the destination port number, for example, 162, and press Enter.
The system displays the input prompt for the SNMP user:
Select an SNMP user:
1) cmssnmp
Enter choice (1-1):
8. Enter The system displays a list of defined users. Select an SNMP user, and press Enter.
The system displays the input prompt for Alarm ID along with the default Alarm ID value:
What is the Alarm ID (10 digit alarm ID)? (default:3000004043)
9. Enter the Alarm ID or accept the default value, and press Enter.
The system displays the input prompt for Customer ID along with the default Customer ID
value:
What is the Customer ID (10 digit customer code)? (default:0004558769)
10. Enter the Customer ID value or accept the default value, and press Enter.
The system displays the input prompt for Customer Name along with the default Customer
Name value:
What is the Customer Name? (default:Avaya)
11. Enter the Customer Name or accept the default value, and press Enter.
The system displays the input prompt for running a test alarm:
Run a test alarm when done?(y/n)
Note:
The SAL SNMP option requires a Notification Type of inform and notify in the
dest.cfg file.
13. Press Enter.
The system displays the following messages:
Configuring dest.cfg
[started]
done
reset AOM
[started]
done
Clearing all current alarms.
[started]
done
Sending test alarm.
[started]
done
done
Do you want to
1) Add an SNMP Connection
2) Delete an SNMP Connection
3) Modify an SNMP Connection
4) Add an SNMP User
5) Delete an SNMP User
6) Modify an SNMP User
7) Clear SNMP Alarms
q) Quit
Enter choice (1-7, q): q
2. Enter the number associated with the Configure the Alarm Destination option, and press
Enter.
The system displays the Welcome to Avaya CMS Alarm Origination main menu options:
Welcome to Avaya CMS Alarm Origination main menu.
1) SNMP/SAL
2) Socket/SAL
q) Quit
Enter choice (1-2, q):
Note:
Avaya recommends using SNMP/SAL for alarming.
3. Enter the number associated with the SNMP/SAL option, and press Enter.
The system displays the list of SNMP configuration options:
Do you want to
1) Add an SNMP Connection
2) Delete an SNMP Connection
3) Modify an SNMP Connection
4) Add an SNMP User
5) Delete an SNMP User
6) Modify an SNMP User
7) Clear SNMP Alarms
q) Quit
Enter choice (1-7, q):
4. Enter the number associated with the Add an SNMP User option, and press Enter.
The system displays the input prompt for SNMP user name:
Adding an SNMP user
What is the SNMP user name?
6. Enter the number associated with the v3 option, and press Enter.
7. Enter the number associated with the level of access to assign to the user, and press
Enter.
The system displays the Select the security level option based on the FIPS status:
• If the FIPS mode is off:
Select the security level:
1) noAuthNoPriv: Unauthenticated/Unencrypted (not allowed in FIPS mode)
2) authNoPriv: Authenticated/Unencrypted (not allowed in FIPS mode)
3) authPriv: Authenticated/Encrypted
Enter choice (1-3):
• If the FIPS mode is on:
Select the security level:
3) authPriv: Authenticated/Encrypted
Enter choice (1-1):
8. Enter the number associated with the level of security to assign to the user, and press
Enter. .
The system displays the Select the authentication protocol option based on the FIPS
status:
• If the FIPS mode is off:
Select the authentication protocol:
1) MD5 ( not allowed in FIPS mode)
2) SHA
Enter choice (1-2):
• If the FIPS mode is on:
Select the authentication protocol:
1) SHA
Enter choice (1-1):
9. Enter the number associated with the authentication protocol to assign to the user, and
press Enter.
Note:
Authentication utilizes the defined authentication password to sign the messages that
are sent during authentication. The encryption protocol for this can be either MD5 or
SHA.
The system displays the authentication password prompt:
Enter authentication password (min 8 chars):
10. Enter the authentication password to assign to the user, and press Enter.
The system displays the Select the encryption protocol option:
Select the encryption protocol:
1) AES
2) DES
Enter choice (1-2):
11. Enter the number associated with the encryption protocol to assign to the user, and press
Enter.
Note:
Authentication utilizes the defined encryption password to encrypt the data portion of
the SNMP messages. The encryption protocol for this may be either AES or DES.
The system displays the encryption password prompt:
Enter encryption password (min 8 chars):
12. Enter the encryption password to assign to the user, and press Enter.
The system displays information about the choices entered:
CMS was last rebooted 11 day(s) ago.
You have selected to configure AOM using SNMP.
Add an SNMP User
User Name: TestSNMP
SNMP version: v3
SNMP Access Level: rouser
SNMP Security Level: authPriv
SNMP authentication protocol: MD5
SNMP authentication password: ******
SNMP encryption protocol: AES
SNMP encryption password: ******
Press [Enter] to continue or [q] to quit
Configuring an Alarm ID
Procedure
1. Start the AOM tool by running the following command: /cms/aom/bin/aom_tool
The system displays the following messages:
Welcome to Avaya CMS Alarm Configuration Main Menu.
1) Set Alarm ID
2) Set Customer ID
3) Configure Alarm Destination
4) Send a Test Alarm
q) Quit
Enter choice (1-4, q):
2. Enter the number associated with the Set a Test Alarm option, and press Enter .
The system clears the current alarms and then sends the test alarm. The system displays
the following messages, and the tool returns to the command line prompt.
Clearing all current alarms.
[started]
done
Sending test alarm.
[started]
done
#
Configuring a Customer ID
Procedure
1. Start the AOM tool by running the following command: /cms/aom/bin/aom_tool
The system displays the following messages:
Welcome to Avaya CMS Alarm Configuration Main Menu.
1) Set Alarm ID
2) Set Customer ID
3) Configure Alarm Destination
4) Send a Test Alarm
q) Quit
Enter choice (1-4, q):
2. Enter the number associated with the Customer ID option, and press Enter
The system displays the Customer ID prompt:
What is the Customer ID (10 digit customer code)? (default:0004558769)
After you have configured the Customer name, the system displays the following
messages, and the tool returns to the command line prompt:
reset AOM
[started]
Done
#
2. Enter the number associated with the Send a Test Alarm option, and press Enter .
The system clears the current alarms and then sends the test alarm. The system displays
the following messages, and the tool returns to the command line prompt.
Clearing all current alarms.
[started]
done
Sending test alarm.
[started]
done
#
2. Enter the number associated with the Configure the Alarm Destination option, and press
Enter .
The system displays the Welcome to Avaya CMS Alarm Origination main menu options
Configure the Alarm DestinationWelcome to Avaya CMS Alarm Origination main menu.
1) SNMP/SAL
2) Socket/SAL
q) Quit
Enter choice (1-2, q):
Note:
Avaya recommends using SNMP/SAL for alarming.
3. Enter the number associated with the SNMP/SAL option, and press Enter.
The system displays the list of SNMP configuration options:
Do you want to
1) Add an SNMP Connection
2) Delete an SNMP Connection
3) Modify an SNMP Connection
4) Add an SNMP User
5) Delete an SNMP User
6) Modify an SNMP User
7) Clear SNMP Alarms
q) Quit
Enter choice (1-7, q): 7
4. Enter the number associated with the Clear SNMP Alarms option, and press Enter
The system displays active alarms.
5. To close an open alarm, enter y at the prompt.
Configuring AOM
Configuring AOM for alarming using a modem includes the following:
• Configuring an Alarm Destination
• Configuring an Alarm ID
• Sending an AOM Test Alarm
2. Enter the number associated with the Configure the Alarm Destination option, and press
Enter.
The system displays the following message:
Welcome to Avaya CMS Alarm Origination main menu.
1) SNMP/SAL
2) Socket/SAL
q) Quit
Enter choice (1-2, q):
Note:
Avaya recommends using SNMP/SAL for alarming.
3. Enter the number associated with the Socket/SAL option, and press Enter.
Note:
If the system has been previously configured with an alarming method, the system can
prompt for the removal of the configuration.
The system displays the input prompt for the SAL IP address:
What is the SAL ip address?
5. Enter the SAL network port value or accept the default value and press Enter.
The system displays the input prompt for the Alarm ID and the default Alarm ID:
What is the Alarm ID (10 digit product code)?
6. Enter the Alarm ID or accept the default value, and press Enter.
The system displays the input prompt for running a test alarm:
Run a test alarm when done?(y/n)
8. Press Enter.
The system displays the following messages, and the tool returns to the command line
prompt:
Configuring dest.cfg
[started]
done
reset AOM
[started]
done
Clearing all current alarms.
[started]
done
Sending test alarm.
[started]
done
done#
Configuring an Alarm ID
Procedure
1. Start the AOM tool by running the following command: /cms/aom/bin/aom_tool
The system displays the following messages:
Welcome to Avaya CMS Alarm Configuration Main Menu.
1) Set Alarm ID
2) Set Customer ID
3) Configure Alarm Destination
4) Send a Test Alarm
q) Quit
Enter choice (1-4, q):
2. Enter the number associated with the Set a Test Alarm option, and press Enter .
The system clears the current alarms and then sends the test alarm. The system displays
the following messages, and the tool returns to the command line prompt.
Clearing all current alarms.
[started]
done
Sending test alarm.
[started]
done
#
2. Enter the number associated with the Send a Test Alarm option, and press Enter .
The system clears the current alarms and then sends the test alarm. The system displays
the following messages, and the tool returns to the command line prompt.
Clearing all current alarms.
[started]
done
Sending test alarm.
[started]
done
#
Important:
You cannot directly log on as root from a remote connection. You must log on using an
administered CMS user ID, then use su - root to log on with root privileges.
• Verify that if TCP/IP is being used to connect to an ACD, the switch/LAN setup is done.
• Verify that all file systems are mounted.
Note:
If you are running cmssvc for the first time, the Services menu is not displayed.
Instead, you are prompted to set up your system as described in Configuring WebLM,
EASG, and the encryption passphrase on page 45.
3. At the command prompt, enter 4 to select the run_cms option.
4. At the command prompt, enter 2 to turn CMS off and keep the Informix Database Server
running.
5. To create a new contact center connection, run the cmssvc command again.
6. At the command prompt, enter 5 to select the setup option.
7. At the command prompt, enter y to add a new configuration to CMS.
The system displays the following message:
Select the language for this server:
1) English
2) Dutch
3) French
4) German
5) Italian
6) Portuguese
7) Spanish
8) Japanese
Enter choice (1-8): (default: 1)
9. At the Enter a name for this UNIX system prompt, enter the name of the new
system.
You can enter a maximum of 64 alphanumeric characters.
10. At the Select the type of backup device you are using prompt, select the
backup device type.
Note that tape backups are no longer supported.
11. Enter the backup device path when prompted.
12. At the Enter the number of Automatic Call Distribution systems (ACDs)
being administered prompt, enter 1.
13. At the Enter switch name prompt, enter the name of the new contact center.
You can enter a maximum of 20 alphanumeric characters.
14. Enter the number corresponding to the switch model you want to select.
15. At the Enter the local port assigned to switch prompt, enter the local port
number.
The port number must be in the range of 1 through 64 and match the corresponding value
defined for the Routing Core Server during the contact center installation.
16. At the Enter the remote port assigned to switch prompt, enter the remote port
number.
The port number must be in the range of 1 through 64 and match the corresponding value
defined for the Routing Core Server.
17. At the Enter switch host name or IP Address prompt, enter the Routing Core
Server IP address.
For the Simplex deployment, specify the static IP address of the Routing Core Server.
For the local HA and geo-redundant HA deployments, specify the virtual IP address
of the Routing Core Server. You define the Routing Core Server IP addresses in the
megaconfig.yml file.
18. At the Enter switch TCP port number prompt, enter the TCP port number.
The port number range is 5001 through 5020.
19. At the Number of splits/skills prompt, enter the number of skills in your contact
center.
The value range is 0 through 15,000.
20. At the Total split/skill members summed over all splits/skills prompt,
enter the number of agents in your contact center.
The value range is 0 through 1,000,000.
21. At the Number of trunk groups prompt, enter the number of trunk groups.
cp cms.inst.skl cms.install
3. Use the following command to change permissions on the copied CMS installation file:
chmod 644 cms.install
4. Use the following command to edit the copied CMS installation file:
vi cms.install
The file contains a series of questions and value ranges for each possible ACD (Automatic
Call Distribution system) in your configuration. Enter the appropriate values for your
configuration. The entries must be added on the blank lines after each question.
Caution:
Use the CMS server host name for the Linux system name. The computer’s host name
was assigned during network setup.
5. Press Esc.
6. Enter:
:wq!
The system saves and closes the file.
Example
For an example of a flat file that you will edit to set up CMS, see Example of a flat file on
page 90.
Next steps
Continue with Setting up CMS using the flat file on page 79.
Note:
If you are executing the cmssvc command for the first time, the system does not
display the menu. Instead, the system automatically prompts for WebLM setup, EASG
setup, encryption passphrase setup. For more information, see Configuring WebLM,
EASG, and the encryption passphrase on page 45.
1) English
2) Dutch
3) French
4) German
5) Italian
6) Portuguese
7) Spanish
8) Japanese
Enter choice (1-8): (default: 1)
Note:
When the cmssvc setup command is running, the system does not allow any other
cmsadm or cmssvc commands. The system rejects any attempt to run other cmsadm
or cmssvc commands and the system displays the following error message
Please try later, setup is active.
Note:
If system setup has already been done, the program responds:
Warning!!! Setup has already been performed.
Running this command will remove all CMS data in the database.
Do you wish to proceed and re-configure CMS? (y/n): (default: n)
The system displays the following message if a flat file exists; otherwise, this menu is not
displayed:
The input will be read from
1) the terminal
2) a flat file
Enter choice (1-2):
You can edit this file and add comments about the packages that were installed or
authorized.
6. Press Delete to exit the tail -f command.
7. Choose one of the following:
• To install additional CMS-related feature packages (such as Forecasting or External Call
History), see Maintaining and Troubleshooting Avaya Call Management System.
• If you are not installing any other feature packages, do the following to turn on the CMS
software:
a. Enter: cmssvc.
The system displays the “Avaya Call Management System Services Menu”.
b. Enter the number associated with the run_cms option.
c. Enter the number associated with the Turn on CMS option.
This section describes how to test the CMS software to ensure that the application is working
properly before the system is turned over to the customer.
Prerequisites
Before you begin the procedures in this section, the technicians must:
• Locate the backup tapes (the set created by provisioning during installation) and set these
tapes to write-protect mode if using tape drives for backups.
• Connect the CMS server to the switch.
• Translate the switch with the CMS feature enabled.
• Connect the switch to an active link.
1. Check the system date and time. See Verifying the system date and time on page 83.
2. Configure CMS warning email See Forwarding CMS warning messages on page 83.
forwarding.
3. Check the free-space allocation. See Checking free space allocation on page 83.
4. Test the ACD link. See Testing the ACD link on page 84.
5. Assign customer password. See Assigning customer passwords on page 85.
6. Test the CMS software. See Testing the CMS software on page 86.
7. Finalize the on-site installation. See Finalizing the on-site installation on page 89.
5. Save and quit the file by pressing Esc and entering: chmod 600 /.forward
Procedure
1. Log on to CMS Supervisor.
2. Navigate to Administration > System Setup > Free Space Allocation.
3. Enter an ACD number (1-8).
4. Click on the Get Contents icon.
The system displays the Get Contents screen showing the amount of dbspace allocated
for each CMS item for the ACD selected.
For more information about free space allocation, see Administering Avaya Call
Management System.
If the Total Free Space field shows that there is not enough space available, you must
modify data storage allocation.
Important:
You cannot directly log on as root from a remote connection. You must log on using an
administered CMS user ID, then use su - root to log on with root privileges.
2. At the system prompt, have the customer enter: passwd login
where login is root, cms, and so on.
The system displays the following message:
New password:
Note:
The technician should not know these passwords
5. Repeat this procedure for each customer login.
Note:
If no historical data exists, the fields in the report window are blank.
j. Return to the CMS Main Menu by pressing the F5 key twice.
3. Test the Dictionary subsystem by doing the following from the CMS Main Menu.
a. On the CMS Main Menu select Dictionary.
b. Select Login Identifications
c. Enter an asterisk (*) in the Login ID field.
d. Select the List all action list item. The system lists all the login IDs.
e. Verify that the logins are displayed.
Note:
On a new system, the fields are blank.
f. Return to the CMS Main Menu by pressing the F5 key twice.
4. Test the Exceptions subsystem.
a. On the CMS Main Menu screen, select Exceptions.
b. Select Real-time Exception Log.
c. Verify that the window is displayed.
Note:
For a new installation, this window may be blank
d. Return to the CMS Main Menu by pressing the F5 key once.
5. Test the Call Center Administration subsystem.
a. On the CMS Main Menu select Call Center Administration.
Note:
On a new system, the fields may be blank.
f. Return to the CMS Main Menu by pressing the F5 key twice.
6. Test the Custom Reports subsystem.
a. On the CMS Main Menu select Custom Reports.
b. Select Real-time. The system lists the names of the custom reports.
c. Verify that the names of existing custom reports are listed. If there are no reports, you
receive a message saying the submenu is empty.
d. Return to the CMS Main Menu by pressing the F5 key once.
7. Test the User Permissions subsystem.
a. On the CMS Main Menu select User Permissions.
b. Select User Data.
c. Verify that the User Data Input window is displayed.
d. Return to the CMS Main Menu by pressing the F5 key once.
8. Test the System Setup subsystem
a. On the CMS Main Menu select System Setup.
b. Select CMS state.
c. Verify that CMS is operating in the Multi-user mode.
d. Return to the CMS Main Menu by pressing the F5 key once.
9. Test the Maintenance subsystem.
a. On the CMS Main Menu select Maintenance.
b. Select the Printer Administration option.
c. Enter a valid printer name in the CMS printer name: field.
d. Select the List all action list item. The system lists the printer parameters.
e. Verify that the printer has been administered correctly.
f. Return to the CMS Main Menu by pressing the F5 key twice.
10. If the Graphics feature package has been enabled, test the Graphics subsystem.
a. On the CMS Main Menu select Graphics.
Caution:
Use a new set of backup media for this CMSADM file system backup. Do not use the
provisioning backup media. Ensure that the customer has the proper media for the
new backup.
2. Perform a full maintenance backup to back up historical data.
You can perform this backup using the CMS Supervisor maintenance features. For
more information about maintenance backups, see Administering Avaya Call Management
System.
3. Set up alarming. For more information about the AOM tool, see Setting up the Alarm
Origination Manager on page 58.
4. Ensure that customer login information and passwords are recorded.
5. Give the passwords, backup media, and software to the CMS administrator.
For system security and recovery, ensure that the CMS administrator stores passwords,
Informix serial numbers, key license information, encryption passphrases, and backup
media in a secure location.
# Release(s) Value
# Communication Mgr 6.x/Communication Mgr 7.x 30000
# Communication Mgr 8.x/CM 8.1.2+ Secured 30000
# Enter number of VDNs (0-Maximum):
# Release(s) Value
# Communication Mgr 6.x 12000
# Communication Mgr 7.x 24000
# Communication Mgr 8.x/CM 8.1.2+ Secured 30000
# Number of trunks (0-Maximum):
Documentation
CMS and CMS Supervisor documents
Title Description Audience
Overview
Avaya Call Management System Overview Describes tested product characteristics All users
and Specification and product capabilities including feature
descriptions, interoperability, performance
specifications, security, and licensing
requirements.
Installation and maintenance
Deploying Avaya Call Management System Describes how to install and configure Implementation
CMS in a virtualized VMware or KVM engineers,
environment. administrators
Deploying Avaya Call Management System Describes how to deploy CMS in an Implementation
in an Infrastructure as a Service Amazon Web Services or Google Cloud engineers,
Environment Platform environment. administrators
Maintaining and Troubleshooting Avaya Describes how to configure, maintain, and Administrators,
Call Management System troubleshoot CMS. support personnel
Avaya Call Management System and Describes how to connect and administer Administrators,
Communication Manager Connections, the Automatic Call Distribution (ACD) installation
Administration, and Troubleshooting systems used by CMS. personnel, support
personnel
Avaya Call Management System High Describes how to connect to HA servers Administrators,
Availability Connectivity, Upgrade and and upgrade to HA. installation
Administration personnel, software
specialists involved
with HA
Using Avaya Call Management System Describes how to install and maintain your Administrators,
High Availability and Admin-Sync CMS High Availability (HA) system. support personnel
Upgrading
Table continues…
• Click Languages ( ) in the top menu bar to change the display language and view
localized documents.
• In the Search Documentation field, search for keywords and click Filter to filter by solution
category, product, or user role.
You can select multiple items in each filter category. For example, you can select a product
and multiple user roles.
• Click Library in the top menu bar to access the complete library of documents. Use the
filtering options to refine your results.
• After performing a search or accessing the library, you can sort content on the search results
page. When you find the item you want to view, click it to open it.
• Use the table of contents in a document for navigation. You can also click < or > next to the
document title to navigate to the previous topic or the next topic.
• Add content to a collection by clicking Add to My Topics ( ). You can add the topic and its
subtopics or add the entire publication.
• View the topics in your collections. To access your collections, click your name in the top
menu bar and then click My Topics.
You can do the following:
- Create, rename, and delete a collection.
- Set a collection as the default or favorite collection.
- Save a PDF of the selected content in a collection and download it to your computer.
- Share content in a collection with others through email.
- Receive collections that others have shared with you.
• Click Watch ( ) to add a topic to your watchlist so you are notified when the content is
updated or removed.
• View and manage your watchlist by clicking Watchlist from the top menu with your name.
You can do the following:
- Enable Email notifications to receive email alerts.
- Unwatch the selected content or all topics.
• Send feedback for a topic.
Note:
Videos are not available for all products.
Support
Go to the Avaya Support website at https://support.avaya.com for the most up-to-date
documentation, product notices, and knowledge articles. You can also search for release notes,
downloads, and resolutions to issues. Use the online service request system to create a service
request. Chat with live agents to get answers to questions, or request an agent to connect you to a
support team if an issue requires additional expertise.
AFS Authentication File System. AFS is an Avaya Web system that allows you
to create Authentication Files for secure Avaya Global Services logins for
supported non-Communication Manager Systems.
Avaya Appliance A physical server sold by Avaya running a VMware hypervisor that
has several virtual machines, each with its virtualized applications. The
servers can be staged with the operating system and application software
already installed. Some of the servers are sold as just the server with
DVD or software downloads.
ESXi A virtualization layer that runs directly on the server hardware. Also
known as a bare-metal hypervisor. Provides processor, memory, storage,
and networking resources on multiple virtual machines.
PLDS Product Licensing and Download System. The Avaya PLDS provides
product licensing and electronic software download distribution.
RFA Remote Feature Activation. RFA is an Avaya Web system that you use
to create Avaya License Files. These files are used to activate software
including features, capacities, releases, and offer categories. RFA also
creates Authentication Files for secure Avaya Global Services logins for
Communication Manager Systems.
Storage vMotion A VMware feature that migrates virtual machine disk files from one data
storage location to another with limited impact to end users.
vCenter Server An administrative interface from VMware for the entire virtual
infrastructure or data center, including VMs, ESXi hosts, deployment
profiles, distributed virtual networking, and hardware monitoring.
vMotion A VMware feature that migrates a running virtual machine from one
physical server to another with minimal downtime or impact to end users.
vMotion cannot be used to move virtual machines from one data center to
another.
vSphere Web Client The vSphere Web Client is an interface for administering vCenter Server
and ESXi. Downloadable versions are VMware 5.5 and 6.0. A browser-
based Web client version is VMware 6.5 and later.
EASG
configuring .................................................................... 45
Q
encryption passphrases QCOW2 ................................................................................11
configuring .................................................................... 45
R
F
related documentation ....................................................... 100
finalizing the on-site installation ........................................... 89 remote access ..................................................................... 49
finding content on documentation center ...........................102 requirements
flat file example ....................................................................90 virtual machine resources .............................................12
forwarding CMS warning messages .................................... 83 resource requirements .........................................................12
root certificate ................................................................ 54, 55
H root password ...................................................................... 41
handover ..............................................................................82
hardware support ................................................................. 11
S
high availability searching for content ......................................................... 102
VMware ........................................................................ 12 security script .......................................................................48
setting the Informix configuration .........................................74
I sharing content .................................................................. 102
small configuration ...............................................................26
IDS SNMP user .......................................................................... 62
starting ..........................................................................48 software media .....................................................................11
installation sort documents .................................................................. 102
CMS patches ................................................................ 47 starting
installing CMS Supervisor Web Client software .......................... 56
license file ...............................................................19, 34 support ...............................................................................104
system startup ..................................................................... 49
K
T
KB
Support site ................................................................ 104 test alarm ....................................................................... 66, 74
KVM deployment ................................................................. 31 testing the ACD link ............................................................. 84
testing the CMS software .....................................................86
L
U
large configuration ............................................................... 28
license ............................................................................18, 32 update Linux RPMs ............................................................. 47
limitations .............................................................................14
Linux RPMs ......................................................................... 47
W
watchlist ............................................................................. 102
WebLM
configuring .................................................................... 45
worksheets ...........................................................................15