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.

Version 2021.2

Prev Next

Upgrade Requirements

The database migrations performed in release 2021.2 will make it difficult to downgrade to Nectar Foundation releases 8.7.1 and below. We strongly advise customers to back up the RIG database before upgrading to 2021.2.

Nectar Foundation 

WARNING
The Derby database version was upgraded in Release 8.3. This makes downgrade impossible. Customers MUST back up the database directory BEFORE upgrading to Release 8.3.
  • It is not possible to use Remote Software Upgrade on a Linux platform to upgrade from a version prior to v8.6.
  • RIG Client requires JRE 1.8 and above.
  • Note: Runtime version will be enforced before RIG Client JAR files are downloaded.
  • Before upgrading to v2021.2, your existing installation must be at v5.6.2.x or later, licensed, and started successfully. If you attempt to upgrade directly to v2021.2, then the installer will display the following message: Selected installation’s main version is earlier than 5.6.2 required for upgrade.
  • For the server to start successfully, the port number specified for the serverport property of the server.properties file must not be in use. If the port is already in use, change the port number to an unused port number to correct the issue. The default port number is 80.

Technical Notes

Cisco UCM VKM

  • When upgrading RIGs from a release prior to v8.0 that are monitoring Cisco UCM systems, additional time will be required based on the number of historical call detail records (CDRs) to perform database migration following restart.
  • If the Cisco UCM VKM module is enabled on a system when upgrading to v2021.1 from a pre-7.x release, the Installer will detect it and display a warning message, informing the user to offboard any existing Cisco UCM systems before proceeding with the upgrade. For more information on offboarding, see Cisco UCM VKM Configuration Guide.
  • Once the Cisco UCM system(s) has been offboarded, the user can re-run the upgrade process and select the Module Override to complete the upgrade.

Cisco Meeting Server VKM

For licensing, a status is received for each type of license (nolicense, activated, or expired). If a nolicense case, a WARNING event is generated. However, if the customer does not want to see these nolicense events, they can disable the associated poller(s).

Cisco Expressway VKM

When onboarding Cisco Expressway VKM, use the same username and password across all cluster peers.

Microsoft Skype for Business VKM

Customers who upgrade to v2021.2 have the option to continue using the Legacy SfB module. However, to access the new SfB features available since v8.0, you must:

  • Offboard the Legacy SfB system.
  • Enable and onboard the new SfB VKM and system.

Avaya Call Management System (CMS) VKM

As of v8.1, Nectar no longer supports Avaya CMS r16 (and earlier). CMS r16 uses the 256-bit Diffie-Helman encryption algorithm, which is considered a security risk and has been deprecated. It is no longer supported in current SSH-2 implementations.

If you accept this CMS security vulnerability, you can maintain CMS r16 monitoring with Nectar using a Nectar version prior to v8.1.

Avaya System Manager VKM

If you onboard Avaya System Manager with invalid credentials, you must delete the incorrect entry and re-onboard the System Manager.

For more information, see Nectar Deployment Guide – Avaya System Manager r7.1 and above.

Avaya Service Monitoring Web Services API

Nectar leverages Avaya’s Service Monitoring Web Services API (IP Office r10.1 and above). If you are currently monitoring an IPO r10.1 or above with Nectar v7.3 and prior, you can migrate to Nectar’s new API support by following these steps:

  • Disable and remove the existing monitoring.
  • Delete any IP Office traps in the Receiver module.
  • Disable the previous module and enable the new module using RIG > Module Configuration.
  • Restart the RIG.

For more information, see Avaya IP Office r10.1 and above Deployment Guide.

Mother Module

The Mother Module must be enabled for Perspective deployments. For more information, see Mother Module RIG Guide.

Properties File

After upgrading to v2021.2, if you have or plan to manipulate a properties file that uses a file path or directory, then you must verify that you are using the proper backslash () or forward slash (/):

  • Windows: Use double backslash (\), for example, :\\<folder|file>, or
    • Use single forward slash (/), for example, ://<folder|file>
  • Linux/iOSUse single forward slash (/), for example, //<folder|file>

General Data Protection Regulation

You must upgrade to ‘Version 7.2 or later’ (CIP, EIP, RIG, Perspective Agent/Controller as well as the Nectar Foundation Client) to enable the new General Data Protection Regulation (GDPR) audit logging. Logging is enabled by default but can be customized to suit your specific auditing needs. The Apps<partner name>\etc\log4j2.xml file is used to enable that customization after the upgrade to ‘Version 7.2 or later’.

The upgrade to ‘Version 7.2 or later’ will back up your existing log4j2.xml file before installing the new version of that file.

If you have previously customized the log4j2.xml file, you will have to manually migrate those changes to the new log4j2.xml file. Your previous version can be accessed by navigating to Apps<partner name>\rollback\etc\log4j2.xml AFTER you have upgraded.

New Features, Improvements and Resolved Issues

Below you will find improvements, bug fixes, and technical upgrades for v2021.2.

New Features

  • [CMP-10407] Added RESTful API to edit Genesys server configuration settings.

