Avaya Aura Module
  • 07 Dec 2022
  • 13 Minutes to read
  • Contributors
  • Dark
  • PDF

Avaya Aura Module

  • Dark
  • PDF


This guide provides the instructions to configure monitoring and management of Avaya Aura® Communication Manager.

About this Guide

The guide explains how to:

  • Prepare an Avaya CM for Nectar APM
  • Onboarding Avaya Aura® CM


This guide is intended for system administrators or engineers who have system administration access and technical knowledge of the Avaya Aura® Communications Manager (CM) and Avaya® Application Enablement Services (AES), as well as a familiarity with deploying the Nectar Foundation APM module.

Supported Software Versions

  • Nectar Foundation APM (Formerly Nectar Foundation / UCF) v2021.3
  • Avaya Aura® Platform r7.1 and above.
The new Aura® VKM starts with Avaya v7.0 and above. The AES server has to be v7.0 and above (preferably v8.0).

Prepare an Avaya CM for Nectar APM

Before Nectar Foundation APM 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
  • Avaya Enablement Services (AES) Administration

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:

Administrator > Server (Maintenance) 

3. Navigate to Security > Administrator Accounts.
4. In the Administrator Accounts web page, select the Add Group radio button, then select Submit.
5. In the Administrator Accounts -- Add Group web page (Add a New Access-Profile Group)select the Add a new access-profile group: radio button, then select any available profile from 20 to 69 from the drop-down menu.
6. Select Submit. You should receive a confirmation page stating, “- The add was successful for group: prof20.”.

Add a New Access-Profile Group 

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

Enter Login and Password 

8. In the Administrator Accounts -- Add Login: SAT Access Only page ( Figure 2-4), provide data for the following fields:

  • Login Name
  • Enter Password.
  • Re-enter Password.

9. Accept all other defaults.
10. Click Submit.

Add Login: SAT Access Only 

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

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

change user-profile-by-category 20

  • Turn on categories as shown here:
  • Turn on Categories
  • The changes can be made by category. Go to the top of page two and Set Permissions for a category by entering the following:
  • Set Permissions 

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

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.

Select Server (Maintenance) 

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.

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

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

Enable SNMP 

4. Enter the Community Names as follows:

  • Community Name (read-only):
  • Community Name (read-write):

In the previous figure, two versions of SNMP are used. Another option for V3 exists.


It is important that you enable the read-write function as well so that Filter administration can be performed.

5. Click the Submit button after making changes.

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.

SNMP Traps 

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

3. 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.)


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.

SNMP Traps 

4. In the SNMP Traps page, you can specify alarms to be sent as traps. For more information, see Configure Alarm Filters on Communication Manager.

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.

Alarm Filters 

2. 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 FP Filters.

  • Select your changes, then select the Change button as shown in Add FP Filter.
FP Filters 

3. To add an FP Filter make your selections first, then select Add button, as shown in Add FP Filter.

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.

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

Agent Status 

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

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.

SNMP Test Results 

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

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.

Avaya Enablement Services (AES) Administration

This section will help you administer the connection to Communication Manager (CM) from up to three AES Servers.

Application Enablement Services

3. Log into the AES server.
4. Find and select AE Services > System Management Services (SMS) > SMS Properties.

The SMS Properties dialog window appears. For assistance with this dialog window, click on

Help in the top right-hand corner of the window.


Default CM Host Address

Leave default "localhost"

Default CM Admin Port

Default is always 5022.

CM Connection Protocol

Default is SSH.

SMS Logging

Default is NORMAL.

SMS Log Destination

Default is apache.

CM Proxy Trace Logging

Default is NORMAL.

Max Sessions per CM

Default is (can be set from 1-5).

Proxy Shutdown Timer

Needs to be 1800.

SAT Login Keepalive

Use 360.

CM Terminal Type

Use terminal OSSIE.

5. Once all the fields have been completed, click Apply Changes

This concludes configuration of the CM from the AES.

Onboarding Avaya Aura® CM

In this section you will learn how to do the actions below to a CM on your RIG.

  • Add an Avaya Aura® CM
  • Edit an Avaya CM
You can have multiple CM’s on a single RIG.

Add an Avaya Aura® CM

Follow the steps below to add a CM to the RIG. To Edit or Remove a CM, the steps are similar.

