ACM Deployment Guide v1.2

Nectar UCMP Deployment Guide
for Avaya® Communication

Manager (ACM)
Version 1.2
March 2016
PROPRIETARY AND CONFIDENTIAL

Disclaimer
All information in this document is subject to change without notice. Although the information is
believed to be accurate, it is provided without guarantee of complete accuracy and without
warranty of any kind. It is the user's responsibility to verify and test all information in this document
and the user accepts full responsibility for all resulting outcomes.
Trademarks
SRSTP, UCMP-RIG, UCMP-DA, UCMP-CA, Converged Management Platform, UCMP, Vendor
Knowledge Module, VKM, Vendor Quality Module, and VQM are trademarks of Nectar Services
Corp.
Microsoft, Internet Explorer, Windows, Windows Server, Windows Vista, Win32, and the Microsoft
logo, Windows logo, Windows logo (2002), Internet Explorer logo, Lync Logo and Windows start
button, are registered trademarks. Lync 2010, Lync 2013, Skype for Business, Windows 2008,
Windows 2010, Windows 2012 and Windows XP, are trademarks of Microsoft.
Oracle, Oracle logo, Java, Solaris, all trademarks and logos that contain Oracle, Solaris, or Java,
and certain other trademarks and logos, are trademarks or registered trademarks of Oracle
Corporation or its subsidiaries in the United States and other countries.
Cisco, Cisco Unified Communications Manager, Cisco Call Manager Express, Cisco Unity, Cisco
Unity Express, Cisco Unified Border Element, are registered trademarks. Cisco UCM, Cisco CME,
Unity, Unity Express, and CUBE, are trademarks of Cisco.
Avaya and the Avaya logo are trademarks of Avaya Inc. and may be registered in certain
jurisdictions.
All other trademarks, service marks, registered trademarks, or registered service marks are the
property of their respective owners.
Copyright 2013-2016 Nectar Services Corp. ii ACM Deployment Guide v1.2

Document History and Version Control
Version Date Author Revision Notes Section
1.1 February 2016 Tonya Migrated old documentation to All

Spence FrameMaker, added deployment
sections, updated for Avaya CM 6.
1.2 March 2016 Tonya Rewrote chapter 6 on “Inventory Tasks” Chapter 6
Spence to include NAC MAC material.
Copyright 2013-2016 Nectar Services Corp. iii ACM Deployment Guide v1.2
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.1 About this Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.2 Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.3 Supported Software Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.4 Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.5 Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2. Prepare an Avaya CM for UCMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.1 Configure a SAT Login for the RIG (ACM v3) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.2 Configure RIG Maintenance Web Login (4.x and higher). . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.3 Prepare the Avaya CM Firewall (ACM v3) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.4 Prepare Communication Manager’s Firewall (ACM v4 and higher) . . . . . . . . . . . . . . . . 14
2.5 Enable SNMP on Communication Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.6 Designate SNMP Trap Destinations to the RIG. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.7 Configure Alarm Filters on Communication Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.8 Finalize the SNMP Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
2.9 RTCP Forwarding Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
2.10 Replicate Efforts for All Other Instances of Avaya CM . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3. Install and Configure Avaya CM VKM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.1 Avaya CM VKM Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.2 Install Avaya CM VKM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
3.3 Prepare Avaya CM VKM for Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
4. View Data Collection Extractions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
4.1 View Extractions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
4.2 Extraction Element Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
4.3 Run Process Now. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
5. Advanced Processor Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5.1 View Advanced Processor Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5.2 View Processor Task Failures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6. Inventory Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.1 Collect Avaya IP Station Inventory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.2 Enable Avaya IP Station Data Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.3 Define the Number of Threads for a Large Number of Stations . . . . . . . . . . . . . . . . . . . . 42
6.4 View TTI Station and Station MAC Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.5 Confirm Avaya CM VKM Data Collections Were Correctly Extracted . . . . . . . . . . . . . . 48
7. Configure Real Time QoS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
8. Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
8.1 Load Report Packs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
8.2 Apply Company Logo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Copyright 2013-2016 Nectar Services Corp. iv ACM Deployment Guide v1.2

8.3 Schedule a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
8.4 Report Retention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
8.5 Terminate a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
8.6 Email a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Copyright 2013-2016 Nectar Services Corp. v ACM Deployment Guide v1.2

1. Introduction
The purpose of this document is to provide information on installing, configuring, and deploying
an Avaya® Aura® Communication Manager (Avaya CM) instance in the Nectar Remote
Intelligence Gateway (RIG). This document is intended for anyone who is installing or using the
RIG component of the Nectar UCMP platform. It is assumed that you are familiar with the
following items:
• The host on which the RIG software will be deployed
• Standard Windows terminology
• Navigation of a Microsoft Windows operating system
This Vendor Knowledge Module™ (VKM™) document assumes that a RIG has been previously
installed and registered to a Nectar CIP system prior to following these procedures.
1.1 About this Document

