--- title: "Avaya CMS VKM Configuration Guide" slug: "avaya-cms-vkm-configuration-guide-1" updated: 2024-06-06T14:16:15Z published: 2024-06-06T14:16:15Z canonical: "support.nectarcorp.com/avaya-cms-vkm-configuration-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. # Avaya CMS VKM Configuration Guide ## Overview This guide provides the instructions to configure the monitoring and management of the Avaya CMS using the Nectar Avaya CMS VKM, a core component of Nectar’s Foundation module. ### About this Guide This guide explains how to: ##### [Enable Avaya CMS VKM](/docs/avaya-cms-vkm-configuration-guide-1#_bookmark10) ##### [Configure Avaya CMS (Solaris)](/docs/avaya-cms-vkm-configuration-guide-1#_bookmark12) ##### [Configure Avaya CMS (Linux)](/docs/avaya-cms-vkm-configuration-guide-1#_bookmark17) ### Audience This guide is intended for system administrators or engineers who have system administration access and technical knowledge of Avaya ACM, Avaya CMS, and operating systems (Linux/ Solaris), as well as a familiarity with deploying the Nectar Foundation module. ### Supported Software Versions - Nectar v8.7 - Avaya CMS (Solaris) r16.0 and prior - Avaya CMS (Linux/SNMP) r17 and above* * Avaya CMS r19 is via SNMP traps only ### ### ### ### Solution Features The following Dependency Trees will be created per CMS: - ACD Links (prior to r17) - ACD Link Status (up/down per Link 1-8) - System - CPU Utilization - Swap Usage - Physical Memory - Disk Space (per disk) - CMS Processes (legs vary per CMS release - prior to r17) - CMS Process Count aar - CMS Process Count Harchiver - CMS Process Count Ed - CMS Process Count admlogger - CMS Process Count int_crec (R13 only) - CMS Informix Process Count - CMS Processes (legs vary per CMS release - r17 and r18) - Process Active aar - Process Active admlogger - Process Active aomsrv - Process Active avahi-daemon - Process Active cms_mon - Process Active HA Heartbeat - Process Active harchiver - Process Active java - Process Active networkmanager - Process Active snmpd - Process Active web_gateway - System Up Time You can also schedule reports to run weekly or monthly. These can be delivered through email. The following real-time data is collected, which you can report against: - CPU Utilization - Disk Usage - Memory Utilization - ACD Link Uptime ## Enable Avaya CMS VKM Follow these steps to enable the Avaya CMS VKM: 1. Navigate to **RIG** > **Module Configuration**. The **Module Configuration** window appears. 2. Select the following module: #### Avaya CMS | | | --- | | | | | | | | | | | 1. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-6cpe8ep5.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D)Click **Apply**. *Figure 2-1Enable Avaya CMS VKM* 1. 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/avaya-cms-vkm-configuration-guide-image-5z9t5cdd.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 2-2Restart* ***Note*** *After you enable this module,* ***Avaya > CMS*** *is now a module under the* ***Modules*** *menu.* ## Configure Avaya CMS (Solaris) Avaya CMS r13-16 (Solaris) is slightly different than Avaya CMS r17 and above (Linux). You will configure Nectar differently for these two versions. [See “Configure Avaya CMS (Linux)” on](/docs/avaya-cms-vkm-configuration-guide-1#_bookmark17) [page 16.](/docs/avaya-cms-vkm-configuration-guide-1#_bookmark17) This section explains how to: ##### [Configure Avaya CMS (Solaris)](/docs/avaya-cms-vkm-configuration-guide-1#_bookmark13) ##### [View Pollers](/docs/avaya-cms-vkm-configuration-guide-1#_bookmark14) ##### [View Dependency Tree](/docs/avaya-cms-vkm-configuration-guide-1#_bookmark15) ### Configure Avaya CMS (Solaris) Follow these steps to configure the Avaya CMS (Solaris), which uses an SSH or Telnet connection type: 1. Navigate to **Modules > Avaya > CMS**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-d1cicz47.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 3-1Modules > Avaya > CMS* The **CMS Connection** window appears. ***Note*** *To configure Avaya CMS (Solaris) and to access this menu, you must have an enabled CMS license.* 1. Right-click in the **CMS Connections** pane and select **Add**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-qoi3fjz0.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 3-2Add* The **Add CMS Connection - Connection** tab window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-3x30zqhr.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 3-3Add CMS Connection* 1. Complete the following parameters: | **Parameter** | **Description** | | --- | --- | | **Connection Type** | Select one of the following: - **SSH** (for Avaya CMS running on **Solaris**) - **Telnet** (for Avaya CMS running on **Solaris**) | | **Name** | Enter the server name to be onboarded. | | **Description** | Enter a description for the onboarded system. | | **IP** | Enter the IP address of the server. | | **Port** | Enter the port number of the server. | | **Username** | Enter the username used to access the server. | | **Password** | Enter the password used to access the server. | *Table 3-1 Add CMS Connection* 1. Click the **ACD Links** tab. The following window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-0pkt4yv0.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 3-4ACD Links* 1. Select an **Automatic Call Distribution (ACD) Link** to indicate the interface with which CMS is communicating. 2. For each ACD Link, select one of the following using the drop-down: #### Unconfigured #### None ***Note*** *Set the option to* ***None*** *for links that are not attached to a CLAN, or choose the appropriate CLAN for the ACD Link.* 1. Click **OK**. Nectar UCMP will login to the Avaya CMS and determine the CMS version. ### View Pollers Follow these steps to display all configured pollers: 1. Navigate to **Health > Elements**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-jonhfhns.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 3-5Health > Elements* The **Elements** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-o0tygowi.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 3-6Elements* 1. Click **Folders**. The **Root Folders** pane appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-p9ls8ay6.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 3-7Folders > CMS* 1. Click the **CMS** folder. The **Infrastructure** pane appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-r71e9kib.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 3-8Infrastructure* 1. Click **CMS Server** to view all configured pollers. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-2ity7pc5.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 3-9Poll Functions Figure 3-10* ### View Dependency Tree The VKM also builds a dependency tree for the CMS. Follow these steps to view a dependency tree for the CMS: 1. Navigate to **Configure > Dependency Trees**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-oo6m396b.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 3-11Configure > Dependency Tree* The **Configure Dependency Tree** window appears. 1. Double-click on the **AvayaCMS** dependency tree in the **Tree Name** pane on the left. The dependency tree structure appears in the pane to the right. 2. View the following example that shows CLAN associations: ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-5ha2zjpx.jpe?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 3-12Dependency Tree with Multiple CLAN ACD Links* ***Note*** *To set up and configure the SSH or Telnet connection types on R13, R14, R15, or R16, see* ***Avaya Call Management System Software Installation, Maintenance, and Troubleshooting for Linux Guide****, which is available at:* [***http://www.avaya.com****.*](http://www.avaya.com/) ## Configure Avaya CMS (Linux) Avaya CMS r13-16 (Solaris) is slightly different than Avaya CMS r17 and above (Linux). You will configure Nectar differently for these two versions. [See “Configure Avaya CMS (Solaris)” on](/docs/avaya-cms-vkm-configuration-guide-1#_bookmark12) [page 10.](/docs/avaya-cms-vkm-configuration-guide-1#_bookmark12) Follow these steps to configure the Avaya CMS (Linux) on versions r17 and r18, which uses the SNMP connection type: 1. Navigate to **Modules > Avaya > CMS**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-h7ajq24s.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 4-1Modules > Avaya > CMS* The **CMS Connection** window appears. ***Note*** *To configure Avaya CMS (Linux) and to access this menu, you must have an enabled CMS license.* 1. Right-click in the **CMS Connections** pane and select **Add**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-m35w1bam.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 4-2Add* The **Add CMS Connection - Connection** tab window appears. 1. Select **SNMP** as the **Connection Type** using the drop-down. The following **Add CMS Connection** window appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-lzil6jak.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 4-3Add CMS Connection - SNMP R17* 1. Complete the following **Primary** parameters: | **Parameter** | **Description** | | --- | --- | | **Primary:** | | | **Name** | Enter the primary Linux server name to be onboarded. | | **Description** | Enter a description of the primary Linux server. | | **IP** | Enter the primary IP address of the primary Linux server. | *Table 4-1 Add CMS Connection* 1. Complete the following **Secondary** parameters. ***Note*** *You do not have to have a secondary server. These are used in high-availability (HA) situations as backup servers and only applies if you have a HA CMS Server.* | **Parameter** | **Description** | | --- | --- | | **Secondary:** | | | **Name** | Enter the secondary Linux server name to be onboarded. | | **Description** | Enter a description of the secondary Linux server. | | **IP** | Enter the secondary IP address of the secondary Linux server. | *Table 4-2 Add CMS Connection* 1. Enter the following **SNMP** parameters. | **Parameter** | **Description** | | --- | --- | | **SNMP:** | | | **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 4-3 SNMP* ### View Pollers Follow these steps to display all configured pollers: 1. Navigate to **Health > Elements**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-q00v5fbu.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) The **Elements** window appears. *Figure 4-4 Health > Elements* ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-ct2zo874.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) 1. Click **Folders**. The **Root Folders** pane appears. *Figure 4-5 Elements* ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-dd0fugnc.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 4-6 Folders > CMS* 1. Click the **CMS** folder. The **Infrastructure** pane appears. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-sicqu6dz.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 4-7 Infrastructure* 1. Click **CMS Server** to view all configured pollers. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-ldmlg5zu.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 4-8 Poll Functions* ### View Dependency Tree The VKM also builds a dependency tree for the CMS. Follow these steps to view a dependency tree for the CMS: 1. Navigate to **Configure > Dependency Trees**. ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-tgucnn3b.png?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 4-9 Configure > Dependency Tree* The **Configure Dependency Tree** window appears. 1. Double-click on the **AvayaCMS** dependency tree in the **Tree Name** pane on the left. The dependency tree structure appears in the pane to the right. 2. View the following example: ![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cms-vkm-configuration-guide-image-6102b59o.jpe?sv=2026-02-06&spr=https&st=2026-11-08T16%3A58%3A26Z&se=2026-11-08T17%3A58%3A26Z&sr=c&sp=r&sig=NN%2FaXCpk%2FCxdrKh0Tsij9JgRv%2FdHK0%2FkQmHqcX0hVpc%3D) *Figure 4-10 Dependency Tree*