1. Once logged into the RIG, navigate to and select Modules > Avaya > Aura® CM (r7.0 or above)
2. Navigate to and click VKM Options.

VKM Options

The VKM Options provide the default sittings for each Aura® CM added.  Some default values can be changed in the Add Window.

VKM Options 


Option  Name


Settings contains the Custom CDR format field mapping.  In this Module Avaya customized format defined in "system-parameters cdr" page 2 can be mapped.  The one stipulation here is that all the Communication Managers on a RIG using this module have to have the same custom format.  But, if any of the other Communication Managers are using unformatted or enhanced unformatted, this stipulation does not apply.

The fields in the right pane below are mandatory in a custom format.  They provide the necessary information to query Realtime QOS and find match.

See "Nectar Avaya CDR Configuration Guide" for additional information

VKM OptionsThe Add Avaya Aura® CM Connection dialog window appears.

3. Under the General tab, complete the following fields:

Avaya Aura CM Connection (General) 

4. Under the SNMP tab, complete the SNMP v1, v2, or V3 credentials used for the CM.

  • If the Media Gateways and Media Servers have the same SNMP credentials, then you do not have to administer SNMP Credentials on main Onboarding screen.
  • SNMP Configuration can be changed after Onboarded is complete

5. Under the CDR tab (if using CDR), complete the following fields:

Avaya Aura CM Connection (CDR)

Enable CDR:

Enable (select the checkbox).

CDR Port:

9000 is base port and will increment per each CM onboarded.

Port number can be any valid port but cannot be same port as used on 

other CM instances.  Port used in CM much match

Secure Port:

If using Secure Sockets Layer (SSL), select the checkbox.

CDR Format:

  • Customized
  • Unformatted
  • Enhanced Unformatted

We can customize fields you may need.

CDR Date Format:

USA or International format

6. Under the Options tab, select your ACM Time Zone and ACM Date Format (e.g., month/day).
7. Click OK.

This concludes onboarding an Avaya Aura® CM to the RIG.

Edit an Avaya CM

Once the connection is Authorized and it appears in the Configurations list, now you can do the following to the CM:

  • Enable and Disable a CM
  • View Collections and Timer Tasks.
  • View Capacity Pollers
  • SNMP Configuration

Enable and Disable a CM

To enable or disable a CM, find and select your CM from the Configurations list, then click Enable or Disable. This will stop all collections.

View Collections and Timer Tasks.

Collections/Timer Tasks run on a daily schedule and you can view the data by selecting your CM from the Configurations list, and then clicking on Collections or Timer Tasks from menu bar.

Data collected:

  • System Name
  • Display Name
  • Function Name
  • Enabled
  • Cron Entry
  • Status
  • Last Time Ran
To save time, use the text search field. Also, the columns can be adjusted and sorted by clicking on the pencil icon.

In order to edit or execute a Collection, do the following:

1. Select a Collection, right-click to activate a pop-up dialog box, then select:

  • Enable
  • Disable
  • Change Cron String
  • Execute Now

2. Confirm the status (Disabled/Enabled) under the Status column. 

If you see the desired Status, then you are done.

View Capacity Pollers

You are able to view and edit pollers but note that there are certain default values added to the pollers.

Some of the data you’ll be able to view are:

  • Groups
  • Features
  • Used
  • Available System Limit
  • See what Pollers active
  1. To view or edit the pollers, select Capacity Pollers from the menu bar. A list of Capacity Pollers will appear.
CM Lab 

2. Select a Poller, right-click to activate a pop-up dialog box, then select Add Poller, Remove Poller, or Copy to Clipboard.

If you select Add Poller this populates a check in the boxes under the Poller column indicating that Poller is active.

SNMP Configuration

For all the products that are in a specific IP range or specific IP, add the SNMP credentials–a media gateway.

If you're not aware of how to calculate a subnet mask for your media gateway's SNMP Configuration, consult with professional services.

To view the SNMP Configurations data, select your CM from the Configurations list (see Figure 3-1), and then click on SNMP Configuration from menu bar.

To assign specific credentials for a media gateway and Media Servers do the following:

1. From the SNMP Configuration window, select Add.

2. Complete the fields in the SNMP Configuration dialog window ( Figure 3-4).

3. Multiple entries in this table are allowed 

  • Individual IP address
  • Subnets with server in that subnet with same credentials.
  • These entries only apply to servers identified in this module