This guide explains how to install, deploy, and configure the monitoring and management of
Avaya CM using the Nectar Avaya CM VKM, a core component of Nectar’s Unified
Communications Foundation (UCF) module.
1.2 Audience
This guide is intended for system administrators or engineers who have system administration
access and technical knowledge of Avaya CM and operating systems (Linux / Solaris), as well as
a familiarity with deploying the Nectar UCF module.
For detailed information on performing Nectar RIG operation tasks, such as using dashboards
and dependency trees, see the Remote Intelligence Gateway (RIG) Administration Guide.
1.3 Supported Software Versions

The following Avaya CM versions are supported:
• Avaya Aura Communication Manager 3.x
1.4 Technical Support

For technical support, contact Nectar in one of the following ways:
• Nectar technical support email address: support@nectarcorp.com
• Visit http://www.nectarcorp.com for additional information. Use your company’s login
information to access the documentation.
Copyright 2013-2016 Nectar Services Corp. 6 ACM Deployment Guide v1.2

1.5 Product Documentation
For additional information, see:
• Remote Intelligence Gateway (RIG) Administration Guide

2. Prepare an Avaya CM for UCMP
Before Nectar CMP can communicate with an Avaya CM platform, the target Communication
Manager System must be configured to accept communications from its designated RIG. This
section will help you with this task.
Depending on your ACM version, there are two methods used to create logins for Avaya CM.
• For Avaya CM v3, use “Configure a SAT Login for the RIG (ACM v3)” on page 8 and “Prepare
the Avaya CM Firewall (ACM v3)” on page 13.
• For Avaya CM versions v4 or higher, see “Configure RIG Maintenance Web Login (4.x and
higher)” on page 9 and “Prepare Communication Manager’s Firewall (ACM v4 and higher)”
on page 14.
This chapter contains these sections:
• Configure a SAT Login for the RIG (ACM v3)
• Configure RIG Maintenance Web Login (4.x and higher)
• Prepare the Avaya CM Firewall (ACM v3)
• Prepare Communication Manager’s Firewall (ACM v4 and higher)
• Enable SNMP on Communication Manager
• Designate SNMP Trap Destinations to the RIG
• Configure Alarm Filters on Communication Manager
• Finalize the SNMP Configuration
• RTCP Forwarding Configuration
• Replicate Efforts for All Other Instances of Avaya CM
2.1 Configure a SAT Login for the RIG (ACM v3)

Nectar UCMP also uses the RIG to communicate with the Avaya CM system at the application
layer (not just the hardware layer through SNMP). Avaya CM SAT sessions, in addition to some
querying commands through the Linux shell, are used to facilitate the required communication.
You must create a SAT level login with customer user privileges and be sure to enable Shell
access.

Figure 2-1 Configure a SAT Login for the RIG
After you have added the RIG login into Avaya CM, you must run the save translations all
command to replicate the login to all running instances of Avaya CM in the client’s network. This
will push the login to the ESS and LSP servers without waiting for the nightly Avaya CM
maintenance routine (which would synchronize the logins at the time of running the
maintenance routines). The RIG will interrogate all Avaya CM instances; as a result, a local login
must be present.
2.2 Configure RIG Maintenance Web Login (4.x and higher)

1. Log in to your Avaya CM server.
2. Navigate to the Administration > Server (Maintenance) page of the main/active processor:
Figure 2-2 Administrator > Server (Maintenance)

3. Navigate to Security > Administrator Accounts > Add Group.
4. Add a new access-profile group by creating a new Profile 20 and setting it as prof20. (You
can use any available profile from 20 to 69.)
Figure 2-3 Add a new access-profile group

5. Navigate to the Administrator Accounts page and enter the name of the login and password
for the UCMP RIG to use when interacting with the ACM platform. Do this as follows:
a. Add a login account with SAT-only access and prof20 (or the profile name that you
selected).
b. Accept all other defaults.

Figure 2-4 Enter the name of the login and password for the UCMP RIG
6. Log in to SAT with dadmin (you need its permissions to change a user profile) and change the
user-profile by category 20 (or by the profile you selected):
a. Turn on categories as shown here:
Figure 2-5 Turn on Categories

b. The changes can be made by category. Go to the top of page two and Set Permissions
for a category by entering the following:
Figure 2-6 Set Permissions

7. After the profile is created, you must log in to the Avaya SAT terminal of the main/active
processor and run a save translations all command to replicate the new login to other ESS
and LSP processors (if available) within the Avaya domain.

2.3 Prepare the Avaya CM Firewall (ACM v3)
Follow these steps to prepare for the Avaya CM firewall:
1. Log in to the web portal of the Avaya s8xxx server.
2. Select the Launch Maintenance Web Interface option from the Maintenance section.
Figure 2-7 Select Launch Maintenance Web Interface

3. Navigate to the Firewall section under Security:
• Enable SNMPTrap (outbound UDP port 162) and SNMP (inbound UDP port 161). The next
figure shows that both inbound and outbound are enabled on both ports.
• SNMP allows for operating system and host queries to be made against Avaya CM from
external systems. The RIG uses this service to obtain health statistics about the S8xxx
hardware that hosts the Avaya CM software.
• The SNMPTrap function is the mechanism that will forward Avaya INAD alarms from Avaya
CM to the RIG.

Figure 2-8 Enable SNMPTrap
2.4 Prepare Communication Manager’s Firewall (ACM v4 and

higher)
Note Avaya CM version 6 and higher does not require a firewall configuration.
Follow these steps to prepare for the Avaya CM firewall:

