ACM Deployment Guide

Overview

This guide explains how to activate, deploy, and configure the monitoring and management of Avaya CM using the Nectar Avaya CM VKM, a core component of Nectar Foundation.

The screens or graphics used in this document are from the Avaya Aura ® Communication Manager Release 8--earlier versions are similar but may differ in screen appearance and navigations.

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 Foundation.

For detailed information on performing Nectar RIG operation tasks, such as using dashboards and dependency trees, see the Remote Intelligence Gateway (RIG) Administration Guide.

Supported Software Versions

• Nectar v8.7
• Avaya Aura Communication Manager r8 and above

Prepare an Avaya CM for UCMP

Before Nectar UCMP 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.

Configure RIG Maintenance Web Login and 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..

• Configure RIG Maintenance Web Login and Confirm Communication Manager’s Firewall. This section provides the following:

Configure RIG Maintenance Web Login

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.

Confirm Communication Manager’s Firewall

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

Configure AES Server for SMS-API access

Configure RIG Maintenance Web Login

Follow these steps to configure the RIG Maintenance Web login:

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

Figure 2-1 Administrator > Server (Maintenance)

1. Navigate to Security > Administrator Accounts.
2. In the Administrator Accounts web page, select the Add Group radio button, then select

Submit.

1. In the Administrator Accounts -- Add Group web page ( Figure 2-2), select the Add a new access-profile group: radio button, then select any available profile from 20 to 69 from the drop-down menu.
2. Select Submit. You should receive a confirmation page stating, “- The add was successful for group: prof20.”.

Figure 2-2 Add a New Access-Profile Group

1. Navigate to the Administrator Accounts web page and select the SAT Access Only radio button, then select Submit.

Figure 2-3 Enter Login and Password

1. In the Administrator Accounts -- Add Login: SAT Access Only page ( Figure 2-4), provide data for the following fields:
   1. Login Name (e.g., Profile 20)

Enter Password.

Re-enter Password.

1. Accept all other defaults.
2. Click Submit.

Figure 2-4 Add Login: SAT Access Only

1. 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):

• 
  
  1. Enter the following command to change the new user profile:

change user-profile-by-category 20

• 
  
  1. Turn on categories as shown here:

Figure 2-5 Turn on Categories

• 
  
  1. 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

1. 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.

Confirm Communication Manager’s Firewall

Note

Avaya CM version 6 and higher does not require a firewall configuration.

Follow these steps to confirm 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-7 Select Server (Maintenance)

Note

The default firewall rules are made generic, yet safe, to allow for operation without the need to alter the firewall settings. New listening ports will be automatically opened in the firewall as they are needed.

1. Navigate to the Firewall section under Security and confirm SNMPTrap (outbound UDP port 162) and SNMP (inbound UDP port 161) are listed.

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 alarms from Avaya CM to the RIG.

Figure 2-8 Firewall rules

Enable SNMP on Communication Manager

Follow these steps to enable SNMP on Avaya CM:

1. Select Access under the SNMP section.
2. The Access page will display, to configure SNMP Communities/Users, select the Add/Change

button.

