Login
      Contents x
      Avaya System Session Manager r6.3 and above Deployment Guide
      • 06 Jun 2022
      • 11 Minutes to read
      • Print
      • Dark
        Light
      • PDF
      Contents

      Avaya System Session Manager r6.3 and above Deployment Guide

      • Updated on 06 Jun 2022
      • 11 Minutes to read
      • Print
      • Dark
        Light
      • PDF
      Article summary

      Overview

      This guide provides the instructions to configure SIP monitoring and management of Avaya System/Session Manager using Nectar’s VKM, a core component of Nectar’s Foundation module.

      About this Guide

      The guide explains how to:

      Configure Avaya System/Session Manager
      Configure Avaya System/Session Manager VKM
      Monitor the System Manager
      Monitor the Session Manager

      Audience

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

      Supported Software Versions

      • Nectar v8.7
      • Avaya Aura System/Session Manager r5 and r6.


      NOTE
      If you have System/Session Manager r7.1 and above, refer to document Nectar Deployment Guide-Avaya System Manager r7.1 and above.

      Prerequisites

      For System Manager:

      • IP address
      • Username and password (read only access) For Session Manager:
      • IP address
      • Username and password (Administrative permissions)
      • SNMP string (read only)
      • SNMP version


      NOTE

      Avaya Product Support Notice PSN#PSN004727u

      Session Manager servers running v6.3 and later software have been known to experience outages related to an exhaustion of postgres database connections on a Session Manager server as a result of:

      • Offboard polling applications experiencing errors.
      • Database connections that are not being cleaned up.

      Nectar does not cause this issue. We do use the sm console to collect SIP Entities and SIP Entity status.



      NOTE
      When using Avaya System/Session Manager VKM, Java 1.8 must be loaded on the server. If not, RIG will load correctly, but it will freeze on shutdown. The server will need to be restarted.


      Technical Support

      To receive technical support, contact Nectar in one of the following ways:

      Use your company's login information to access the documentation.

      Product Documentation

      For additional information, see:

      • Remote Intelligence Gateway (RIG) Administration Guide
      • Avaya CMS VKM Configuration Guide (www.avaya.com)

      Configure Avaya System/Session Manager

      Configuring the Avaya System/Session Manager includes the following tasks:

      Create a New User Account for System Manager

      A System Manager user account is required to retrieve information about Session Managers. Follow these steps to create a new User Account for System Manager:

      1. Login to the System Manager web interface.
      2. Browse to Groups and Roles\Roles\New.
      3. Create a new role:

      New role - nectarReadOnly

      Description - Nectar Read Only

      1. For the permission set, click Add.
      2. Add each permission set with the exception of scheduleroperation: Action = View

      Selected Groups = All

      Attributes = All

      1. Browse to User Management and add a new user account.

      Last Name = UCMP First Name = Nectar Login Name = Nectar

      1. Assign the new user account to the new role, nectarReadOnly.

      Create a New User Account for Session Manager

      A user account for Session Manager is used to retrieve SIP trunk and user registration information.

      1. Login to the each Session Manager.
      2. Create a new user account with cust privileges:

      Username = Nectar

      To enable SNMP monitoring from the CLI see the Avaya document Administering Avaya Aura System Manager for Release 6.3.

      1. Navigate to Section: Managing SNMP Access Profiles, and Managing Serviceability Agents.
      2. Follow the instructions for creating a Serviceability agent for SNMP and deploy to the Session Managers.

      Configure Avaya System/Session Manager VKM

      Configuring the Avaya System/Session Manager VKM includes the following tasks:

      Enable System/Session Manager VKM
      Add a System Manager Connection


      NOTE

      You can adjust the timeout for commands that are being sent to the Session Manager over the SSH connection. The default timeout value for the SM Command Prompt is 10000ms (10 seconds). It is now configurable up to 60000ms (60 seconds).

      Edit the avayaSessionManager-module.properties file by adding this statement:

      sshCommandPromptTimeout=

      Substitute a value to the right of the equals (=) sign to a value greater than 10000ms (10 seconds), or less than 60000ms (60 seconds).

      Enable System/Session Manager VKM

      Follow these steps to enable the Avaya System/Session Manager VKM:

      1. Navigate to RIG > Module Configuration.

      Figure 3-1 RIG > Module Configuration

      The Module Configuration window appears.

      Figure 3-2 Module Configuration

      1. Select Avaya System/Session Manager; then click Apply.
      2. To restart the RIG and apply the changes:
        1. Navigate to RIG > Admin > Restart.
        2. When the following message appears, click Yes.

      Figure 3-3 Restart


      NOTE
      After you enable this module, Avaya is a module under the Modules menu.


      Add a System Manager Connection

      Follow these steps to add a System Manager connection using the VKM:

      1. Navigate to Modules > Avaya > System Manager.

      Figure 3-4 Modules > Avaya > System Manager

      The Avaya System Manager - Connections window appears.

      Figure 3-5 Avaya System Manager

      1. Right-click in the Connections pane and select Add.

      Figure 3-6 Select Add

      The Add System Manager dialog box appears.

      Figure 3-7 Add System Manager

      1. Enter the following information.

      Field

      Enter ...

      Version

      Select r6.3 version.

      Name

      Name for the System Manager connection.

      IP

      N/A

      Port

      N/A

      Username

      N/A

      Password

      N/A

      Description

      Description of the System Manager.

      Table 3-1 Parameters

      NOTE
      IP, Port, Username and Password fields do not need to be populated


      1. Click Add.

      The RIG logs into the System Manager and detects any Session Managers. The Add System Manager dialog box re-appears.

      Figure 3-8 Add System Manager


      NOTE
      IP, Port, Username and Password fields do not need to be populated


      1. For each Session Manager, enter the following values:

      Field

      Enter/Select ...

      IP

      N/A

      Port

      N/A

      Username

      N/A

      Password

      N/A

      Description

      Description of the Session Manager.

      SNMP Version

      SNMP version from one of the following:

      • V1
      • V2
      • V3

      Port

      SNMP port, such as 161.

      Community

      Community string previously configured.

      Authentication

      Authentication from one of the following:

      • None
      • MD5
      • SHA


      NOTE
      Enabled for SNMP V3 only.


      User ID

      User ID previously set up for the SNMP read only community string.

      Note: Enabled for SNMP V3 only.

      Password

      Password previously set up for the SNMP read only community string.

      Note: Enabled for SNMP V3 only.

      Privacy Protocol

      Protocol from one of the following:

      • None
      • DES
      • AES
      • AES-192
      • AES-256

      Note: Enabled for SNMP V3 only.

      Privacy Password

      Password for the Privacy Protocol.

      Note: Enabled for SNMP V3 only.

      Table 3-2 Parameters

      1. Click OK.

      The VKM configures the pollers for each Session Manager; then discovers and sets up pollers for all SIP entities.

      1. Click Done.

      The new System Manager connection appears in the System Manager - Connections

      window. The Nectar UCMP monitors these connections.

      From this window, you can also access commands to add, edit, or remove a System Manager connection, as well as collect user registrations and SIP entities. For more information, see Monitor the System Manager .

      Monitor the System Manager

      Before you can perform any of the following tasks, you must add a System Manager VKM to the UCMP. For more information, see Configure Avaya System/Session Manager.

      After adding a System Manager VKM to the Nectar UCMP, you can use the System Manager VKM to perform the following tasks:

      Edit the Parameters of an Existing System Manager
      Collect User Registrations
      Collect SIP Entities and Configure Monitoring
      Remove a System Manager

      Edit the Parameters of an Existing System Manager

      Follow these steps to view and edit the parameters of an existing System Manager connection:

      1. Navigate to Modules > Avaya > System Manager.

      The Avaya System Manager - Connections window appears.

      1. Select a connection; then right-click and select Edit.

      Figure 4-1 Avaya System Manager

      The Edit System Manager dialog box appears.

      Figure 4-2 Edit System Manager

      1. Make changes, as needed; then click OK.

      Collect User Registrations

      Follow these steps to collect the user registrations for an existing System Manager:

      1. Navigate to Modules > Avaya > System Manager.

      The Avaya System Manager Setup - Configurations (tab) - Connections window pane appears.

      1. Select a connection; then right-click and select Collect User Registrations. The VKM creates a table with SIP users registered to the Session Manager.
      2. To view the table, navigate to Reports > Inventory > Avaya > System Manager (r6.3).

      Figure 4-3 Inventory

      The Session Manager Inventory window appears.

      Figure 4-4 Session Manager Inventory

      1. Click View User Registrations.

      The Listing pane appears to the right with a list all of the SIP users registered to that Session Manager.

      Collect SIP Entities and Configure Monitoring

      The VKM runs a collection process every midnight to create a list of all of the SIP entities, as well as to configure monitoring for those entities.

      Follow these steps to run a collection on demand:

      1. Navigate to Modules > Avaya > System Manager.

      The Avaya System Manager Setup - Configurations (tab) - Connections window pane appears.

      1. Select a connection; then right-click and select Collect SIP Entities and Configure Monitoring.

      The VKM creates a table with SIP entities registered to the Session Manager.

      1. To view the table, navigate to Reports > Inventory > Avaya > System Manager (r6.3).

      The Session Manager Inventory window appears.

      1. Click View SIP Entities.

      Figure 4-5 Session Manager Inventory

      The Listing pane appears to the right with a list all of the SIP users registered to that Session Manager.

      Remove a System Manager

      Follow these steps to remove a System Manager from the Nectar UCMP:

      1. Navigate to Modules > Avaya > System Manager.

      The Avaya System Manager Setup - Configurations (tab) - Connections window pane appears.

      1. Select a connection you want to remove; then right-click and select Remove.
      2. The Restart confirmation dialog box appears; click Yes. The connection is removed.

      Monitor the Session Manager

      You can view the Session Manager(s) associated with a System Manager. You can also access commands to enable, disable, or remove a Session Manager(s). You can also access commands to trace, view SIP links, and view additional options.

      Managing the Session Manager VKM includes the following tasks:

      Edit the Session Manager Configuration
      Modify VKM Options
      Enable a Session Manager
      View SIP Links
      View Current and Past Traces
      Enable CDR FTP
      Disable CDR FTP
      Disable a Session Manager
      Remove a Session Manager

      Edit the Session Manager Configuration

      Session Managers are automatically added to the Nectar UCMP when you execute the Avaya System/Session Manager VKM. However, there may be occasions when you need to modify the existing configuration.

      Follow these steps to edit the Session Manager configuration:

      1. Navigate to Modules > Avaya > Session Manager.

      The Avaya System Manager Setup - Configurations (tab) - Connections window pane appears.

      1. Select a Session Manager connection you want to edit; then right-click and select Edit.

      Figure 5-1 Edit Session Manager

      The Edit Session Manager dialog box appears.

      Figure 5-2 Edit Session Manager

      Table 5-1 Edit Session Manager Parameters

      Field

      Description

      Name

      Identifies the name of the Session Manager.

      Description

      Provides a description of the Session Manager.

      IP

      Identifies the IP address of the System Manager.

      Port

      Identifies the connection port for the System Manager.

      Username

      Identifies the username used to connect to the System Manager.

      Password

      Identifies the password associated with the username entered.

      1. Make changes to the parameters, as needed; then click OK.

      The updated Session Manager appears in the Avaya Session Manager - Connections

      window.

      Modify VKM Options

      Modifying the VKM options for a Session Manager includes the following tasks:

      View VKM Options
      Edit an Existing VKM Option
      Add a VKM Option to an Existing Session Manager
      Remove a VKM Option

      View VKM Options

      Follow these steps to view the VKM options:

      1. Navigate to Modules > Avaya > Session Manager. The Avaya Session Manager Setup window appears.
      2. Select a Session Manager connection; then select VKM Options.

      Figure 5-3 View VKM Options

      The VKM Options window appears.

      Figure 5-4 VKM Options

      Table 5-2 SIP VKM Options

      Parameter

      Description

      readerThreads

      • Number of reader threads for the Session Manager.
      • Default value is 1.

      stationFrequencyMinutes

      • Default value is 60 minutes.

      sessionManagerFTPUsername

      • Username for sftp of CDR files from the Session Manager to the RIG.

      sessionManagerFTPPassword

      • Password for the sftp of CDR files from the Session Manager to the RIG.

      sessionManagerFTPPort

      • Port that the Session Manager uses for sftp.

      sessionManagerFTPSrcDir

      • Directory where the Session Manager places the CDR file.
      • Default value is /

      etlCdrUsername

      • Username for sftp for sending CDR files from UCMP to the CDR Stitching server.

      Parameter

      Description

      etlCdrPassword

      • Password for sftp for sending CDR files from UCMP to the CDR Stitching server.

      etlCdrIp

      • IP address of the CDR Stitching server

      etlDestDir

      • Destination directory where the CDR file will be placed on the CDR Stitching server.
      • This should be created before enabling CDR for Session Manager.
      • Default value is /.

      etlCdrPort

      • Port number the CDR Stitching server is using for sftp connections.
      • Default value is 22.

      rigDestinationDirectory

      • Directory on the RIG where the CDR file from the Session Manager will be placed.
      • Default value is etc/cdr/.

      Table 5-2 SIP VKM Options

      Edit an Existing VKM Option

      Follow these steps to edit a VKM option:

      View VKM Options.
      1. In the VKM Options window, right-click on a parameter, then select Edit.

      Figure 5-5 VKM Options

      The Edit VKM Option dialog box appears.

      Figure 5-6 Edit VKM Options

      1. Enter a new value for the VKM Option in the Value field and click OK. The VKM option appears with the new value.

      Add a VKM Option to an Existing Session Manager

      Follow these steps to add a VKM Option to an existing Session Manager:

      View VKM Options.
      1. Right-click in the VKM Options window and select Add.

      The Add VKM Option dialog box appears.

      Figure 5-7 Add VKM Option

      1. In the Parameter field, enter the parameter you want to add.
      2. In the Value field, enter the value for the parameter you just entered.
      3. Click OK.

      The new parameter appears as one of the VKM Options.

      Remove a VKM Option

      Follow these steps to remove a parameter from the VKM:

      1. Navigate to Modules > Avaya > Session Manager.

      The Avaya Session Manager - Connections window appears.

      1. Select a Session Manager connection you want to edit; then right-click and select View VKM Options.

      The VKM Options window appears.

      1. Select the VKM option you want to remove; then right-click and select Remove. The VKM Options window appears without the parameter.

      Note

      You will not receive an Are you sure? message before the parameter is deleted.

      Enable a Session Manager

      Follow these steps to enable a previously disabled Session Manager:

      1. Navigate to Modules > Avaya > Session Manager.

      The Avaya Session Manager - Connections window appears.

      1. Select a Session Manager connection you want to enable; then right-click and select Enable.

      View SIP Links

      Follow these steps to view a SIP link for an existing Session Manager:

      1. Navigate to Modules > Avaya > Session Manager.

      The Avaya Session Manager - Connections window appears.

      1. Select a Session Manager connection; then right-click and select View SIP Links. The SIP Links window appears.
      2. View the SIP link for the Session Manager, which includes the IP address, port, and protocol.

      View Current and Past Traces

      Viewing current and past traces includes the following tasks:

      Execute a SIP Trace
      View Past SIP Traces

      Execute a SIP Trace

      Follow these steps to execute a SIP trace for a Session Manager:

      1. Navigate to Modules > Avaya > Session Manager.

      The Avaya Session Manager - Connections window appears.

      1. Select a Session Manager connection to execute a trace; then right-click and select Trace. The Trace - Current Trace window appears.
      2. To limit the trace, enter one or more of the following parameters in the appropriate field:
        • URI/Number
        • IP
        • Call-ID
      3. Click Start.

      The trace data appears.

      1. Click Stop to stop the trace.

      View Past SIP Traces

      Follow these steps to view past SIP traces for a Session Manager:

      1. Navigate to Modules > Avaya > Session Manager.

      The Avaya Session Manager - Connections window appears.

      1. Select a Session Manager connection to view past traces; then right-click and select Trace. The Trace - Current Trace window appears.
      2. Click the Past Traces tab.
      3. View the past traces.

      Enable CDR FTP

      Follow these steps to enable CDR FTP for an existing Session Manager:

      1. Navigate to Modules > Avaya > Session Manager. The Avaya Session Manager Setup window appears.

      Figure 5-8 VKM Options - CDR Enable

      1. Select a Session Manager connection you want to enable CDR FTP; then click the VKM Options menu.
      2. Right-click on the smCdrEnable parameter and make sure value is set to true. The status is now enabled.

      Disable CDR FTP

      Follow these steps to disable CDR FTP for an existing Session Manager:

      1. Navigate to Modules > Avaya > Session Manager. The Avaya Session Manager Setup window appears.
      2. Select a Session Manager connection you want to disable CDR FTP; then click and select the

      VKM Options menu.

      1. Right-click on the smCdrEnable parameter and make sure value is set to false. The status is now disabled.

      Disable a Session Manager

      You can use this procedure to disable a Session Manager that you do not want to remove from the Nectar UCMP.

      Follow these steps to disable an existing Session Manager:

      1. Navigate to Modules > Avaya > Session Manager.

      The Avaya Session Manager - Connections window appears.

      1. Select a Session Manager connection you want to disable; then right-click and select
      Disable.

      Remove a Session Manager

      Follow these steps to remove a Session Manager from the Nectar UCMP:

      1. Navigate to Modules > Avaya > Session Manager.

      The Avaya Session Manager - Connections window appears.

      1. Select a Session Manager connection you want to remove; then right-click and select
      Remove.
      Was this article helpful?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.
      Logout
      ESC

      Eddy AI, facilitating knowledge discovery through conversational intelligence