1. Log in to the web portal of the Avaya s8xxx server.
2. Click Administration at the top of the page and select Server (Maintenance) from the drop
menu.
Figure 2-9 Select Server (Maintenance)

3. Navigate to the Firewall section under Security:
• Enable SNMPTrap (outbound UDP port 162) and SNMP (inbound UDP port 161). The next
figure shows that both inbound and outbound are enabled on both ports.
• SNMP allows for operating system and host queries to be made against Avaya CM from
external systems. The RIG uses this service to obtain health statistics about the S8xxx
hardware that hosts the Avaya CM software.
• The SNMPTrap function is the mechanism that will forward Avaya INAD alarms from Avaya
CM to the RIG.
Figure 2-10 Enable SNMPTrap

2.5 Enable SNMP on Communication Manager
After the firewall settings have been updated, you can enable SNMP on Avaya CM.
1. Select the SNMP Agents sub-menu under the Alarms section.
2. The SNMP agent page will display, which requires your agent information, such as the IP
Addresses and Community strings.
3. In the next figure, we selected the Any IP Address radio button. For added security, you can
also designate the IP address of the RIG on the LAN segment that will communicate with the
Avaya CM platform. It is typical that one of the LAN interfaces on the RIG itself is connected in
the same LAN as the Customer Interface of the Avaya CM platform.
Figure 2-11 Prepare Firewall

4. Enter the Community Names as follows:
• Community Name (read-only): n3ctrTrapsnmpr
• Community Name (read-write): n3ctrTrapsnmpw
In the previous figure, two versions of SNMP are used. Another option for V3 exists, if
applicable. SNMP V1 or V2 are used for RIGs that are located on the client premise within
reach of the target Avaya CM system. Although the RIG does not use SNMP to write any
commands to Avaya CM, in some versions of Avaya CM, you cannot effect SNMP filters,
unless SNMP read-write is administered.
Note It is important that you enable the read-write function as well so that Filter
administration can be performed.
5. Click the Submit button after making changes.

2.6 Designate SNMP Trap Destinations to the RIG
After the SNMP has been enabled on Avaya CM, you can designate trap destinations to the RIG.
1. Navigate to the SNMP Traps section under Alarms.
Figure 2-12 SNMP Traps

2. In the SNMP Traps page, you will enter the destination IP Address of the SNMP Traps. Click Add
to continue:
Figure 2-13 SNMP Traps

3. Enter the IP address of the RIG server, select SNMP version 1 or SNMP version 2, and enter
n3ctrTrap for the Community name. (For SNMP version 2, select trap as the Notification type in
the drop menu.)
Note The community name is important since it will be entered into the RIG as well.
Note If SNMP version 3 is used, make sure the Receiver module in the RIG is administered
to accept v3 traps.

Figure 2-14 Change Trap Destination
4. In the SNMP Traps page, you can specify alarms to be sent as traps. For more information, see
“Configure Alarm Filters on Communication Manager” on page 19.
Figure 2-15 SNMP Trap Alarms

2.7 Configure Alarm Filters on Communication Manager
After the trap destinations have been designated tot he RIG, you can configure Avaya CM alarm
filters.
1. Navigate to the Filters section under Alarms. This section ensures that all alarms, errors, and
warnings have been selected.
Figure 2-16 Alarm Filters

2. In the Filters pane, for the Severity Category, select All.
3. Click Add or Change depending on whether or not you are creating a new or editing an
existing alarm filter. In this example, we selected Change, which opens the Change Filter
pane, as shown in Figure 2-17.
4. After adding or changing the filters, confirm that the Report All Communication Manager
alarms radio button is selected and click Update to submit your changes.
Figure 2-17 Add or Change Alarm Filters

2.8 Finalize the SNMP Configuration
After you have configured the Avaya CM alarm filters, you can finalize the SNMP configuration:
1. Navigate to the Agent Status section under SNMP.
Figure 2-18 Agent Status

2. You are now ready to turn up SNMP by stopping and starting the service. Click Stop Agent
and then select Start Agent to restart the service. All Agents should display an UP status.
Figure 2-19 Agent Status

3. Navigate to the SNMP Test section under Alarms.
Figure 2-20 SNMP Test

4. Within the SNMP Test page, click the Generate Test Trap button:

Figure 2-21 Generate Test Trap
5. Upon generation of the test trap, the SNMP Test Results page is displayed from the Avaya CM
system. At this point, the configured RIG should receive a customer test alarm from the Avaya
CM system.
Figure 2-22 SNMP Test Results

6. Within the Nectar UCMP RIG Event Console, you will see a copy of the Avaya CM test alarm:
Figure 2-23 SNMP Test Results

2.9 RTCP Forwarding Configuration
Follow these steps to configure RTCP forwarding:
1. Enter the change system-parameters ip-options command in the SAT terminal.
2. Configure the RIG’s IP address as the Default Server IP Address.
3. The Default Server Port value of 5005 does not need to be modified.
4. The Default RTCP Report Period (secs) does not need to be modified.
5. Review these examples. The left figure pertains to v2-v5, and the right applies to v6:
Figure 2-24 Forwarding
2.10 Replicate Efforts for All Other Instances of Avaya CM