1. In the Add SNMP Users / Communities page (, 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-9 Enable SNMP

1. 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.

1. Click the Submit button after making changes.

Designate SNMP Trap Destinations to the RIG

After the SNMP has been enabled on Avaya CM, follow these steps to designate trap destinations to the RIG:

1. Navigate to the FP Traps section under SNMP.

Figure 2-10 SNMP Traps

1. In the FP Traps page, select Add/Change.

1. Enter the IP address of the RIG server, select SNMP version 1 or SNMP version 2c, and enter n3ctrTrap for the Community name. (For SNMP version 2, select trap as the Notification type in the drop menu.)

Notes

The community name is important since it will be entered into the RIG as well.

If SNMP version 3 is used, make sure the Receiver module in the RIG is administered to accept v3 traps.

Figure 2-11 SNMP Traps

1. In the SNMP Traps page, you can specify alarms to be sent as traps. For more information, see

Configure Alarm Filters on Communication Manager.

Configure Alarm Filters on Communication Manager

After the trap destinations have been designated tot he RIG, follow these steps to configure Avaya CM alarm filters.

1. Navigate to the FP Filters section under SNMP. This section ensures that all alarms, errors, and warnings have been selected.

Figure 2-12 Alarm Filters

1. In the FP Filters pane, select the plus (+) sign next to the active filter if you wish to make changes to, or delete individual FP Filters, as shown in Figure 2-13.
   1. Select your changes, then select the Change button as shown in Figure 2-14.

Figure 2-13 FP Filters

1. To add an FP Filter make your selections first, then select Add button, as shown in Figure 2-14.

Figure 2-14 Add FP Filter

Finalize the SNMP Configuration

After you have configured the Avaya CM alarm filters, follow these steps to finalize the SNMP configuration:

1. Navigate to the Agent Status section under SNMP.

You are now ready to turn up SNMP by stopping and starting the service.

1. Click Stop Master Agent; then select Start Master Agent to restart the service. All Agents should display an UP status.

Figure 2-15 Agent Status

1. Navigate to the FP Trap Test section under SNMP.
2. Within the SNMP Test page, click the Generate Test Trap button:

Figure 2-16 SNMP Test

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-17 SNMP Test Results

Within the Nectar UCMP RIG Event Console, you will see a copy of the Avaya CM test alarm:

Figure 2-18 SNMP Test Results

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.
   • The Default Server Port value of 5005 does not need to be modified.
   • The Default RTCP Report Period (secs) does not need to be modified.

Configure AES Server for SMS-API access

This section is required and covers configuring the Application Enablement Services (AES) for SMS- API access.

These steps are required prior to chapter 4 of this document: Configure Aura CM VKM.

Enter SMS Properties

1. Log in to AES web page.
2. Navigate to AE Services>SMS>SMS Properties.
3. Make the following entries as shown in graphic below:

1. Click Apply Changes.

Figure 2-19 Avaya AES SMS Properties

NOTE

This administration of the OSSI connection to CM provides a pass-through to CM. The credentials supplied in the VKM administration are the credentials created in CM. No credentials are used in AES for this service.

Configure Avaya CM VKM

Note

This section 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:

Enable Avaya CM and Real Time Phone QoS Collector

Avaya CM VKM Options

Connect Avaya CM VKM for Deployment

Enable Avaya CM and Real Time Phone QoS Collector

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.

Follow these steps to enable the Avaya CM VKM module:

1. Navigate to RIG > Module Configuration.

The Module Configuration window appears.

1. Select the Avaya CM check box under Standard Modules, then select the Real Time Phone QoS Collector check box under the Premium Modules.

Figure 3-1 Activate Avaya CM VKM

1. Click Apply.
2. To restart the RIG and apply the changes:
   1. Navigate to RIG > Admin > Restart.
   2. When the following message appears, click Yes.

Figure 3-2 Restart

Avaya CM VKM Options

This section explains how to:

View Avaya CM VKM Options

Avaya CM VKM Option Descriptions and Values

Connect Avaya CM VKM for Deployment

View Avaya CM VKM Options

Follow these steps to view the Avaya CM VKM options:

1. Navigate to Modules > Avaya > CM:

Figure 3-3 Modules > Avaya > CM

1. In the left pane, select VKM Options:

Figure 3-4 VKM Options

1. In this window, verify that the appropriate VKM options are selected:

Figure 3-5 Verify VKM Options

Avaya CM VKM Option Descriptions and Values

This section defines the various Avaya CM VKM options and their values:

Table 3-1 Avaya CM VKM Options

Table 3-1 Avaya CM VKM Options

Table 3-1 Avaya CM VKM Options

Edit Avaya CM VKM Options

Follow these steps to edit Avaya CM VKM options:

1. Select an Avaya CM VKM option, right-click, then select Edit from the menu:

Figure 3-6 Edit Avaya CM VKM Options

Depending on the VKM option selected, an Edit VKM Option window appears where you can change the value of the option.

1. Click Update when you are done.

Figure 3-7 Edit VKM Option

Connect Avaya CM VKM for Deployment

Follow these steps to connect the Avaya CM VKM:

1. Navigate to Modules > Avaya > CM.
2. In the left pane, select CM Connection Wizard:

Figure 3-8 CM Connection Wizard

The following Avaya CM Onboarding Wizard window appears.

Figure 3-9 Avaya CM Onboarding Wizard

1. Enter the following details relating to the location of the Avaya CM you are onboarding to UCMP; then click Next.

Table 3-2 Parameters

UCMP contacts the Avaya CM server to obtain version and survivable processor information.

1. Inspect the processors for inclusion; then click Next.

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.

Wait for the system to test the connections.

1. When the connections are ready, you will see a message similar to the following; click Finish.

Figure 3-10 Connections Ready

The following message appears when the CM connection wizard is complete.

Figure 3-11 CM Connection Wizard Complete

Configure Aura CM VKM

This section is required if you wish to take advantage of Nectar’s enhanced Vector monitoring. This module uses Avaya Application Enablement Server (AES) System Management Service (SMS) API, as well as SNMP requests to communicate with Avaya CM server.

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 Configure AES Server for SMS-API access. (Section 2.8 of this document)

Configuring Nectar’s Aura CM involves performing these tasks:

Enable Aura CM

Onboarding Aura CM

Aura CM Options

Enable Vector Flow

Navigating Vector Information

Enable Aura CM

Follow these steps to enable the Aura CM module:

1. Navigate to RIG > Module Configuration.

The Module Configuration window appears.

1. Select the Aura CM (r7.0 or above) check box under Standard Modules.

1. Click Apply.

Figure 4-1 Activate Aura CM

1. To restart the RIG and apply the changes:
   1. Navigate to RIG > Admin > Restart.
2. Click Yes.

Onboarding Aura CM

Follow these steps to onboard the Aura CM module:

1. Navigate to Modules > Avaya > Aura CM (r7.0 or above):

Figure 4-2 Modules > Avaya > Aura CM

1. Select the Configurations tab, then click Add.

Figure 4-3 Add Avaya Aura CM

The Add Avaya Aura CM Connection window will appear.

NOTE

With Aura CM you are allowed to have more than one CM per RIG (unlike the previous version where you were limited to one CM per RIG

1. Complete the fields in the General tab.

Figure 4-4 Add Avaya Aura CM Connection Window

The table below provides a description of the fields in this General tab:

Table 4-1 General Fields when adding an Aura CM connection

1. Click on the SNMP tab and complete the applicable fields.

NOTE

The SNMP tab is for the Communication Manager (CM)

Figure 4-5 SNMP tab

The table below provides a description of the fields in this SNMP tab:

1. Click OK.

Table 4-2 SNMP Fields when adding an Aura CM connection

You should now see your CM listed in the Configurations window. As mentioned above, you may have more than one CM per RIG.

Aura CM Options

This section explains how to:

View Aura CM Options

Avaya CM VKM Option Descriptions and Values

View Aura CM Options

Follow these steps to view the Aura CM options:

1. Navigate to Modules > Avaya > Aura CM (r7.0 or above):

Figure 4-6 Modules > Avaya > Aura CM

1. Select VKM Options. From here, you can verify that the appropriate VKM options are selected.

Figure 4-7 Verify VKM Options

Aura CM Option Descriptions and Values

This section defines the various Aura CM options and their values:

Table 4-3 Aura CM VKM Options

Enable Vector Flow

Follow these steps to enable Vector Flow:

1. Left-click VKM Options.
2. Select the enableVectorFlow line item, right-click, then select Edit from the menu:

Figure 4-8 VKM Options

1. Change the enableVectorFlow option to ‘true’.
2. Click Update.

Figure 4-9 Edit VKM Option

Navigating Vector Information

The following section shows how to:

View Vector Flow

View Vector Events

Modify Vector Events

View Dependency Trees

View and Search within Vector Inventory

View Vector Flow

Follow these steps to view Vector Flow.

1. Click the Configurations tab
2. Select the applicable onboarded Aura CM module.
3. Click on View Vector Flow.

Figure 4-10 View Vector Flow

A table containing the Vector numbers and corresponding names will appear.

Figure 4-11 Vector Flow List

Each of the Vectors have a corresponding diagram.

1. To view the diagram for any corresponding vector, simply right-click on the corresponding vector and select the appropriate option.

Figure 4-12 Vector Flowchart Options

NOTE

Nectar maintains three generations of a vector (current, previous, grandfather)

Below is an example of a generated vector flowchart.

Figure 4-13 Vector Flowchart

The chart below contains explanations of the available flowcharts:

Table 4-4 Vector Flowchart Options

View Vector Events

1. Navigate to Modules>Avaya>CM

Figure 4-14 Modules>Avaya>CM

1. Click on the Advanced Processor Setup option

Figure 4-15 Advanced Processor Setup

1. Select Main (line item)

Figure 4-16 Main Line Item

1. Click on View Dropdown.
2. Select Vector Events.

Figure 4-17 View Vector Events

A list of Vector events will populate for you to view.

Modify Vector Events

1. Navigate to Modules>Avaya>CM

Figure 4-18 Modules>Avaya>CM

1. Click on the Vector Events Rules option

Figure 4-19 Vector Events Rules

1. Right-click the appropriate event and click Edit

Figure 4-20 Edit Event Rule Setup

You can view the current Event Rules here and make any necessary edits to these rules

1. Click OK

Figure 4-21 Edit Vector Event Rule

View Dependency Trees

1. Navigate to Configure>Dependency Trees

Figure 4-22 Configure Dependency Trees

1. Using the search/filter box, type ‘Vector’ to filter the list to show Vector dependency trees

Figure 4-23 Filter Vector Dependency Trees

View and Search within Vector Inventory

1. Navigate to Reports>Inventory>Aura CM

Figure 4-24 Reports>Inventory>Avaya>AuraCM

1. Click on the appropriate report to view.

Vectors

Figure 4-25 Inventory - Vectors Example

Vector Steps

Vector Variables

Figure 4-26 Inventory - Vector Steps Example

Figure 4-27 Inventory - Vector Variables Example

VDN

VDN Variables

Figure 4-28 Inventory - VDN Example

Figure 4-29 Inventory - VDN Variables Example

View Data Collection Extractions

Each data collection can be enabled, disabled and change the frequency at which the collection occurs.

This section provides the following:

View Extractions

Extraction Element Menu Options

Run Process Now

View Extractions

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

1. Navigate to Modules > Avaya > CM:

Figure 5-1 Modules > Avaya > CM

1. In the left pane, select Extraction Status:

Figure 5-2 Extraction Status

1. If the Avaya CM server onboarding is working properly, you will see extractions begin to populate this window:

Note

• The top pane shows process collections, while the bottom pane shows process alignments (creation of monitoring elements and processing of changes from previous collections).
• Collections run nightly (active discovery) to refresh the inventory.

Figure 5-3 Extractions Occurring

Extraction Element Menu Options

Right-click on an extraction element to view the following options:

Figure 5-4 Options

Table 5-1 Parameters

Run Process Now

Table 5-1 Parameters

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 pane and select Run Process Now. This will immediately run the process to align it with the collection above.

Figure 5-6 Run Process Now

Advanced Processor Setup

This section includes the following:

View Advanced Processor Setup

View Processor Task Failures

View Advanced Processor Setup

Follow these steps to view Avaya CM VKM processes and details:

1. In the left pane, select Advanced Processor Setup:

Figure 6-1 Advanced Processor Setup

1. In this window, you can view the processes and details as they are running:

Figure 6-2 View Processes Running

View Processor Task Failures

Follow these steps to view process failures for a given processor:

1. Highlight a processor.
2. Click the View button and select Task Failures from the menu. A list of task failures for this processor appears:

Figure 6-3 Processor Task Failures

Inventory Tasks

This section discusses inventory-related tasks, including:

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

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:

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.

SNMP must be enabled. For more information on enabling or configuring SNMP, refer to Section

3.3 Connect Avaya CM VKM for Deployment.

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.

Follow these steps to enable Avaya IP station data collection:

1. Navigate to Modules > Avaya > CM:

Figure 7-1 Modules > Avaya > CM

1. In the Avaya CM pane, click the VKM Options button:
2. In the Avaya VKM Options pane, enter “mac” in the Search field to search for the MAC- related VKM options:

Two MAC-related VKM options should appear:

enableStationMacData

stationMacThreads

1. Select enableStationMacData, then right-click and select Edit.
2. In the Edit VKM Options window, set enableStationMacData to true to enable it, and then click Update:

Figure 7-2

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 7-3 Health > Elements

1. In the Elements pane, select Agents:
2. In the All Agents pane, select Local RIG:
3. In the Poll Functions pane, enter mac in the Search field to search for the MAC-related VKM options:

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.

Figure 7-4 Poll Functions

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

1. Navigate to Modules > Avaya > CM:

Figure 7-5 Modules > Avaya > CM

1. In the Avaya CM pane, click the VKM Options button:
2. In the Avaya VKM Options pane, enter “mac” in the search field to search for the MAC- related VKM options:

Two MAC-related VKM options should appear:

enableStationMacData

stationMacThreads

1. Select enableStationMacData, then right-click and select Edit.
2. In the Edit VKM queries field, change the default value of 5 to your calculated value and click

Update:

Figure 7-6 Edit VKM Options

View TTI Station and Station MAC Data

Follow these steps to view TTI station and Station MAC data:

1. Navigate to Reports > Inventory > Avaya > CM.

Figure 7-7 Reports > Inventory > Avaya CM

1. In the Inventory pane, select these two options:
   • TTI Stations: View the stations that are connected to the Avaya CM but not logged in.
   • Stations MAC data: View the session MAC data for debugging purposes.

Figure 7-8 Station MAC Data and TTI Stations

1. Click TTI Stations to view TTI station inventory details:

Figure 7-9 TTI Stations

1. Click Stations MAC Data to view station MAC data inventory details:

Figure 7-10 Station Mac Data

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.

A list of inventory categories appears ( Figure 7-11).

1. 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 7-11 Inventory

8.Configure Real Time QoS

If you are deploying Nectar Real-Time Quality Monitoring, we must enable that functionality. Follow these steps to configure Real Time QoS for your Avaya CM VKM:

1. Navigate to Configure > Quality Management > Real Time QoS:

Figure 8-1 Configure Real Time QoS

The Real Time QoS window appears where you can make a variety of configurations:

Figure 8-2 Configure Real Time QoS

Note

Do not start the receiver module until you have confirmed the settings described below.

1. Configure the RTCP Categories.

Note

The Avaya collections must be completely extracted in order for this to work. Check the inventory as discussed in Inventory Tasks. Specifically, make sure the ipNetworkMap and region tables are complete.

1. Set RTCP Receiver to Enabled.
2. Set Traces to Enabled.
3. Set Receiver interface to the RIG IP address.
4. Leave the Receiver Port set to 5005.
5. 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.
6. 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.
7. 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.
8. Set PQOS RTCP Remote address to Disabled.
9. Click Apply.

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.

This section includes the following tasks:

Download Avaya Report Pack

Load Report Packs

Apply Company Logo

Report Retention

Enable a Report

Edit a Report Schedule

Create a Report Schedule

Remove a Report

Terminate a Report

Email a Report

Download Avaya Report Pack

Follow these steps to download 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.

Load Report Packs

Follow these steps to upload report packs from your computer.

1. Navigate to Reports > Report Manager.
2. Right-click on a report name and select Report Packs > Load Report Pack.

The Open window appears:

Figure 9-1 Load Report Pack

Figure 9-2 Open Window

1. Browse to the Avaya report pack that you previously downloaded and click Open to load the reports.

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.

Report Retention

Follow these steps to manage report retention.

1. Navigate to Reports > Report Manager.

The Report Manager - Reports window appears.

1. Select a report name; then click Edit. The Edit Report window appears.

Figure 9-3 Edit Poller Export Report

1. Define the number of reports to have on file at a time using the following:

Table 9-1 Report Retention Properties

1. Click OK.

Enable 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 enable a report.

1. Navigate to Reports > Report Manager.

The Report Manager - Reports window appears.

1. Click on the Schedules tab.

A list of reports appears. Notice the schedule for each report in the Frequency column.

Figure 9-4 Report Manager

1. In most cases, a schedule will already be assigned (daily/weekly/monthly). If this is the case, right-click on a schedule and select Enable to enable the report.

Note

You can also select a report; then right-click and select Disable to disable the

report.

• 
  
  • If no schedule is present, see Create a Report Schedule.
  • To create a different schedule for a report, see Edit a Report Schedule.

Edit a Report Schedule

Follow these steps to edit a report schedule.

1. Navigate to Reports > Report Manager.

The Report Manager - Reports window appears.

1. Click on the Schedules tab.
2. If you wish to create a different schedule for a report, select the report and schedule; then click Edit.

The Edit Report Schedule window appears.

Figure 9-5 Edit Report Schedule

1. Define the following parameters:

1. Click OK.

Table 9-2 Parameters

The details appear in the Schedules pane.

1. Right-click on the report and select Enable.

Figure 9-6 Enable a Report

The Next Time Text field displays the future date and time that the report will run.

Create a Report Schedule

Follow these steps to create a new report schedule. You can assign multiple schedules to a report.

1. Navigate to Reports > Report Manager.
2. Click on the Schedules tab.
3. Click Add (above the Name column).

The Add Report Schedule window appears.

Figure 9-7 Add Report Schedule

1. Select a Report for the new schedule using the drop-down.
2. Use the parameters in Table 9-2 to complete the remaining Report Schedule fields.
3. Click OK.

Remove a Report

Follow these steps to remove a report you no longer want to use.

• 
  
  • 
    
    1. Navigate to Reports > Report Manager.

The Report Manager - Reports window appears.

• 
  
  • 
    
    1. Select the report you want to remove; then click Remove. The Confirm Remove Report window appears.

• 
  
  • 
    
    1. Click Yes.

Figure 9-8 Confirm Remove Report

• 
  
  1. Terminate a Report

Follow these steps to terminate a report that is executing.

1. Navigate to Reports > Report Manager.

The Report Manager - Reports window appears.

1. From the Reports tab, select the report you want to terminate.
2. Click the Progress tab.
3. Select the report; then right-click and select Cancel. The report is terminated.
   1. Email a Report

You can receive/distribute scheduled reports automatically through email. Follow these steps to add an email address to a report.

1. Navigate to Reports > Report Manager.

The Report Manager - Reports window appears.

1. Click the Schedules tab to view the Emails pane.
2. Select a report; then click Add in the Emails pane. The Edit Email Destination window appears.
3. Enter the email address using this format: name@company.com.
4. Click OK.

The new email address appears within the Email Address list.

• 
  
  • To edit, select the email address; then click Edit and make changes.
  • To remove, select the email address; then click Remove.

Figure 9-9 Email Report

10.Optional Vector Event Monitoring

This function is only available as of Nectar UCMP r8.1—by default, this function is disabled.

1. To enable, navigate to Modules > Avaya > CM.
2. Select Extraction Status from the Avaya CM menu pane on the left.
3. In the top pane of the Avaya Extraction Status window, locate and select the vectorEvent; then right-click and select Enable.
   1. This process is time consuming and runs nightly; results can be checked the following day.

Figure 10-1 vectorEvent

1. To view results, navigate to Modules > Avaya > CM > Advanced Processor Setup.
2. Select the Main Avaya Media Server.
3. Locate and click on the View drop-down list, then select Vector Events from the list.
   1. This shows you all current Vector Events extracted from the ACM.

Figure 10-2 View Vector Events

1. Navigate to Configure > Dependency Trees.
   1. You will see several trees with “Vector” as the prefix; double-click one to view the tree. Note that all are set to “Quiet”, and will not notify the NOC. These are information only, and not something the NOC would respond to.
   2. If you consider any of these trees important to the NOC, then set the Event Type: to Normal. To set it, select the tree, right-click and select Edit; then select Normal from the Event Type: drop-down list.
   3. Click OK.

Figure 10-3 Vector Dependency Trees

1. To view additional information on Vector Events, navigate to the Health > Events. In the Events

window you will see the following information provided by the ACM:

• 
  
  1. Sub-Device Name-"Vector/Step"
  2. Param 1-"Event Type"
  3. Param 2-"Event Data 2"
  4. Param 3-"First Occurred"
  5. Param 4-"Last Occurred"
  6. Param 5-"Event Count"