Improvements

  • [CMP-9765] - Modified the Cisco CMS VKM to allow users to specify a custom WebAdmin port for each node in the CMS cluster
  • [CMP-10188] - Modified the Cisco CMS VKM to add all pollers to secondary nodes rather than just the primary
  • [CMP-10345] - Added a threshold for “no answer” to the Layer 2 interface pollers in the Cisco UCM VKM to distinguish between interface down and server unreachable states
  • [CMP-10366] - Implemented RIG Client session time limit for all authentication types including RADIUS and Active Directory
  • [CMP-10369] - Upgraded MS SQL JDBC driver that hosts the Skype for Business QoE database. 
  • [CMP-10412] - Cisco CMS VKM creates an agent for each server in the cluster.
  • [CMP-10417] - Updated OpenJDK runtime to version 8u302.

Resolved Issues

  • [CMP-10312] - Fixed error in Resourse Utilization Report.
  • [CMP-10341] - CiscoUCM agent name is changes automatically.
  • [CMP-10375] - RIG client unable to connect to the server after SSL certificate installed.
  • [CMP-10378] - AD setting does not appear to replicated between waysides.
  • [CMP-10421] - Swagger API portal is not working (Nectar Documentation).
  • [CMP-10452] - Cisco Video: MCU devices are discovered through TMS.

Technical Documentation

The following documents were created and/or revised for release 2021.2 and can be found on the Nectar Knowledge Center. For all other documents, look in previous releases in the Nectar Knowledge Center.

FilenameDocument Name
Nectar Foundation RIG CentOS Linux Installation r2021.2 v5.pdfNectar Foundation RIG CentOS Linux Installation
Nectar Foundation SSL Certificates Configuration Guide r2021.2 v5.pdf

Nectar Foundation SSL Certificates Configuration Guide

Cisco UCM VKM Configuration Guide v2021.2 v5.pdf
Nectar Foundation Cisco UCM VKM Configuration Guide
Nectar Deployment Guide-Avaya IP Office r10.1 and above_v3.pdf
Nectar Deployment Guide: Avaya IP Office r10.1 and above

Supported Products

Currently, Nectar supports the following devices and applications. Nectar is consistently adding support for different devices and applications.

NOTE
Nectar can monitor any server-based (Windows or Linux) application. Please check with your Nectar Channel Account Manager for an application or device that you would like to monitor that is not listed here.

Vendor Knowledge Modules (VKMs)

Avaya Aura Communication Manager (ACM)
- r5, r6, r7, and r8

Cisco Meeting Server
- Cisco Meeting Server r2.2 and later

Avaya Business Communication Manager (BCM)
- r5 and r6

Cisco Unified Communications Manager (CUCM)
- r9.1, r10.5, r11.x, and r12.x

Avaya Call Management System (CMS)
- r13, r14, r15, r16, r17, r18, and r19
NOTE: CMS r16 and earlier require using a Nectar release prior to Nectar r8.1.

Cisco Unity Connection
r9, r10, r11, and r12

Avaya Communication Server 1000 (CS1000)
- r6 and r7

Cisco Expressway
- vX8.9

Avaya System Manager
- R5, r6 via SSH connection
- R7.1.3 and above via API

IPC Unigy
- Requires Blue Wave r3.1

Avaya Session Manager
- R5, r6 via SSH connection
- R7.1.3 and above via API

Microsoft Lync 2010 and 2013

Avaya IP Office
- r5 through r10: via SSA integration
- r10.1 and above: via Service Monitoring API integration (requires Nectar r7.4 and above)

Microsoft Skype for Business
Avaya Modular Messaging
- r3, r4, r5, r6, and r7

Uninterruptible Power Supply (UPS) Module
- RFC-1628 compliant

Avaya Voice/Experience Portal (AVP/AEP)
- r5, r6, and r7


Vendor Knowledge Scripts 

Cisco Unified Border Element (CUBE)Sonus 1K/2K Session Border Controllers (SBCs)
Cisco 4K and 5K Integrated Services Routers (ISRs)VMware ESXi

Information Packs

Aculab PLC Groomer II

Juniper Networks Netscreen VPN Firewall Poller Pack

AudioCodes Mediant Gateway Poller Pack
- 1000 and 3000

Juniper Networks Netscreen VPN Firewall Trap Pack

AudioCodes Mediant Gateway Trap
-1000 and 3000

Juniper Networks Poller Pack

Avaya Aura AES Poller Pack

Juniper Networks Trap Pack

Avaya Aura AES Trap Pack

Linux Server (Host Wizard)

Avaya Media Gateway Poller Pack

Microsoft Server (Host Wizard)

Avaya G860 Media Gateways

Nagios Trap Pack

Cisco Router Poller Pack

NetApp Poller Pack

Cisco Router Trap Pack

NetApp Trap Pack

Dell OpenManage Poller Pack

NICE Perform eXpress Trap Pack

Extreme Networks Poller Pack

Oracle Poller Pack

Extreme Networks Trap Pack

Oracle Trap Pack

Genesys Poller Pack

Oracle Solaris Poller Pack

Genesys Trap Pack

Sonus 1K/2K Poller Pack

HP Autonomy etalk Qfiniti Call Recording Trap Pack

VMware Poller Pack