If the server is duplicated, such as an s87xx, then both units will need to be configured. A Save
Translations All will not sync these settings. Each and every server will need to be configured. This
includes ICC, ESS, and LSP servers associated with an Avaya flattened and consolidated
architecture.

3. Install and Configure Avaya CM VKM
Note This chapter and its screen captures are extracted from an ACM v7. Other ACM
releases will be similar if not identical.
Configuring Avaya CM VKM involves performing these tasks:

• Avaya CM VKM Options
• Install Avaya CM VKM
• Prepare Avaya CM VKM for Deployment
3.1 Avaya CM VKM Options

This section contains these topics:
• View Avaya CM VKM Options
• Edit Avaya CM VKM Options
• Avaya CM VKM Option Descriptions and Values
3.1.1 View Avaya CM VKM Options

1. Navigate to Modules > Avaya > CM:
Figure 3-1 Modules > Avaya > CM

2. In the left pane, select VKM Options:
Figure 3-2 VKM Options

3. In this window, verify that the appropriate VKM options are selected:
Figure 3-3 Verify VKM Options

3.1.2 Edit Avaya CM VKM Options
To edit Avaya CM VKM options:
1. Right-click on an Avaya CM VKM option and select Edit from the menu:
Figure 3-4 Edit Avaya CM VKM Options

2. Depending on the VKM option selected, an Edit VKM Option window appears where you can
edit the value of that option. Click Update when you are done.
Figure 3-5 Edit VKM Option

3.1.3 Avaya CM VKM Option Descriptions and Values
This section defines the various Avaya CM VKM options and their values:
VKM Option Value Description
alarmOnNewChassis true/false If new Chassis hardware is discovered ,an

alert will be generated.
boardAlarmInterval 300 A board alarm is generated after it has
been in that state for X seconds.
cdrDataAgeOut 30 Number of days before CDR records are
deleted.
cdrEnable true/false Enables receiving of CDR records.
cdrExportEnable true/false Enables exporting of CDR records to CSV
files.
cdrExportLastTime Value from “time” column of the last
exported CDR record. Clearing this option
forces exporting of all records in the
CDRDATA table. Setting it to an epoch time
(in milliseconds) prevents exporting of
older records.
cdrFileRotationTimeout 900 Frequency (in seconds) for exporting CDR
records to CSV files.
cdrFormat unformatted, Expected format of received CDR records
enhancedUnfor (must match Avaya CM configuration).
matted, or
custom
cdrFTPDestDir / Destination directory for the files on the
remote system.
cdrFTPEnable true/false Enables uploading of export files to a
remote system.
cdrFTPHost Host name or IP address of the remote
system.
cdrFTPPassword User password for authentication to the
remote system.
cdrFTPPort Port number of the remote system.
cdrFTPScheme ftp/ftps/sftp Upload protocol of the remote system.
cdrFTPUsername User name for authentication to the
remote system.
cdrListenPort 9001 Port number to be used to receive CDR
records.
Table 3-1 Avaya CM VKM Options

cdrProcessingThreads 10 Number of threads used to process CDR
records.
cdrSequenceNumber Sequence number for export files.
cmDateFormat month/day or Date format used in received CDR records
day/month (must match Avaya CM configuration)
cmLocalTZ ‐ Setting not being used.
defaultCollectionCompression 1 week Poller compression strategy for pollers
that are created by alignments.
defaultCollectionInterval 60 Poller frequency for usage pollers that are
created by alignments. By default, all VKM
collections will occur every 2 minutes.
directToCIPAlarms false/true Event alarms are sent to the CIP, not at the
dependency tree level.
enableBoardAlarms false/true Alarms for board events will be in every
dependency tree. This can be confusing to
RIG uses, so this can be coded so that the
default is false.
enableCallDetail false/true This should be set to true. This is standard
in Nectar’s Foundation License. It enables
the sending of CDR records to the Call
Detail module.
enableRouteAlarms false/true The route pattern will generate events if
the trunk groups in those routes generate
an alarm.
essQueryRetryCount 0 Number of times to retry survivable
processor status query to prevent
information loss on busy systems.
fileRetention 10 Number of days before CSV files are
deleted.
incorporateChassisInDependencies true/false Chassis alarms will be in every
dependency tree that uses hardware in
that chassis.
phoneCommunity public The SNMP community string assigned to
the phones for pulling phone configuration
data.
pingFirstHopAddress false/true The RIG pings the first hop before the
Media Gateway to verify the issue is the
Media Gateway or the data switch.

pingIpsis false/true IPSI boards may be on a private subnet

and not reachable from the RIG. Also, this
hardware is not present on newer
platforms.
pingMediaGateways true/false A ping is sent to the Media Gateway to
determine if it is reachable.
pingVALBoards false/true VAL boards may be on a private subnet
and not reachable from the RIG.
recheckIfGatewayMissing true/false Query media gateways that are reported
as not registered by a processor to verify
registration status.
retentionFrequency 12 Frequency (in hours) of file retention
scans.
taskPageWait 5 Amount of time (in seconds) to wait for
the SAT terminal command to execute
and/or the next page to be loaded.
valBoardPollerDefaultCollectionInte 900 Announcement data is supplied from a
report in the Avaya CM that is only
rval
updated every hour. Therefore, this
collection default is every 15 minutes. This
allows for 4 collection points per interval.
vdnListenerEnabled true/false Leave this set to true. Disabling will prevent
VDN alignment tasks.

