---
title: "ACM Deployment Guide"
slug: "acm-deployment-guide-1"
updated: 2022-06-06T20:58:17Z
published: 2022-06-06T20:58:17Z
canonical: "support.nectarcorp.com/acm-deployment-guide-1"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.nectarcorp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](/docs/acm-deployment-guide-1#_bookmark10) and [After the profile is created, you must log in to the](/docs/acm-deployment-guide-1#_bookmark13) [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](/docs/acm-deployment-guide-1#_bookmark13) [domain.](/docs/acm-deployment-guide-1#_bookmark13).

- [***Configure RIG Maintenance Web Login***](/docs/acm-deployment-guide-1#_bookmark10) and [***Confirm Communication Manager’s Firewall***](/docs/acm-deployment-guide-1#_bookmark14). This section provides the following:

###### [Configure RIG Maintenance Web Login](/docs/acm-deployment-guide-1#_bookmark10)

###### [After the profile is created, you must log in to the Avaya SAT terminal of the main/active](/docs/acm-deployment-guide-1#_bookmark13) [processor and run a save translations all command to replicate the new login to other ESS and](/docs/acm-deployment-guide-1#_bookmark13) [LSP processors (if available) within the Avaya domain.](/docs/acm-deployment-guide-1#_bookmark13)

###### [Confirm Communication Manager’s Firewall](/docs/acm-deployment-guide-1#_bookmark14)

###### [Enable SNMP on Communication Manager](/docs/acm-deployment-guide-1#_bookmark15)

###### [Designate SNMP Trap Destinations to the RIG](/docs/acm-deployment-guide-1#_bookmark16)

###### [Configure Alarm Filters on Communication Manager](/docs/acm-deployment-guide-1#_bookmark17)

###### [Finalize the SNMP Configuration](/docs/acm-deployment-guide-1#_bookmark18)

###### [RTCP Forwarding Configuration](/docs/acm-deployment-guide-1#_bookmark19)

###### [Configure AES Server for SMS-API access](/docs/acm-deployment-guide-1#_bookmark20)

### 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:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-h7l9zz44.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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*](/docs/acm-deployment-guide-1#_bookmark11))**,** 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.**”.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-64znof0m.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-8vg6kzvy.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 2-3 Enter Login and Password*

1. In the **Administrator Accounts -- Add Login: SAT Access Only** page ( [*Figure 2-4*](/docs/acm-deployment-guide-1#_bookmark12)), 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**.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-4fqak3ha.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-73sff3d1.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-z4vkmy8k.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-5nw7pr89.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-2ftuqdop.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-8leb0xdt.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-ymtqm3zu.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 2-10 SNMP Traps*

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-tc37jaqa.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-8lcrcvge.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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](/docs/acm-deployment-guide-1#_bookmark17).

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-czmn7y6x.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-tfq70cyp.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-q0osltyi.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-3gpg81qp.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-loz30dm0.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-oexnan95.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 2-17 SNMP Test Results*

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-s775lraf.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-hq8ejrzq.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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](/docs/acm-deployment-guide-1#_bookmark23)

###### [Avaya CM VKM Options](/docs/acm-deployment-guide-1#_bookmark24)

###### [Connect Avaya CM VKM for Deployment](/docs/acm-deployment-guide-1#_bookmark27)

### 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***](/docs/acm-deployment-guide-1#_bookmark9)*.*

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.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-5wxqcujd.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-74p1flhj.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 3-2 Restart*

### Avaya CM VKM Options

This section explains how to:

###### [View Avaya CM VKM Options](/docs/acm-deployment-guide-1#_bookmark25)

###### [Avaya CM VKM Option Descriptions and Values](/docs/acm-deployment-guide-1#_bookmark26)

###### [Connect Avaya CM VKM for Deployment](/docs/acm-deployment-guide-1#_bookmark27)

#### View Avaya CM VKM Options

Follow these steps to view the Avaya CM VKM options:

1. Navigate to **Modules > Avaya > CM**:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-5cbgvk6w.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 3-3 Modules > Avaya > CM*

1. In the left pane, select **VKM Options**:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-ljxq26xg.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 3-4 VKM Options*

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-egtigbrx.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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:

| **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, enhancedUnformatted, or custom | Expected format of received CDR records (must match Avaya CM configuration). |
| **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. |
| **cdrProcessingThreads** | 10 | Number of threads used to process CDR records. |
| **cdrSequenceNumber** |  | Sequence number for export files. |
| **cmDateFormat** | month/day or day/ month | Date format used in received CDR records (must match Avaya CM configuration) |
| **cmLocalTZ** | **cmLocalTZ** | Local time zone for CM server |

*Table 3-1 Avaya CM VKM Options*

| **VKM Option** | **Value** | **Description** |
| --- | --- | --- |
| **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. |
| **enableCallDetails** | false/true | 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. |
| **stationMacThreads** | 5 | Number of threads for station Mac queries |

*Table 3-1 Avaya CM VKM Options*

| **VKM Option** | **Value** | **Description** |
| --- | --- | --- |
| **valBoardPollerDefaultCollection Interval** | 900 | Announcement data is supplied from a report in the Avaya CM that is only 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. |

*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:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-ecj9bfch.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-1o0ag98x.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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**:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-ud9tza3v.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 3-8 CM Connection Wizard*

*The following* **Avaya CM Onboarding Wizard** *window appears.*

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-b5wvngcr.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

| **Parameter** | **Description** |
| --- | --- |
| **IP Address** | Enter the IP address for the Avaya CM to be onboarded. |
| **Type** | Select the connection type using the drop-down: - **SSH** - **Telnet** |
| **Port** | Enter the port, such as ***5022*** or ***5023***, depending on the connection type. |
| **Username/Password** | Enter the **Username** and **Password** for accessing the Avaya CM. |
| **SNMP Version** | Select the SNMP version from one of the following: - **V1** - **V2** - **V3** |
| **Port** | Enter the SNMP port, such as ***161***. |
| **Community** | Enter the community string previously configured. |
| **Authentication** | Select the authentication from one of the following: - **None** - **MD5** - **SHA** |
| **User ID** | Enter the User ID previously set up for the SNMP read only community string. |
| **Password** | Enter the password previously set up for the SNMP read only community string. |
| **Privacy Protocol** | Select the protocol from one of the following: - **None** - **DES** - **AES** - **AES-192** - **AES-256** ***Note:*** *Enabled for SNMP V3 only.* |
| **Privacy Password** | Enter the password for the Privacy Protocol. ***Note:*** *Enabled for SNMP V3 only.* |

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-zxx27zct.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 3-10 Connections Ready*

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-5q0wjr9e.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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***](/docs/acm-deployment-guide-1#_bookmark21). (Section 2.8 of this document)

Configuring Nectar’s Aura CM involves performing these tasks:

###### Enable Aura CM

###### [Onboarding Aura CM](/docs/acm-deployment-guide-1#_bookmark31)

###### [Aura CM Options](/docs/acm-deployment-guide-1#_bookmark32)

###### [Enable Vector Flow](/docs/acm-deployment-guide-1#_bookmark34)

###### [Navigating Vector Information](/docs/acm-deployment-guide-1#_bookmark35)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-4u0sidz4.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-5i2q0t69.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

### Onboarding Aura CM

Follow these steps to onboard the Aura CM module:

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-ki852cag.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-2 Modules > Avaya > Aura CM*

1. Select the **Configurations** tab, then click **Add**.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-hu0l97r1.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-35za1j0b.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-4 Add Avaya Aura CM Connection Window*

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

| **Field** | **Description** |
| --- | --- |
| Name | Provide a name for the CM |
| Description | Provide a description for the CM |
| Host | IP address for the host |
| Username | Username for the AES server. ***NOTE***: This is **NOT** the username for the CM. |
| Password | Password for the AES server |
| AES Host | IP address for the AES server |

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

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-eltwv8t6.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

***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:

| **Field** | **Description** |
| --- | --- |
| SNMP Version | Select the SNMP version from one of the following: - **V1** - **V2** - **V3** |
| Port | Enter the SNMP port, such as ***161***. Port is configurable and should match what is used on ACM Web Administration. |
| Community | Enter the community string previously configured. |

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](/docs/acm-deployment-guide-1#_bookmark33)

###### 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)**:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-r8gxf4d0.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-6 Modules > Avaya > Aura CM*

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-uinkzh3s.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-7 Verify VKM Options*

#### Aura CM Option Descriptions and Values

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

| **VKM Option** | **Value** | **Description** |
| --- | --- | --- |
| **cdrLegacy** | true/false | Enables receiving CDR’s using a configurable customized format for the Avaya CM server that is being monitored by Avaya CM VKM |
| **cdrProcessingThreads** | 10 | Number of threads used to process CDR records. |
| **cmDateFormat** | month/day or day/ month | Date format used in received CDR records (must match Avaya CM configuration) |
| **cmLocalTZ** | +0000 | This is case the Avaya CM server is configured for a different time zone than the RIG server. |
| **enableCallDetails** | false/true | Enables the sending of CDR records to the Call Detail module. |
| **enableVectorFlow** | false/true | Generates flowcharts for call vectors |
| **maxFailedConnectionAttempts** | Leave as default | Maximum number of AES SMS API request will be resubmitted if failed |
| **requestMangagerProcessorCount** | Leave as default | Number of threads used to process AES SMS API requests |
| **sessionIdEvictionTime** | Leave as default | AES SMS API session idle timeout |

*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:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-plj3qzp9.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-8 VKM Options*

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-u610t0fr.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-9 Edit VKM Option*

### Navigating Vector Information

The following section shows how to:

###### [View Vector Flow](/docs/acm-deployment-guide-1#_bookmark36)

###### [View Vector Events](/docs/acm-deployment-guide-1#_bookmark37)

###### [Modify Vector Events](/docs/acm-deployment-guide-1#_bookmark38)

###### [View Dependency Trees](/docs/acm-deployment-guide-1#_bookmark39)

###### [View and Search within Vector Inventory](/docs/acm-deployment-guide-1#_bookmark40)

#### 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**.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-cvub8xuv.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-10 View Vector Flow*

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-4sjhhala.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-yiea67hj.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-haqa8crz.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-13 Vector Flowchart*

The chart below contains explanations of the available flowcharts:

| **Flowchart Option** | **Definition** |
| --- | --- |
| View current flowchart | The current flowchart. |
| View previous flowchart | Anytime a change vector occurs, it goes from a current flowchart to a previous flowchart |
| View previous flowchart (grandfather) | Anytime a change vector occurs a second time, that vector’s flowchart is considered ‘grandfathered’ |
| Copy to Clipboard | Copies the entry in Vector Flow table to the clipboard |

*Table 4-4 Vector Flowchart Options*

#### View Vector Events

1. Navigate to **Modules>Avaya>CM**

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-0jy8frec.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-14 Modules>Avaya>CM*

1. Click on the **Advanced Processor Setup** option

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-mugpfkxk.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-15 Advanced Processor Setup*

1. Select **Main** (line item)

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-2p3h4xd1.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-16 Main Line Item*

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-jnwb91p0.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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**

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-7umkaycn.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-18 Modules>Avaya>CM*

1. Click on the **Vector Events Rules** option

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-tm749kos.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-19 Vector Events Rules*

1. Right-click the appropriate event and click **Edit**

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-coumfdef.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-qag7tjd2.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-21 Edit Vector Event Rule*

#### View Dependency Trees

1. Navigate to **Configure>Dependency Trees**

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-1xzrrew8.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-22 Configure Dependency Trees*

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-jvrec2db.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-23 Filter Vector Dependency Trees*

#### View and Search within Vector Inventory

1. Navigate to **Reports>Inventory>Aura CM**

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-95y218sa.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-24 Reports>Inventory>Avaya>AuraCM*

1. Click on the appropriate report to view.

##### Vectors

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-1vo1aozf.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-25 Inventory - Vectors Example*

##### Vector Steps

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-nel9yn37.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

##### Vector Variables

*Figure 4-26 Inventory - Vector Steps Example*

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-q2zmklw2.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 4-27 Inventory - Vector Variables Example*

##### VDN

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-tub0kh79.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

##### VDN Variables

*Figure 4-28 Inventory - VDN Example*

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-yjw3mj6d.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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](/docs/acm-deployment-guide-1#_bookmark42)

###### [Extraction Element Menu Options](/docs/acm-deployment-guide-1#_bookmark43)

###### [Run Process Now](/docs/acm-deployment-guide-1#_bookmark44)

### 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**:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-bdo86ab4.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 5-1 Modules > Avaya > CM*

1. In the left pane, select **Extraction Status**:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-sdyskrin.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-9qi2as7q.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 5-3 Extractions Occurring*

### Extraction Element Menu Options

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-szunk5w5.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 5-4 Options*

| **Parameter** | **Description** |
| --- | --- |
| **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. |

*Table 5-1 Parameters*

| **Parameter** | **Description** |
| --- | --- |
| **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***](/docs/acm-deployment-guide-1#_bookmark44). *Figure 5-5 Set Collect Hour* |

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-ol48hryw.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 5-6 Run Process Now*

## Advanced Processor Setup

This section includes the following:

###### [View Advanced Processor Setup](/docs/acm-deployment-guide-1#_bookmark46)

###### [View Processor Task Failures](/docs/acm-deployment-guide-1#_bookmark47)

### View Advanced Processor Setup

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

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-36bvtwgv.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 6-1 Advanced Processor Setup*

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-slgbmg16.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-corf80de.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 6-3 Processor Task Failures*

## Inventory Tasks

This section discusses inventory-related tasks, including:

###### [Collect Avaya IP Station Inventory](/docs/acm-deployment-guide-1#_bookmark50)

###### [Enable Avaya IP Station Data Collection](/docs/acm-deployment-guide-1#_bookmark51)

###### [Define the Number of Threads for a Large Number of Stations](/docs/acm-deployment-guide-1#_bookmark52)

###### [View TTI Station and Station MAC Data](/docs/acm-deployment-guide-1#_bookmark53)

###### [Confirm Avaya CM VKM Data Collections Were Correctly Extracted](/docs/acm-deployment-guide-1#_bookmark54)

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

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

###### [3.3 Connect Avaya CM VKM for Deployment](/docs/acm-deployment-guide-1#_bookmark28).

### 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**:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-nyqc134w.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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**:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-qyxdun28.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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**:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-tjl032fp.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-uzcwrzd3.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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**:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-2opwclrv.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-mn886lqo.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-s458lrv8.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-3f7df43y.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 7-8 Station MAC Data and TTI Stations*

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-6wzz67w3.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 7-9 TTI Stations*

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-3c7aboc6.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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*](/docs/acm-deployment-guide-1#_bookmark55)).

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-dzw4ieja.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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**:

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-rl4edomn.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 8-1 Configure Real Time QoS*

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-z2ymt62m.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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***](/docs/acm-deployment-guide-1#_bookmark49). 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](/docs/acm-deployment-guide-1#_bookmark58)

###### [Load Report Packs](/docs/acm-deployment-guide-1#_bookmark59)

###### [Apply Company Logo](/docs/acm-deployment-guide-1#_bookmark60)

###### [Report Retention](/docs/acm-deployment-guide-1#_bookmark61)

###### [Enable a Report](/docs/acm-deployment-guide-1#_bookmark62)

###### [Edit a Report Schedule](/docs/acm-deployment-guide-1#_bookmark63)

###### [Create a Report Schedule](/docs/acm-deployment-guide-1#_bookmark64)

###### [Remove a Report](/docs/acm-deployment-guide-1#_bookmark61)

###### [Terminate a Report](/docs/acm-deployment-guide-1#_bookmark65)

###### [Email a Report](/docs/acm-deployment-guide-1#_bookmark66)

### 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.**

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-atfb83kk.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

The **Open** window appears:

*Figure 9-1 Load Report Pack*

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-3eb5ub7t.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-5essf8uq.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 9-3 Edit Poller Export Report*

1. Define the number of reports to have on file at a time using 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. |

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-t574l70o.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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***](/docs/acm-deployment-guide-1#_bookmark64).
  - To create a different schedule for a report, see [***Edit a Report Schedule***](/docs/acm-deployment-guide-1#_bookmark63).

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-dnmf7osr.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*Figure 9-5 Edit Report Schedule*

1. Define the following parameters:

| **Parameter** | **Description** |
| --- | --- |
| **Repeat** | Set as **Hourly**, **Daily**, **Weekly**, or **Monthly**. |
| **Weeks Between** | Enter the number of weeks to lapse before the report generates again. |
| **Day of Week** | This applies to **Weeks** only. Select the day of the week to generate the report. |
| **Day of Month** | This is for **Months** only. Select **First Day**, **Last Day**, or a date between 1 and 31. |
| **Hour of Day** | Enter the hour that the report generator begins to collect data. |

1. Click **OK**.

*Table 9-2 Parameters*

The details appear in the **Schedules** pane.

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-3n4tq8gr.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-1pil644v.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-7s3dps5g.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-2dc38p7m.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-qa9gdfwo.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-09i5bdmn.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

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

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/acm-deployment-guide-image-1rdewu28.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A28%3A28Z&se=2026-11-08T18%3A28%3A28Z&sr=c&sp=r&sig=NPVLsl85OnbjxJTdCse3OovbGTC2SKTFBSKrZTntPjQ%3D)

*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"