SNMP Configuration 
SubnetEnter Ip address for subnet i.e.
/Subnet Mask for the above example the value would be 16 or 8 per octet.  If it was a single IP with these credentials, then the value of the subnet would be 32
SNMP CredentialsStandard format applies.


Once a CM is onboarded check the status of the collections.  Select the CM instance and then select Collections

Collections Wait for all the collections to complete.  This takes much less time than the ACM Module. 

Collections fail for one of the following reasons:

  • Collection is empty on CM i.e. no VDN since not a Call Center (In this case disable collection)
  • AES Connection to CM fails
  • AES has a max or 16 connections
  • All CM logins are in use 
    • Administered Module login connections are in use.

Wait a few minutes and right click on collections and select "execute Now"

Cron Entry in Collections 

  • 0 0 23 ? * * *    Every day at 23:00 or 11PM
  • 0 */10 * ? * *     Every 10 minutes
  • 0 15 23 ? * * *  Every day at 23:15 or 11:15 PM
  • 0 5 * ? * *          Every hour at 5 minutes past the hour   i.e. 09:05
  • 0 */15 * ? * *     Every hour at 15 minutes past the hour  i.e. 09:15
  • 0 */10 * ? * *     Every hour at 10 minutes past the hour  i.e. 09:10

Timer Tasks 

These task tun based on Collection data.  They provide the table data for Polling

The "Media Server" task will appear to fail of some of the tables is trying to pull are empty or OOS. If any DSP source is down the task will appear to fail but actually it worked but is missing some of the tables expected resources

  • This task pulls the DSP usage per Network Region and includes
    • MG DSP usage per bank
    • MEDPRO usage
    • Media Server DSP usage

Capacity Pollers

Collections pulls all the capacities on the CM and presents them in this view.  Polling can be created for any Capacity found in this table. Right click on the capacity object and select "Add Poller".  A check will appear in the Poller Column.  The capacity pollers are in the agent [System Name]-Total License Capacities.  They are percentage Pollers with the value  Available divided into Used.


  • greater than 95% is critical (red)
  • greater than 85% is minor (orange)
  • less than 86% is good (green)

Capacity PollersAgents

The following agents are created per System and prefixed with the System Name


  • Pollers
  • Active Logins
  • Busied-out other objects
  • Busied-out stations
  • Busied-out trunks
  • Major Alarms
  • Minor Alarms
  • Warning Alarms
  • Occupancy
  • Traps Groups
  • There are 53 different Trap Filters

AES CTI Links 

  • Poller per CTI Link

AMS [instance number]

  • Poller Signal Group Status
  • Trap Filters
    • There are 43 different Trap Filters

Call Center Capacities

  • Logged-in ACD Agents
  • Total Vectors 
  • Total Vector Directory Numbers

DSP Usage

  • DSP Usage per Region

InterRegion Usage

  • InterRegion Usage by
    • Kbits
    • Mbits
    • Calls
    • NoLimit (no thresholds)

MG-[mg number] (one p[er Media Gateway)

  • Ambient Temperature Sensor Value
  • Ambient Sensor Operation Status 
  • DSP Bank State
  • DSP Usage
  • ESS Control
  • Fan Speed
  • Fan Status

Softphone License Usage

  • AgentSC
  • IP_agent
  • IP_Phone
  • IP_ROMax
  • OneX_Comm

Total License Capacities

Additional capacities can be selected in Capacities window defined above

Default Pollers

  • BCMS Measured VDNs
  • EC500
  • Extension
  • IP Stations
  • Off-PBX Telephones - EC500
  • Off-PBX Telephones - OPS
  • Off-PBX Telephones - SCCAN
  • SBS Stations
  • Station and Trunk Ports
  • Wireless Terminals
  • XMOBILE Stations

Trunk Group Usage

  • Poller per Trunk Group 
    • Displays current ports in-use

Direct Alarms via Dependency Trees

A Dependency Tree and Element will be created for each of the following:

  • SIP Trunk Groups
    • End Node for the Signal Group that controls this trunk group
  • DS1 Trunk Groups
    • End Node for each Channel alerting based on its state
    • End Node for the Signal Group that controls this trunk group
  • H323 Trunk Groups
    • End Node for the Signal Group that controls this trunk group

Was this article helpful?