3.2 Install Avaya CM VKM
Note Before beginning these steps, make sure you are logged into the Avaya CM server
that you are onboarding to UCMP and that you have set up your Avaya CM server
as discussed in “Prepare an Avaya CM for UCMP” on page 8.
Follow these steps to install the Avaya CM VKM:

1. Navigate to RIG > Module Configuration.
The Module Configuration window appears.
2. Select Avaya CM Vendor Knowledge Module and Call Detail Module.
Figure 3-6 Activate Avaya CM VKM

3. Click Apply.
4. Restart the RIG service by navigating to RIG > Server License > Reset.

3.3 Prepare Avaya CM VKM for Deployment
Follow these steps to prepare the Avaya CM VKM:

2. In the left pane, select CM Connection Wizard:
Figure 3-8 CM Connection Wizard

3. Enter the following details relating to the location of the Avaya CM you are onboarding to
UCMP and then click Next.
• IP Address
• Port = 5022 or 5023 depending on connection type
• Username/Password
• Connection Type = SSH or Telnet only
Figure 3-9 CM Location Details

4. UCMP contacts the Avaya CM server to obtain version and serviceable processor
information.
5. Inspect the parameters to make sure they are accurate and then click Next. In this example,
we are onboarding SNMP V3, which is the most secure option. Make sure the following items
are correct:
• SNMP Version = V3
• Port = 161
• User ID
• Authentication = MD5
• DES Encryption Key
Figure 3-10 Inspect Parameters

6. Inspect the processors for inclusion and then click Next. Make sure the following items are
correct:
• IP = the IP address of the individual Avaya CM servers for proper Trap reception
• Port = 5022 or 5023 depending on connection type
• Name = Main
• Connection Type = SSH or Telnet only
• Display Name = Nectar-CM7
• # Connections = 3 is a recommended number
• Trap IP 1 (optionally Trap IP 2)
Figure 3-11 Inspect Processors
Note If you have multiple processors and your credentials fail for one of these, you can
go back to the Connectivity page and de-select the Include check box for that
processor to avoid adding it and generating alerts for it.
7. Wait for the system to test the connections. When the connections are ready, you will see the
following message. Click Finish.
Figure 3-12 Connections Ready

8. The following message appears when the CM connection wizard is complete.
Figure 3-13 CM Connection Wizard Complete

4. View Data Collection Extractions
Each data collection can be enabled or disabled. You can also change the frequency at which
the collection occurs.
This chapter contains these topics:
• View Extractions
• Extraction Element Menu Options
4.1 View Extractions

Follow these steps to view a list of data collection extractions for a particular Avaya CM server:

2. In the left pane, select Extraction Status:
Figure 4-2 Extraction Status

3. If the Avaya CM server onboarding is working properly, you will see extractions begin to
populate this window:
Note • The top panel shows process collections while the bottom panel shows process alignments
(creation of monitoring elements and processing of changes from previous collections).
• Collections run nightly (active discovery) to refresh the inventory.
Figure 4-3 Extractions Occurring

4.2 Extraction Element Menu Options
Right-click on an extraction element to view a menu containing these options:
• View Table Diffs - Allows you to view table differences and merge tables
• Sync Tables - Allows you to synchronize the tables within the selected extraction element
• Run Immediately - Allows you to run the extraction element immediately
• Enable - Allows you to enable the extraction element
• Disable - Allows you to disable the extraction element
• Turn Auto On - Allows you to turn on (set to true) the automatic data collection for this
extraction element.
• Turn Auto Off - Allows you to turn off (set to false) the automatic data collection for this
extraction element.
• Set Collection Hour/Frequency - Opens the Set Collect Hour window where you can select
the data collection hour and frequency in minutes. For more information, see “Run Process
Now” on page 36.
Figure 4-4 Set Collect Hour
Figure 4-5 Extraction Element Menu Options

4.3 Run Process Now
If you ran the Set Collection Hour/Frequency process in the previous section to set the data
collection hour and frequency in minutes, you must right-click on the appropriate element in the
bottom panel and select Run Process Now. This will immediately run the process to align it with
the collection above.
Figure 4-6 Run Process Now

5. Advanced Processor Setup
This chapter contains these topics:
• View Advanced Processor Setup
• View Processor Task Failures
5.1 View Advanced Processor Setup

To view Avaya CM VKM processes and details:
1. In the left pane, select Advanced Processor Setup:
Figure 5-1 Advanced Processor Setup

2. In this window, you can view the processes and details as they are running:
Figure 5-2 View Processes Running

5.2 View Processor Task Failures
To view process failures for a given processor:
1. Highlight a processor.
2. Click the View button and select Task Failures from the menu.
3. A list of task failures for this processor appears:
Figure 5-3 Processor Task Failures

