- 10 Mar 2025
- 31 Minutes to read
- Print
- DarkLight
- PDF
Nectar-Aura10
- Updated on 10 Mar 2025
- 31 Minutes to read
- Print
- DarkLight
- PDF
Avaya Solution & Interoperability Test Lab
Application Notes for Nectar for Avaya with Avaya Aura®
Communication Manager, Avaya G430/G450 Media
Gateway, Avaya Aura® Media Server, Avaya Aura®
Application Enablement Services, and Avaya Session Border Controller for Enterprise - Issue 0.1
Abstract
These Application Notes describe the configuration steps required to integrate Nectar for Avaya with Avaya Aura® Communication Manager, Avaya G430/G450 Media Gateway, Avaya Aura® Media Server, Avaya Aura® Application Enablement Services, and Avaya Session Border Controller for Enterprise. Nectar for Avaya is a performance monitor that provides a comprehensive view of unified communications and contact center environments. It automatically captures system inventory, alarms, resource utilization and status data, and realtime call quality metrics. Nectar for Avaya monitors Avaya Aura® Communication Manager, Avaya Media Gateways, Avaya Aura® Media Server, Avaya Session Border Controller for
Enterprise, and VoIP calls using SNMP, RTCP, System Access Terminal (SAT) interface, and Avaya Aura® Application Enablement Services System Management Service (SMS) Web Services. Avaya Session Border Controller for Enterprise relays RTCP call quality metrics from SIP Remote Workers to Nectar for Avaya. Alarms, inventory reports, resource utilization and status, and RTCP call quality metrics are displayed on the Nectar Remote Intelligence Gateway (RIG) client.
Readers should pay attention to Section 2, in particular the scope of testing as outlined in Section 2.1 as well as the observations noted in Section 2.2, to ensure that their own use cases are adequately covered by this scope and results.
Information in these Application Notes has been obtained through DevConnect compliance testing and additional technical discussions. Testing was conducted via the DevConnect Program at the Avaya Solution and Interoperability Test Lab.
Table of Contents
2. General Test Approach and Test Results 4
2.1. Interoperability Compliance Testing 6
4. Equipment and Software Validated 9
5. Configure Avaya Aura® Communication Manager 10
5.1. Launch System Management Interface 10
5.2.1. Configure Login Group 11
5.2.2. Configure Login User 13
5.2.3. Configure SAT User Profile 15
5.3.2. Restart SNMP Master Agent 18
5.4. Configure RTCP Reporting 20
5.4.1. Enable Unencrypted SRTCP 21
6. Configure Avaya Aura® Application Enablement Services 22
7. Configure Avaya G430/G450 Media Gateway 23
7.1.1. Configure SNMPv1 or v2c Traps 23
7.1.2. Configure SNMPv3 Traps 23
7.2. Configure SNMP Polling 24
7.2.1. Configure SNMPv1 or V2c Polling 24
7.2.2. Configure SNMPv3 Polling 24
8. Configure Avaya Aura® Media Server 25
9. Configure Avaya Session Border Controller for Enterprise 30
9.1. Launch EMS Web Interface 30
9.3. Configure RTCP Relay Service 34
10. Configure Avaya SIP Endpoints 37
10.1. Configure Device Settings Groups in System Manager 37
10.2. Configure 46xxsettings.txt File 41
11. Configure Nectar for Avaya 43
11.1. Launch the RIG Client 43
11.2. Configure Communication Manager SAT Access and SNMP Polling 44
11.3. Configure SBCE SNMP Polling 47
11.5. Configure Real-Time Quality Monitoring 54
Introduction
These Application Notes describe the configuration steps required to integrate Nectar for Avaya with Avaya Aura® Communication Manager, Avaya G430/G450 Media Gateway, Avaya Aura®
Media Server, Avaya Aura® Application Enablement Services, and Avaya Session Border Controller for Enterprise. Nectar for Avaya is a performance monitor that provides a comprehensive view of unified communications and contact center environments. It automatically captures system inventory, alarms, resource utilization and status data, and realtime call quality metrics. Nectar for Avaya monitors Avaya Aura® Communication Manager, Avaya Media Gateways, Avaya Aura® Media Server, Avaya Session Border Controller for
Enterprise, and VoIP calls using SNMP, RTCP, System Access Terminal (SAT) interface, and
Avaya Aura® Application Enablement Services System Management Service (SMS) Web Services. Avaya Session Border Controller for Enterprise (SBCE) relays RTCP call quality metrics from SIP Remote Workers to Nectar for Avaya. Alarms, inventory reports, resource utilization and status, and RTCP call quality metrics are displayed on the Nectar Remote Intelligence Gateway (RIG) client.
Nectar automatically collects the following Communication Manager Inventory using a SAT login, SNMP polling, and Application Enablement Services SMS Web Service. Nectar may use both SNMP and/or SMS Web Service to retrieve all data for a particular category. SAT login is only used to collect Media Server data.
ACD Agent | IP Network Region | Stations |
AES CTI Links | IP Server Interfaces | System Information |
Announcements | Locations | Trunk Groups |
Audio Groups | Media Gateways | Trunk Member Status |
Cabinets | Media Servers | VDNs |
Capacities Product ID | MedPro Boards | VDN Variables |
Cards | MG DSP Usage | Vectors |
CTI Links | Node Names | Vector Events |
Events | Registered Stations | Vector Steps |
History | Route Patterns | Vector Variables |
Init Causes | Route Pattern Details | |
IP Interfaces | Survivable Processors | |
IP Network Map | Signal Group Status |
Nectar performs SNMP polling against Avaya Media Gateway to retrieve Fan Speeds, Ambient Temperature Sensor, and MG DSP Usage. No SNMP polling is performed for Media Server.
Nectar performs SNMP polling against SBCE to retrieve data related to calls, registrations, and other data.
Nectar also serves as an SNMP trap receiver for Communication Manager, Avaya Media Gateway, Media Server, and SBCE.
The following table specifies the SNMP versions supported between Nectar and Avaya Aura® Communication Manager, media resources, and SBCE for SNMP traps and polls.
Avaya Product | Data Type | SNMP Version(s) |
Avaya Aura® Communication Manager | SNMP Traps | SNMPv1, v2c, v3 |
SNMP Polling | SNMPv1, v2c, v3 | |
Avaya Media Gateway | SNMP Traps | SNMPv1, v2c, v3 |
SNMP Polling | SNMPv1, v2c, v3 | |
Avaya Aura® Media Server | SNMP Traps | SNMPv1, v2c, v3 |
Avaya Session Border Controller for Enterprise | SNMP Traps | SNMPv3 |
SNMP Polling | SNMPv3 |
Nectar captures RTCP call quality metrics from Avaya H.323 Deskphones, Avaya SIP Deskphones, Avaya Workplace Client for Windows, G430/G450 Media Gateway, Media Server, and SBCE. SBCE forwards RTCP received by SIP remote workers.
Nectar data collection schedule is configurable, but on-demand data collection is also supported.
General Test Approach and Test Results
The interoperability compliance test included feature and serviceability testing. The feature testing focused on Nectar monitoring Communication Manager and its associated media resources using SNMP traps and polling, RTCP collection, a SAT login, and SMS Web Service to provide resource utilization, system inventory, call quality metrics, and alarm events in the RIG client.
SNMP traps were generated on Communication Manager, Media Gateway, Media Server and SBCE and sent to Nectar. Nectar displayed these SNMP traps in the Events log in the RIG client.
SNMP polling, a SAT login, and SMS Web Service were used by Nectar to capture system inventory and other platform data from Communication Manager, Media Gateways, and SBCE.
RTCP was used by Nectar to provide call quality metrics for VoIP calls. The general approach was to place calls between Avaya H.323, SIP, digital and analog phones and injecting errors using a network impairment tool to simulate network delay and packet loss conditions on the LAN. In addition, SIP remote workers sent RTCP to SBCE, which in turn relayed them to Nectar.
The serviceability testing focused on verifying that Nectar came back into service after reconnecting the Ethernet cable (i.e., restoring network connectivity) and restarting Nectar.
This solution uses the System Access Terminal (SAT) interface to interact with Avaya Aura® Communication Manager or the Telnet/SSH interface to interact with other Avaya products. While this solution has successfully completed Compliance Testing for the specific release levels as described in these Application Notes, Avaya does not generally recommend use of these interfaces as a programmatic approach to integration of 3rd party applications. Avaya may make changes or enhancements to the interfaces in any subsequent release, feature pack, service pack, or patch that may impact the interoperability of 3rd party applications using these interfaces. Using these interfaces in a programmatic manner may also result in a variety of operational issues, including performance impacts to the Avaya solution. If there are no other programmatic options available to obtain the required data or functionality, Avaya recommends that 3rd party applications only be executed during low call volume periods, and that real-time delays be inserted between each command execution. NOTE: The scope of the compliance testing activities reflected in these Application Notes explicitly did not include load or performance evaluation criteria, and no guarantees or assurances are made by Avaya that the 3rd party application has implemented these recommendations. The vendor of the 3rd party application using this interface remains solely responsible for verifying interoperability with all later Avaya Product Releases, including feature packs, service packs, and patches as issued by Avaya. For additional details see Avaya Product Support Notices PSN002884u, PSN005085u, and PSN020295u, available at www.avaya.com/support.
DevConnect Compliance Testing is conducted jointly by Avaya and DevConnect members. The jointly-defined test plan focuses on exercising APIs and/or standards-based interfaces pertinent to the interoperability of the tested products and their functionalities. DevConnect Compliance Testing is not intended to substitute full product performance or feature testing performed by DevConnect members, nor is it to be construed as an endorsement by Avaya of the suitability or completeness of a DevConnect member’s solution.
Avaya recommends our customers implement Avaya solutions using appropriate security and encryption capabilities enabled by our products. The testing referenced in this DevConnect Application Note included the enablement of supported encryption capabilities in the Avaya products. Readers should consult the appropriate Avaya product documentation for further information regarding security and encryption capabilities supported by those Avaya products.
Support for these security and encryption capabilities in any non-Avaya solution component is the responsibility of each individual vendor. Readers should consult the appropriate vendorsupplied product documentation for more information regarding those products.
Interoperability Compliance Testing
Interoperability compliance testing covered the following Nectar features and functionality.
Collecting Communication Manager Inventory (i.e., managed objects, such as IP
Network Regions, Stations, and Trunks) using SNMP polling, a SAT login session, and Application Enablement Services SMS Web Service and displaying the data in the RIG client.
Verifying inventory updates on the RIG client after making configuration changes on Communication Manager.
Verifying resource utilization (e.g., MG DSP Usage) captured from Media Gateway via SNMP polling.
Collecting call and registration information from SBCE via SNMP polling
Capturing SNMP traps and providing events for alarm conditions on Communication Manager, G430/450 Media Gateways, Media Server, and SBCE.
Tracking the registration status of Avaya H.323 Deskphones.
Capturing RTCP from Avaya H.323 Deskphones, Avaya SIP Deskphones Avaya Workplace, Media Gateway, and Media Server and displaying call quality metrics on the RIG client.
Capturing RTCP data from SIP remote Workers registered to Session Manager through SBCE. In this case, SIP remote worker sends RTCP to SBCE and then relays them to Nectar.
Verifying proper system recovery after a restart of Nectar and loss of IP network connectivity.
Test Results
The compliance test passed with the following observations:
If SRTP is used for SIP calls, unencrypted SRTCP must be used so that G430/G450 Media Gateway sends RTCP to Nectar.
In the Real-Time QoS window of the RIG client, there is no call path information for Avaya SIP Deskphones or Media Server, because they don’t provide call path (or call trace) information to Nectar. In addition, for J100 Series SIP Deskphones, the IP address and name may be blank in the Real-Time QoS detail window on the RIG. However, the SIP endpoint information is correctly displayed in the Real-Time call summary window.
Nectar may log SNMP traps from Communication Manager against the wrong agent, and therefore, SNMP traps may not be reflected in the Dependency Tree. This is caused by an IP address being assigned to agents automatically added in the background by Nectar, which cannot be removed by a user. Nectar is investigating this issue.
If there are no Audio Groups or IP Network Map configured, the data collection status for those data items will indicate as Failed in the Collections window on the RIG. If data exists, the data collection status will be Success, if the data was retrieved successfully.
If Audio Groups or IP Network Map configuration is removed, Nectar continues to display the last retrieved data.
Support
For technical support and information on Nectar for Avaya, contact Nectar Support at:
| Phone: | +1 (888) 811-8647 (US) +1 (631) 270-1077 (outside the US) |
| Website: | https://support.nectarcorp.com |
| Email: | support@nectarcorp.com |
Reference Configuration
Figure 1 illustrates a sample configuration consisting of Nectar for Avaya with an Avaya SIPbased network. Nectar for Avaya was used to:
retrieve Communication Manager Inventory using SNMP polling, a SAT interface, and
Application Enablement Services SMS Web Service,
monitor Communication Manager, G430/G450 Media Gateways, and Media Server using SNMP (no SNMP polling for Media Server),
capture RTCP call quality metrics from Avaya H.323 and SIP endpoints, media resources, and SBCE, and
display alarms, inventory reports, and call quality metrics on the RIG client.
Figure 1: Nectar for Avaya with Avaya SIP-based Network
Equipment and Software Validated
The following equipment and software were used for the sample configuration provided:
Equipment/Software | Release/Version |
Avaya Aura® Communication Manager | 10.1.0.1.0-SP1 |
Avaya G430 Media Gateway | FW 42.4.0 Vintage 1 |
Avaya G450 Media Gateway | FW 42.7.0 Vintage 3 |
Avaya Aura® Media Server | v.10.1.0.77 |
Avaya Aura® System Manager | 10.1.0.1 Build No. – 10.1.0.0.537353 Software Update Revision No: 10.1.0.1.0614394 Service Pack 1 |
Avaya Aura® Session Manager | 10.1.0.1.1010105 |
Avaya Aura® Application Enablement Services | 10.1.0.0.0.11-0 |
Avaya Session Border Controller for Enterprise | 10.1.1.0-35-21872 |
Avaya 96x1 Series IP Deskphones | 6.8.5.3.2 (H.323) 7.1.13.0.4 (SIP) |
Avaya J179 SIP Deskphone | 4.0.13.0.6 |
Avaya Workspace Client for Windows | 3.24.0.84 |
Avaya 9404 Digital Phone | 12.0 |
Avaya Analog Phone | N/A |
Nectar for Avaya | 2022.1-21422 |
Nectar Remote Intelligence Gateway (RIG) Client | 2022.1-20314 |
Configure Avaya Aura® Communication Manager
This section provides the procedure for configuring SNMP, RTCP Reporting, and SAT access. The procedures include the following areas:
Launch System Management Interface
Configure SAT Login
Configure SNMP
Configure RTCP Reporting
Launch System Management Interface
Access the Communication Manager System Manager Interface by using the URL https://<ipaddress> in an Internet browser, where <ip-address> is the Communication Manager IP address. Log in using the appropriate credentials.
In the subsequent webpage, select Administration Server (Maintenance) from the top menu as shown below. The Server Administration webpage is displayed as shown in the following section.
Configure SAT Login
This section covers the configuration of a SAT user account for Nectar and its associated permissions. The SAT interface is used by Nectar to retrieve Media Server data from Communication Manager.
Configure Login Group
Create an Access-Profile Group. Navigate to Security Administrator Accounts. In the Administrator Accounts webpage, select Add Group, and then click Submit.
In the Administrator Accounts – Add Group webpage, select prof20 from the drop-down list of the Add a new access-profile group field. Click Submit.
Configure Login User
Create a login account for Nectar to access the Communication Manager SAT. Navigate to Security Administrator Accounts and select SAT Access Only. Click Submit.
In the Administrator Accounts – Add Login: SAT Access Only webpage, provide the Login name (e.g., rig), password, and accept all other default values. Click Submit.
Configure SAT User Profile
A SAT User Profile specifies which SAT screens may be accessed by the user assigned the profile and the type of access to each screen. Since Nectar doesn’t modify any system configuration, create a SAT User Profile with limited permissions.
Use the add user-profile-by-category 20 command, where 20 was the user profile configured in Section 5.2.2. Enter a descriptive name for User Profile Name (e.g., Nectar Admin) and enable the categories shown below. For the compliance test, user profile 20 was created.
add user-profile-by-category 20 Page 1 of 39 USER PROFILE 20 User Profile Name: Nectar Admin This Profile is Disabled? n Shell Access? y Facility Test Call Notification? n Acknowledgement Required? n Grant Un-owned Permissions? n Extended Profile? n Name Cat Enbl Name Cat Enbl Adjuncts A y Routing and Dial Plan J y Call Center B y Security K y Features C y Servers L y Hardware D y Stations M y Hospitality E y System Parameters N y IP F y Translations O n Maintenance G y Trunking P y Measurements and Performance H y Usage Q y Remote Access I n User Access R n |
On Page 2, Set Permissions For Category according to the table below.
Category | Permission |
A | r- |
B | r- |
C | rm |
D | r- |
E | r- |
F | rm |
G | rm |
H | r- |
J | r- |
history K | r- |
L | rm |
M | rm |
N | r- |
P | rm |
Q | r- |
Configure SNMP
This section covers the configuration of SNMP on Communication Manager. The steps required include:
Administer FP Traps
Administer SNMP Access
Restart SNMP Master Agent
Configure RTCP Reporting
Administer FP Traps
To configure Communication Manager to send SNMP traps to Nectar, navigate to SNMP FP Traps. The FP Traps webpage is displayed as shown below. In the sample configuration below, SNMP traps using SNMPv1, v2c, and v3 are configured simultaneously for informational purposes. Note that only one SNMP version needs to be configured.
For SNMPv1 or v2c, configure the following fields:
IP Address: | Set to the Nectar IP address (e.g., 10.64.102.113). |
Port: | Use the default port 162 for SNMP traps. |
Notification: | Set to trap. |
Community Name: | Set to appropriate community string (e.g., public). |
For SNMPv3, configure the following fields:
IP Address: Set to the Nectar IP address (e.g., 10.64.102.113).
User Name: Specify a user name (e.g., nectar).
Authentication Protocol: Set to SHA.
Authentication Password: Set to a valid password to be used by Nectar. Privacy Protocol: Set to AES128.
Privacy Password: Set to a valid password to be used by Nectar.
Once completed, press the Submit button.
Administer SNMP Access
To configure Communication Manager to respond to SNMP polling, navigate to SNMP
Access. The Access webpage is displayed as shown below. In the sample configuration below, SNMP polling using SNMPv1, v2c, and v3 are configured simultaneously for informational purposes. Note that only one SNMP version needs to be configured.
For SNMPv1 or v2c, configure the following fields:
IP Address: | Set to the Nectar IP address (e.g., 10.64.102.113). |
Access: | Set to read-only. |
Community Name: | Set to appropriate community string (e.g., public). |
For SNMPv3, configure the following fields:
IP Address: Set to the Nectar IP address (e.g., 10.64.102.113).
User Name: Specify a user name (e.g., nectar).
Authentication Protocol: Set to SHA.
Authentication Password: Set to a valid password to be used by Nectar. Privacy Protocol: Set to AES128.
Privacy Password: Set to a valid password to be used by Nectar.
Once completed, press the Submit button.
Restart SNMP Master Agent
Select SNMP Agent Status from the left pane to display the Agent Status webpage and restart the SNMP agent. Click the Stop Master Agent button followed by the Start Master Agent button.
Configure RTCP Reporting
Nectar can monitor the quality of IP calls using RTCP reporting. Communication Manager should be configured to provide RTCP settings to Avaya H.323 Deskphones and G430/G450 Media Gateway. The RTCP settings specify where to send the RTCP data and the frequency. This configuration is performed through the SAT interface. Use the change system-parameters ip-options command to set the following RTCP Monitor Server parameters:
Server IPV4 Address: | Enter the Nectar IP address (e.g., 10.64.102.113). |
IPV4 Server Port: | Set to 5005. |
RTCP Report Period (secs): | Set to 5. |
change system-parameters ip-options Page 1 of 5 IP-OPTIONS SYSTEM PARAMETERS IP MEDIA PACKET PERFORMANCE THRESHOLDS Roundtrip Propagation Delay (ms) High: 800 Low: 400 Packet Loss (%) High: 40 Low: 15 Ping Test Interval (sec): 20 Number of Pings Per Measurement Interval: 10 Enable Voice/Network Stats? n RTCP MONITOR SERVER Server IPV4 Address: 10.64.102.113 RTCP Report Period(secs): 5 IPV4 Server Port: 5005 Server IPV6 Address: IPV6 Server Port: 5005 AUTOMATIC TRACE ROUTE ON Link Failure? y H.323 IP ENDPOINT H.248 MEDIA GATEWAY Link Loss Delay Timer (min): 5 Link Loss Delay Timer (min): 5 Primary Search Time (sec): 75 Recover Before LLDT Expiry? y Periodic Registration Timer (min): 20 Short/Prefixed Registration Allowed? N |
Use the change-ip-network-region command to enable RTCP reporting for H.323 deskphones and G430/G450 Media Gateways. For the compliance test, IP network region 1 was used. Set the RTCP Reporting to Monitor Server Enabled field to y. To use the RTCP parameters configured system-wide in the System-Parameters IP-Options above, set Use Default Server
Parameters to y or set this field to n to set different RTCP parameters on a network region basis.
change ip-network-region 1 Page 2 of 20 IP NETWORK REGION RTCP Reporting to Monitor Server Enabled? y RTCP MONITOR SERVER PARAMETERS Use Default Server Parameters? y ALTERNATIVE NETWORK ADDRESS TYPES ANAT Enabled? n |
Enable Unencrypted SRTCP
For SIP calls using SRTP and G430/G450 Media Gateway for media resources, ensure that unencrypted SRTCP is enforced. If encrypted SRTCP is used, Media Gateway won’t send RTCP to Nectar. Note that Avaya H.323 Deskphones do not support encrypted SRTCP.
Enforcing unencrypted SRTCP can be done in the following ways: enforce unencrypted SRTCP in the IP codec set or disable ENCRYPT_SRTCP in the 46xxsettings file as shown below.
In the IP codec set below, Encrypted SRTCP is set to enforece-unenc-srtcp. The default of best-effort may be used if unencrypted SRTCP is enforced in the 46xxsettings file for Avaya SIP Deskphones.
change ip-codec-set 1 Page 1 of 2 IP MEDIA PARAMETERS Codec Set: 1 Audio Silence Frames Packet Codec Suppression Per Pkt Size(ms) 1: G.711MU n 2 20 2: 3: 4: 5: 6: 7: Media Encryption Encrypted SRTCP: enforce-unenc-srtcp 1: 1-srtp-aescm128-hmac80 2: 2-srtp-aescm128-hmac32 3: none 4: 5: |
If the IP codec set above allows best-effort for Encrypted SRTCP, then unencrypted SRTCP may be enforced in the 46xxsettings file by setting ENCRYPT_SRTCP to 0 as shown below. Unencrypted SRTCP is the default.
## ENCRYPT_SRTCP specifies whether RTCP packets are encrypted or not. SRTCP is only used if SRTP is enabled using
## MEDIAENCRYTION (values other than 9 (none) are configured).
## This parameter controls RTCP encryption for RTCP packets exchanged between peers. ## RTCP packets sent to Voice Monitoring Tools are always sent unencrypted.
## Value Operation
## 0 SRTCP is disabled (default).
## 1 SRTCP is enabled.
## This parameter is supported by:
## J129 SIP R1.0.0.0 (or R1.1.0.0), J169/J179 SIP R1.5.0, J100 SIP R2.0.0.0 and later, J139 SIP R3.0.0.0 and later, J159 SIP R4.0.3.0 and later, J189 SIP R4.0.6.1 and later
## Avaya IX Workplace 3.1.2 and later
## 96x1 SIP R7.1.0.0 and later
## Avaya Vantage Connect Application SIP R1.0.0.0 and later SET ENCRYPT_SRTCP 0
Configure Avaya Aura® Application Enablement Services
This section covers the configuration of SMS Properties, which is used by the SMS web service to access managed objects on Communication Manager. Nectar only requests read-only access to managed objects via the SMS web service and will provide the Communication Manager login credentials to Application Enablement Services configured in Section 5.2.
Access the OAM web-based interface by using the URL “https://<ip-address>” in an Internet browser window, where <ip-address> is the IP address of Application Enablement Services. Log in using the appropriate credentials (not shown).
Navigate to AE Services SMS SMS Properties. In SMS Properties, configure the
following fields: | |
Default CM Host Address: | Set to the CM IP address (e.g., 10.64.102.115). |
Max Session per CM: | Default is 1 (can be set to 1-5). |
SAT Login Keepalive: | Set to 360. |
CM Terminal Type: | Set to OSSIE. |
Use default values for the other fields.
Configure Avaya G430/G450 Media Gateway
This section covers the G430/G450 Media Gateway configuration to send SNMP traps to Nectar and allow Nectar SNMP polling.
Note: Pre-defined SNMP Groups and Views mentioned in this section already exist by default in G430/G450 Media Gateways with newer firmware. Use the show snmp group or show snmp view commands to view them. Use the show snmp userToGroup command to view the group mapped to a user.
Configure SNMP Traps
This section covers the configuration of the G450 Media Gateway to enable SNMP traps. Log into the Media Gateway command line interface with the appropriate credentials using SSH (not shown).
Configure SNMPv1 or v2c Traps
At the command prompt, enter one of the commands shown below. In the snmp-server host command specify the Nectar IP address, specify v1 or v2c in the command depending on the SNMP version desired, and public as the community name. The show snmp command may be used to view the SNMP configuration.
snmp-server host 10.64.102.113 traps v1 public
-or-
snmp-server host 10.64.102.113 traps v2c public
Configure SNMPv3 Traps
To configure SNMPv3 traps, create a new SNMP Group in the Media Gateway using the command below. This new SNMP Group assigns the pre-defined iso SNMP View as the group’s Read View and Notify View.
snmp-server group v3ReadViewG v3 priv read iso notify iso
Next, configure a SNMP User for Nectar using the command below. This new SNMP user assigns the SNMP Group created above. After the command is entered, the user will be prompted for passwords.
snmp-server user nectar v3ReadViewG v3 auth sha priv aes128
Finally, enable SNMPv3 traps with the command below, which specifies the Nectar IP address, SNMP version and the SNMP User (i.e., nectar) created above.
snmp-server host 10.64.102.113 traps v3 priv nectar
Configure SNMP Polling
This section covers the configuration on the Media Gateway to allow SNMP Polls. Log into the Media Gateway command line interface with the appropriate credentials using SSH (not shown).
Configure SNMPv1 or V2c Polling
To allow SNMPv1 or v2c polling, use the following command to set the community strings.
snmp-server community read-only public read-write private
Configure SNMPv3 Polling
To allow SNMPv3 polling, use the following command to create a SNMP user, nectar123, assigned to the pre-defined v3ReadOnlyG SNMPv3 group. After the command is entered, the user will be prompted for passwords.
snmp-server user nectar123 v3ReadOnlyG v3 auth sha priv aes128
Configure Avaya Aura® Media Server
This section covers the configuration to allow SNMP traps and RTCP to be sent to Nectar.
Access the Media Server web management interface by using a web browser and entering the URL https://<ip-address>:8443, where <ip-address> is the Media Server IP address. Log in using the appropriate credentials.
Configure SNMP
This section covers SNMP trap configuration. Navigate to System Configuration Network Settings SNMP Users to add a SNMP user. The Users webpage is displayed below. Click Add.
In the Add User webpage, configure a SNMPv1/v2c or SNMPv3 user. Below is a SNMPv1/v2c user.
The webpage below shows the configuration of a SNMPv3 user.
To allow Media Server to send SNMP traps to Nectar, navigate to System Configuration Network Settings SNMP Destinations. The Traps Destinations webpage is displayed as shown below.
In Add Trap Destination, provide the Nectar IP address for the Destination address and set the Destination port to 162. Click Save.
In the Traps Routes section of the Traps Destination webpage, click Add. The following webpage shows the Route Destination configuration for SNMPv1/v2c traps.
The following webpage shows the Route Destination configuration for SNMPv3 traps.
Configure RTCP
This section covers the configuration for reporting RTCP to Nectar. Navigate to System
Configuration Media Processing General Settings and scroll down to the Dual Unicast
Monitor section to set the Monitoring Server IP to the Nectar IP address and Monitoring Server Port to 5005, the RTCP receiver port configured on Nectar. Click Save.
Configure Avaya Session Border Controller for Enterprise
This section provides the procedure for configuring SNMP and RTCP relay service. The procedures include the following areas:
Launch EMS Web Interface
Configure SNMP
Configure RTCP Relay Service
It is assumed that the initial installation and configuration of SBCE has already been completed. For more information on configuring SBCE, refer to [6].
Launch EMS Web Interface
Access the Session Border Controller web management interface by using a web browser and entering the URL https://<ip-address>, where <ip-address> is the EMS IP address. Log in using the appropriate credentials.
Once logged in, the Dashboard screen is presented as shown below. Change the Device in the title bar from EMS to SBCE.
Configure SNMP
This section covers the configuration of SNMP on SBCE. Navigate to Monitoring & Logging SNMP. The SNMP webpage is displayed as shown below. In the SNMP v3 tab, click Add.
In the Add User dialog box, configure the following fields to add Nectar as the SNMP trap receiver:
User Name: Provide a user name (e.g., nectar).
Authentication Scheme: Select SNMPv3 authentication scheme (e.g., authPriv).
AuthPassPhrase: Enter authentication password, if required. Confirm AuthPassPhrase: Re-enter authentication password, if required.
| Authentication Protocol: | Select SHA, if authentication protocol is used. |
| PrivPassPhrase: | Enter privacy password, if required. |
| Confirm PrivPassPhrase: | Re-enter privacy password, if required. |
| Privacy Protocol: | Select privacy protocol, if required (e.g., AES). |
| Privilege: | Select Read. |
| Trap IP Address: | Set to Nectar IP address (e.g., 10.64.102.113). |
| Port: | Set to SNMP trap port 162. |
| Trap Profile: | Use the default trap profile. To view default trap profile, |
navigate to Configuration Profiles SNMP Traps.
Select the Management Servers tab and click Add.
In the Add IP Address dialog box, enter the Nectar IP address (e.g., 10.64.102.113).
The default Trap Severity Settings were used, where all trap severities were enabled.
Configure RTCP Relay Service
This section describes the SBCE configuration to relay RTCP to Nectar. This configuration supports SIP remote workers that register to Session Manager through SBCE.
Navigate to DMZ Services Relay. The Replay Services: SBCE webpage is displayed as shown below. In the Application Relay tab, click Add.
The Add Application Replay dialog box is displayed as shown below. To add an Application Relay to relay RTCP from SIP remote workers to Nectar, provide the following configuration.
In the General Configuration section, provide a descriptive Name (e.g., Remote-Worker-RTCP) and set the Service Type is set to RTCP.
In the Remote Configuration section, set the Remote IP/FQDN is set to the Nectar IP address (e.g., 10.64.102.113). For RTCP, port 5005 and UDP transport is used.
In the Device Configuration section, set the Listen IP to the SBCE public IP address (e.g.,
10.64.101.102), which remote SIP endpoints use as the SIP proxy IP address, and set the Connect IP to the SBCE private IP address (e.g., 10.64.102.108). For RTCP, port 5005 and UDP transport is used.
In the Additional Configuration section, set the Options to RTCP Monitoring Hop-by-Hop Traceroute.
Navigate to Network & Flows Advanced Options to display the Advanced Options webpage. In the RTCP Monitoring tab, enable RTCP Monitoring Relay, set the Node Type to Core, and set the Relay IP to the private SBCE interface (e.g., 10.64.102.108).
Configure Avaya SIP Endpoints
This section covers the methods for providing Avaya SIP 96x1 and J100 Series SIP Deskphones and Avaya Workplace with RTCP settings. The two methods include the use of Device Settings Groups on System Manager and the 46xxsettings.txt file.
Configure Device Settings Groups in System Manager
There are two types of Device Settings Groups, Terminal Groups and Location Groups. A terminal group will allow configuration parameters, such as RTCP settings, to be assigned on a SIP user basis. Configuration settings specified in a location group can be assigned to SIP users in a specified location. Note that Terminal Groups take precedence for Location Groups.
Device Settings Groups are configured in System Manager. To access the System Manager web interface, use the URL https://<ip-address> in an Internet browser window, where <ip-address> is the System Manager IP address. Log in using the appropriate credentials.
Navigate to Elements Session Manager Device and Location Configuration Device
Settings Groups. The following webpage shows that two terminal groups exist, one for local SIP users and another one for SIP remote workers. As a different example, one location group was created for Workplace.
To create a terminal group, click New in the Terminal Groups section. In the General section, provide a descriptive Name (e.g., Local SIP Users or SIP Remote Workers) and Description.
The Group Type is automatically set to Terminal Group. Assign a Terminal Group Number. Number 1 was assigned for local SIP users and number 2 was assigned for SIP remote workers.
In the VoIP Monitoring Manager section, the IP Address was set to the Nectar IP address (i.e.,
10.64.102.113) for local SIP users and to the SBCE public IP address (i.e., 10.64.101.102) for SIP remote workers. For SIP remote workers, RTCP will be relayed from SBCE to Nectar. The default values for RTCP Port and Reporting Period were used. Click Save.
The following webpage displays Terminal Group 1 for local SIP users.
The following webpage displays the Terminal Group 2 for SIP Remote Workers.
To assign a terminal group number to a SIP user, navigate to the SIP user CM Endpoint Profile Editor, and in the Feature Options tab, set IP Phone Group ID to the desired terminal group number.
To create a location group, click New in the Location Groups section. In the General section, provide a descriptive Name (e.g., Avaya Workplace) and Description. The Group Type is automatically set to Location Group.
In the VoIP Monitoring Manager section, the IP Address was set to the Nectar IP address (i.e., 10.64.102.113). The default values for RTCP Port and Reporting Period were used. Click Save (not shown). Next, this location group will be assigned to a Location.
To assign the previously configured location group to a Location, select Location Settings in the left pane. Assign the Location Group to a Location as shown below. In this example, the Avaya Equinox location group was assigned to the Thornton location. Note that this method of assigning configuration settings could also have been used for local SIP users (e.g., 96x1 and J100 Series SIP Deskphones) that are local or remote workers.
Configure 46xxsettings.txt File
Alternatively, the Avaya 96x1 and J100 Series SIP Deskphones can derive the RTCP settings from the 46xxsettings.txt file. The RTCP Monitoring parameters for local SIP users can be configured as follows in the file. Note that RTCPMON was set to the Nectar IP address.
################### RTCP MONITORING ##################### ## ## The RTCP monitor ## One RTCP monitor (VMM server) IP address in dotted-decimal format or DNS name ## format (0 to 15 characters). SET RTCPMON 10.64.102.113 ## ## RTCPMONPORT sets the port used to send RTCP information to the IP address specified ## in the RTCPMON parameter. The default value is 5005. SET RTCPMONPORT 5005 ## ## RTCP Monitor Report Period ## Specifies the interval for sending out RTCP monitoring reports (5-30 seconds). ## Default is 5 seconds.FG SET RTCPMONPERIOD 5 ## |
SIP remote workers, assigned to Group 4, can be provided the RTCP Monitoring settings as follows. Note that RTCPMON was set to the public SBCE interface. SBCE will relay RTCP to Nectar as configured in Section 0.
############################################################## # GROUP_4
########## Add SET Statements for GROUP 4 below ############
SET RTCPMON 10.64.102.113
SET RTCPMONPORT 5005
SET RTCPMONPERIOD 5
################ END OF GROUP 4 SETTINGS ##################### GOTO END
Configure Nectar for Avaya
This section covers the Nectar configuration to monitor Communication Manager, Media
Gateways, Media Server and Avaya IP Deskphones using SNMP, RTCP, the SAT interface, and Application Enablement Services SMS Web Service. The configuration was performed via the RIG client. The procedure covers the following areas:
Launch the RIG Client
Configure Communication Manager SAT Access and SNMP Polling
Configure SBCE SNMP Polling
Configure SNMP Traps
Configure Real-Time Quality Monitoring
Launch the RIG Client
In an Internet browser, enter the Nectar IP address in the URL field. The RIG client software is downloaded. Install and run the RIG client. In the Nectar Portal Login screen, enter the user credentials and click Login.
Configure Communication Manager SAT Access and SNMP Polling
Navigate to Modules Avaya Aura CM (r7.0 or above) to display the Avaya Aura CM (r7.0 or above) Setup windows as shown below. Click Add.
In Add Avaya Aura CM Connection, select the General tab. Specify a descriptive name (e.g.,
CommMgr) in the Name field. In the ACM section, set Host/VIP to the Communication
Manager IP address and specify the SAT login credentials, configured in Section 5.2, in the Username and Password fields. In the AES section, specify the IP address of Application
Enablement Service in Host 1 used to direct requests to SMS Web Service. Note that the Communication Manager credentials specified in the ACM section are also used by Nectar when making requests via the SMS Web Service.
SNMP tab, configure SNMP polling access. In this example, SNMPv3 polling was configured as shown in Section 0. SNMPv1 or v2c may also be used by specifying the Community instead. These SNMP credentials are also used for SNMP polling of the Media Gateways and should match the configuration in Section 7.2. Click OK.
Note: SNMP credentials for Communication Manager and the Media Gateways should be the same.
Configure SBCE SNMP Polling
Navigate to Health Elements, and then select Agents in the left pane. In the All Agents section, right-mouse click and select Add as shown below.
Add Agent dialog box, configure the following fields to add an SBCE agent. The SNMP credentials must match the SNMP configuration for the SBCE. Refer to Section 9.2.
| Name: | Specify the agent name (e.g., SBCE). | |
| IP: | Specify the SBCE IP address (e.g., 10.64.102.105). | |
| Create Agent | ||
dependency tree: | Select this option. | ||
| SNMP Version: | Set to V3. | |
| Port: | Set to SNMP polling port 161. | |
| Authentication: | Specify authentication protocol (e.g., SHA). | |
| User ID: | Specify user ID (e.g., nectar). | |
| Password: | Specify authentication password, if required. | |
| Privacy Protocol: | Specify privacy protocol (e.g., AES). | |
| Privacy Password: | Specify privacy password, if required. |
Poll Functions section, right-mouse click and select Add as shown below.
Add Poll Function window, expand eSBC and select the desired poll functions. Click Next.
In the next Add Poll Functions window, click Add.
Configure SNMP Traps
Navigate to Configure Receiver and select the Community Filter tab. The Community Filter serves two purposes:
Filter SNMPv1 and v2c traps based on community name (optional).
Configure credentials for SNMPv3 traps (required).
This section covers the configuration of credentials for SNMPv3 traps. The SNMPv3 trap credentials were configured the same in Communication Manager, Media Gateways, Media Server, and SBCE so only one entry was required. Click Add.
In Add Community Filter, set the SNMP Version to V3, the Port to 162, and specify the credentials as configured on the Avaya products. Click OK.
Configure Real-Time Quality Monitoring
Navigate to Configure Quality Management Real Time QoS and configure the
following fields: | |
RTCP Receiver: | Set to Enabled. |
Traces: | Set to Enabled. |
Receiver Interface: | Set to the Nectar IP address (e.g., 10.64.102.113). |
Receiver Port: | Set to 5005. |
Default Codec: | Set to G.711. |
Hop Name Lookup: | Set to Enabled. |
Click Apply to start the RTCP Receiver.
Verification Steps
This section provides the tests that can be performed to verify proper configuration of Nectar with Communication Manager, Media Gateways, Media Server, and SBCE.
Generate alarm conditions in any Avaya server. Navigate to Health Events to view SNMP traps and events.
Health Agents and then select a Media Gateway under All Agents to view the data collected using SNMP polling, including MG DSP Usage, Fan Speed, and Ambient Temperature Sensor.
Health Agents and then select the SBCE under All Agents to view the data collected via SNMP polling.
Dashboards Dashboard. Note that the Dashboard is customizable. For the compliance test, gauges for trunk and MG DSP usage were created. The following window shows trunk usage.
The following window shows MG DSP usage.
Navigate to Reports Inventory Avaya Aura CM (r7.0 or above) to view the inventory information. The following window shows the Communication Manager inventory list available.
As an example, click on Media Gateways to display the list of Media Gateways.
Establish a call between two Avaya IP Deskphones. Navigate to Health Quality Management Real-Time QoS to view the active calls as shown below. Double-click on one of the calls to view the Real-Time QoS metrics.
The real-time QoS metrics and call path information for the phone are displayed as shown below. Note that there is a call path from a H.323 phone to the media resource and vice versa. There would not be any call path for Avaya SIP Deskphones or Media Server as mentioned in Section 2.2.
Conclusion
These Application Notes described the configuration steps required to integrate Nectar for Avaya with Avaya Aura® Communication Manager, Avaya G430/G450 Media Gateway, Avaya Aura® Media Server, Avaya Session Border Controller for Enterprise using SNMP, RTCP, the SAT interface, and Avaya Aura® Application Enablement Services System Management Service Web Service. The compliance test passed with observations noted in Section 2.2.
Additional References
This section references the Avaya documentation relevant to these Application Notes available at http://support.avaya.com.
Administering Avaya Aura® Communication Manager, Release 10.1, Issue 3, August 2022.
Administering Avaya Aura® System Manager, Release 10.1.x, Issue 6, June 2022.
Administering Avaya Aura® Session Manager, Release 10.1.x, Issue 3, April 2022.
Administering Avaya G430 Branch Gateway, Release 10.1, Issue 2, July 2022.
Administering Avaya G450 Branch Gateway, Release 10.1, Issue 2, July 2022.
Administering Avaya Session Border Controller for Enterprise, Release 10.1, Issue 1, December 2021.
Administering Avaya Aura® Application Enablement Services, Release 10.1.x, Issue 4, April 2022.
©2022 Avaya Inc. All Rights Reserved.
Avaya and the Avaya Logo are trademarks of Avaya Inc. All trademarks identified by ® and ™ are registered trademarks or trademarks, respectively, of Avaya Inc. All other trademarks are the property of their respective owners. The information provided in these Application Notes is subject to change without notice. The configurations, technical data, and recommendations provided in these Application Notes are believed to be accurate and dependable, but are presented without express or implied warranty. Users are responsible for their application of any products specified in these Application Notes.
Please e-mail any questions or comments pertaining to these Application Notes along with the
full title name and filename, located in the lower right corner, directly to the Avaya DevConnect Program at devconnect@avaya.com.