6. Inventory Tasks
This chapter discusses inventory-related tasks. It includes these sections:
• Collect Avaya IP Station Inventory
• Enable Avaya IP Station Data Collection
• Define the Number of Threads for a Large Number of Stations
• View TTI Station and Station MAC Data
• Confirm Avaya CM VKM Data Collections Were Correctly Extracted
6.1 Collect Avaya IP Station Inventory

The Avaya CM VKM module collects a full inventory of registered and non-registered stations. The
module collects the following information for stations that are registered, as well as those that are
connected but not registered at the time of the collection:
Attribute Format/Syntax/Value
IP Address 10.190.211.192
Subnet Mask 255.0.0.0
MAC Address 00040debcbf0
Name Example: IP Phone/Gateway/Pulse/Turret
Model Example: 9650/G430/IQMAX
Release Example: 3.104S
Scanned/Detected Date Example: 2015-08-28T11:09:06+00:00
To collect station attributes, the enableStationMacData VKM option must be set to true. The
default value is false.
SNMP GET requests are sent to the station IP addresses using a community string that is specified
by the phoneCommunity VKM option to collect the station MAC address and station model
number.
Copyright 2013-2016 Nectar Services Corp. 39 ACM Deployment Guide v1.2

6.2 Enable Avaya IP Station Data Collection
You must enable your Avaya CM VKM so that it can collect Avaya IP station data. Once this
option is enabled, it kicks off the Avaya IP station data collection.
Note This feature depends on the Terminal Translation Initialization (TTI) Avaya CM feature
being enabled.
To enable Avaya IP station data collection:


2. In the Avaya CM panel, click the VKM Options button:

3. In the Avaya VKM Options panel, enter “mac” in the Search field to search for the MAC-
related VKM options:
Figure 6-3 Narrow Search

4. Two MAC-related VKM options should appear:
• enableStationMacData
• stationMacThreads
Figure 6-4 MAC Options

5. Right-click on the enableStationMacData and select Edit.
6. In the Edit VKM Options window, set enableStationMacData to true to enable it, and then
click Update:
Figure 6-5 Edit VKM Options

6.3 Define the Number of Threads for a Large Number of Stations
The stationMacThreads option performs an attribute collection on multiple stations at the same
time with 5 threads being the default. To achieve maximum performance for Avaya CM
installations that have a large number of stations, you can modify the number of threads that are
used to parallel process queries. Changing this option has no effect on background process
instances that are already running.
This is a two-part process:
Step One: Determine the Query Process Time
1. Navigate to Health > Elements:
Figure 6-6 Health > Elements

2. In the Elements panel, select Agents:
Figure 6-7 Agents

3. In the All Agents panel, select Local RIG:
Figure 6-8 Local RIG

4. In the Poll Functions panel, enter “mac” in the Search field to search for the MAC-related VKM
options:

5. Two MAC-related poll functions appear:
• Station MAC queries: This poll function shows how fast the queries are being processed.
• Average Station MAC queries execution: This poll function shows how long query
executions are taking on average per station. See the Current Value column to see the
average query length.
Based on the information gathered using these poll functions, you can calculate how long it
will take to process your stations.
For example, if there are 20,000 stations in your installation (each station taking about 5
seconds) and you have 5 threads, you can calculate that the entire process will take about 5
hours.

Step Two: Modify the stationMacThreads Option to Adjust Number of Threads for Larger
Installations

2. In the Avaya CM panel, click the VKM Options button:

3. In the Avaya VKM Options panel, enter “mac” in the search field to search for the MAC-
related VKM options:

4. Two MAC-related VKM options should appear:
• enableStationMacData
• stationMacThreads
Figure 6-13 MAC Options

5. Right-click on stationMacThreads and select Edit.
6. In the Edit VKM queries field, change the default value of 5 to your calculated value and click
Update:
Figure 6-14 Edit VKM Options

6.4 View TTI Station and Station MAC Data
To view TTI station and Station MAC data:
1. Navigate to Reports > Inventory > Avaya CM.
Figure 6-15 Reports > Inventory > Avaya CM

2. The Inventory panel, select these two options:
• TTI Station: This displays the stations that are connected to the Avaya CM but not logged in.
• Stations MAC data: This displays session MAC data for debugging purposes.
Figure 6-16 Station MAC Data and TTI Stations

3. Click TTI Stations to view TTI station inventory details:
Figure 6-17 TTI Stations

4. Click Station MAC Data to view station MAC data inventory details:
Figure 6-18 Station Mac Data

6.5 Confirm Avaya CM VKM Data Collections Were Correctly
Extracted
To confirm that all of your Avaya CM VKM data collections were correctly extracted into Nectar
UCMP, you can view a full inventory of the Avaya CM VKM. You can use this view to confirm that
all devices have been correctly captured in the system.
1. Navigate to Reports > Inventory > Avaya CM.
Figure 6-19 Reports > Inventory > Avaya CM

2. A list of inventory categories appears. You can click one of these to view details on the data
collected for this category. For more information on using inventory, see the RIG
Administration Guide.
Figure 6-20 Inventory

7. Configure Real Time QoS
If you are deploying Nectar Real-Time Quality Monitoring, we must enable that functionality. To
configure Real Time QoS for your Avaya CM VKM:
1. Navigate to Configure > Quality Management > Real Time QoS:
Figure 7-1 Configure Real Time QoS

The Real Time QoS window appears where you can make a variety of configurations:
Figure 7-2 Configure Real Time QoS
Note Do not start the receiver module until you have confirmed the settings described
below.

2. Configure the RTCP Categories.
Note The Avaya collections must be completely extracted in order for this to work. Check
the inventory as discussed in “This chapter discusses inventory-related tasks. It
includes these sections:” on page 39. Specifically, make sure the ipNetworkMap
and region tables are complete.
3. Set Enable Traces to True.

4. Set Receiver interface to the RIG IP address.
5. Leave the Receiver Port set to 5005.
6. The Default Codec is used to calculate the Mean Opinion Score (MOS) when sessions are
encrypted and the codec is not known to Nectar. If using encryption, set this to the codec
that applies to encrypted sessions.
7. Set Hop Name Lookup to Enabled. This will use DNS to show layer-3 device names in the trace
routes in addition to their IP addresses.
8. When Threshold Normalization is disabled, each metric in the Real-Time QoS Detail window
has its an absolute Y-axis scale. (The maximum values are: MOS=5, RTD=500ms, Jitter=500ms,
Loss=100%.) If enabled, each metric has a relative Y-axis scale, with the maximum observed
value becoming the maximum Y-axis value. This setting is your default view. You can toggle
between the absolute and relative Y-axis scales using the gear icon in the Real-Time QoS
Detail window.
9. Start the RTCP Receiver.

8. Reporting
Nectar has developed a group of standard reports for Avaya CM. In this section, we will
download the report pack from the Nectar Partner Portal, load it on the RIG, and schedule the
reports to run.
To obtain the Avaya CM VKM report pack.
1. Login to the Nectar Partner Portal.
2. Navigate to the Document Library.
3. Locate the Tech Docs-6 Reporting folder.
4. Download the acmReports file.

This section includes the following tasks:
• Load Report Packs
• Apply Company Logo
• Schedule a Report
• Report Retention
• Terminate a Report
• Email a Report
8.1 Load Report Packs

1. Right-click in the Report Name pane and select Report Packs > Load Report Pack from the
menu:
Figure 8-1 Load Report Pack

The Open window appears:
Figure 8-2 Open Window

2. Browse to the Avaya report pack that you previously downloaded and click Open to load the
reports.
8.2 Apply Company Logo

The ACM Report Pack you download from the Nectar Partner Portal will include the Nectar logo.
After you upload the report pack to the RIG, refer to the RIG Administration Guide for instructions
on applying your company logo.
After you apply your logo, Nectar recommends that you download the reports into a new report
pack (Select All > right-click > Report Packs > Save Report Pack). This will now become your
master Avaya report pack, complete with your company logo. This helps you avoid manually
changing the logos with every RIG that you deploy.

8.3 Schedule a Report
By default, the reports you have just uploaded will be disabled. You will need to enable and
schedule them in order for them to run.
Note You must schedule and enable each report individually.
Follow these steps to schedule a report:

1. Select a report and click on the Schedule tab.
2. In most cases, a schedule will already be assigned (daily/weekly/monthly). If this is the case,
right-click on the schedule and select Enable to enable the report. If no schedule is present,
continue with the steps below.
3. Right-click within the Schedules pane and select Add.
Figure 8-3 Add Schedule

The Add Report Schedule window appears:
Figure 8-4 Add Report Schedule

4. Define the following parameters for automatic report generation:
Parameter Description
Report Mode Set as Daily, Weekly, or Monthly.

Hour of Day Enter the hour that the report generator begins to collect data.
Weeks Between/Days Enter the number of days/weeks to lapse before the report generates
Between again.
Day of the Week • This is for Weeks only.
• Select the day of the week to generate the report.
Day of the Month • This is for Months only.
• Select First Day, Last Day, or a date between 1 and 31.
Table 8-1 Automatic Report Generation
5. Click Add to commit data.

The details appear in the Schedules pane.
Figure 8-5 schedule Details

6. Right-click the schedule and select Enable from the drop menu.

Figure 8-6 Enable Schedule
The Next Time Text field displays the future time that the report will run.
Figure 8-7 Next Time Text

7. Right-click the schedule to view menu options:
Option Description
Add Select to a new report schedule.

Edit Select to modify the schedule as needed.
Remove Select to delete the schedule.
Enable Select to enable the report schedule.
Disable Select to keep the report schedule but stop report generation.
Table 8-2 Menu Options

8.4 Report Retention
Follow these steps to manage report retention:
1. Select a report and confirm that the Previous Reports tab is selected.
Figure 8-8 Previous Reports Tab

2. At the bottom of the page, click the Edit icon to maintain the report retention.
Figure 8-9 Report Retention

3. The Report Retention Properties window appears. Here you can define the number of reports
to have on a file at a time. The default is set to 1. Define the following:
Option Description
Retain last x reports Enter the number of previous reports you want to retain.
Retain reports for x weeks Enter the number of weeks for which you want to retain reports.
Note Newly generated reports replace the oldest report as per the Retained…
parameter set.
4. Click Update to commit changes.
Figure 8-10 Report Retention Properties

8.5 Terminate a Report
If a report does not complete and is stuck in the executing status, follow these steps to terminate
a report:
1. Select the report you want to terminate under Reports:
2. Right click and select Terminate Report.
Figure 8-11 Terminate Report

8.6 Email a Report
You can receive/distribute scheduled reports automatically through email. To configure SMTP
refer to the “Configure an SMTP Server on a RIG” section in the RIG Administration Guide.
Once SMTP has been configured on the RIG, follow these steps to add an email address:
1. You must the Schedule tab to display the Emails pane.
2. Right-click within the Emails pane and select Add.
Figure 8-12 Add Email Address

3. Enter the email address using this format: name@company.com.
4. Click Add.
The address appears within the Email Address list.
5. Right-click the email address to edit or delete.


ACM Deployment Guide v1.2

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

ACM Deployment Guide v1.2

Enviado por

Direitos autorais:

Formatos disponíveis

Nectar UCMP Deployment Guide

for Avaya® Communication

PROPRIETARY AND CONFIDENTIAL

Copyright 2013-2016 Nectar Services Corp. ii ACM Deployment Guide v1.2

1.1 February 2016 Tonya Migrated old documentation to All

Copyright 2013-2016 Nectar Services Corp. iv ACM Deployment Guide v1.2

Copyright 2013-2016 Nectar Services Corp. v ACM Deployment Guide v1.2

1.1 About this Document

1.3 Supported Software Versions

1.4 Technical Support

Copyright 2013-2016 Nectar Services Corp. 6 ACM Deployment Guide v1.2

Copyright 2013-2016 Nectar Services Corp. 7 ACM Deployment Guide v1.2

2.1 Configure a SAT Login for the RIG (ACM v3)

Copyright 2013-2016 Nectar Services Corp. 8 ACM Deployment Guide v1.2

2.2 Configure RIG Maintenance Web Login (4.x and higher)

Figure 2-2 Administrator > Server (Maintenance)

Copyright 2013-2016 Nectar Services Corp. 9 ACM Deployment Guide v1.2

Figure 2-3 Add a new access-profile group

Copyright 2013-2016 Nectar Services Corp. 10 ACM Deployment Guide v1.2

Figure 2-5 Turn on Categories

Copyright 2013-2016 Nectar Services Corp. 11 ACM Deployment Guide v1.2

Figure 2-6 Set Permissions

Copyright 2013-2016 Nectar Services Corp. 12 ACM Deployment Guide v1.2

Figure 2-7 Select Launch Maintenance Web Interface

Copyright 2013-2016 Nectar Services Corp. 13 ACM Deployment Guide v1.2

2.4 Prepare Communication Manager’s Firewall (ACM v4 and

Follow these steps to prepare for the Avaya CM firewall:

Figure 2-9 Select Server (Maintenance)

Copyright 2013-2016 Nectar Services Corp. 14 ACM Deployment Guide v1.2

Figure 2-10 Enable SNMPTrap

Copyright 2013-2016 Nectar Services Corp. 15 ACM Deployment Guide v1.2

Figure 2-11 Prepare Firewall

5. Click the Submit button after making changes.

Copyright 2013-2016 Nectar Services Corp. 16 ACM Deployment Guide v1.2

Figure 2-12 SNMP Traps

Figure 2-13 SNMP Traps

Copyright 2013-2016 Nectar Services Corp. 17 ACM Deployment Guide v1.2

Figure 2-15 SNMP Trap Alarms

Copyright 2013-2016 Nectar Services Corp. 18 ACM Deployment Guide v1.2

Figure 2-16 Alarm Filters

Figure 2-17 Add or Change Alarm Filters

Copyright 2013-2016 Nectar Services Corp. 19 ACM Deployment Guide v1.2

Figure 2-18 Agent Status

Figure 2-19 Agent Status

Figure 2-20 SNMP Test

Copyright 2013-2016 Nectar Services Corp. 20 ACM Deployment Guide v1.2

Figure 2-22 SNMP Test Results

Figure 2-23 SNMP Test Results

Copyright 2013-2016 Nectar Services Corp. 21 ACM Deployment Guide v1.2

Figure 2-24 Forwarding

2.10 Replicate Efforts for All Other Instances of Avaya CM

Copyright 2013-2016 Nectar Services Corp. 22 ACM Deployment Guide v1.2

Configuring Avaya CM VKM involves performing these tasks:

3.1 Avaya CM VKM Options

3.1.1 View Avaya CM VKM Options

Figure 3-1 Modules > Avaya > CM

Copyright 2013-2016 Nectar Services Corp. 23 ACM Deployment Guide v1.2

Figure 3-2 VKM Options

Figure 3-3 Verify VKM Options

Copyright 2013-2016 Nectar Services Corp. 24 ACM Deployment Guide v1.2

Figure 3-4 Edit Avaya CM VKM Options

Figure 3-5 Edit VKM Option

Copyright 2013-2016 Nectar Services Corp. 25 ACM Deployment Guide v1.2

VKM Option Value Description