Avaya System Manager r7.1 and above Deployment Guide

Introduction

This guide provides the instructions to configure monitoring and management of Avaya System/ Session Manager using Nectar’s System/Session Manager Module.

About this Guide

The guide explains how to:

• Configure Avaya System Manager v7.1
• Configure Avaya System Manager v8.0
• Configure Avaya System/Session Manager VKM
• Monitor the System 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 UCF module.

Supported Software Versions

• Nectar v7.4 and above
• Avaya Aura System Manager r7.1 and above.

Prerequisites

For System Manager:

• IP address
• API role and credentials
• SNMP administration
• When using Avaya System Manager 7.1.3, Java 1.8 must be loaded on your PC for the client to on-board this VKM. If not, the client will load correctly, but it will freeze System Manager VKM execution. The client will then need to be restarted.

Configure Avaya System Manager v7.1

Configuring the Avaya System Manager includes the following tasks:

• Confirm Software Version
• Create a Role for Nectar Access
• Add New Administrator for Nectar Access

Confirm Software Version

To confirm you are using r7.1 or newer on the Avaya System Manager web interface, proceed with the following steps:

1. After logging in, click on the tool wrench icon in the top-right corner of the screen; then select About from the drop-down menu.

Figure 2-1 Tools - About

 The About System Manager window appears and provides the version of software you are using.

Figure 2-2 About System Manager

Create a Role for Nectar Access

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

1. Log in to the Avaya System Manager web interface.
2. Navigate to the Users pane and select Groups & Roles.

Figure 2-3 Avaya System Manager

The Roles window appears (Figure 2-4 Roles).

3. Select Roles from the drop-down menu.
4. First, select System Manager, then click the New button.

Figure 2-4 Roles

The Add New Role window appears (Figure 2-5).

5. Enter the following credentials.

• Role Name - REST API Calls (name as desired)
• Role Description - Nectar Read Only (description as desired)

6. Click Commit and Continue.

Figure 2-5 Add New Role

The Roles Details (REST API Calls) window appears (Figure 2-6).

7. Under Element/Service Permissions, click Add Mapping.

Figure 2-6 Role Details

The Select and/or Network Service to Map to Role (REST API Calls) window appears (Figure 2-7).

8. Select the following:

• Group Name = default (---No Group Selected---)
• Element or Resource Type = SMGR Core Services
• Element or Resource Instance = All

9. Click Next.

Figure 2-7 Element Type

The Permission Mapping (All Elements of type: SMGR Core Services for ‘REST API Calls’) window appears (Figure 2-8).

10. Click the drop-down arrow for SMGR Configuration.
11. Select the following:

• View

Figure 2-8 Permission Mapping

12. Scroll down, for Geography Redundancy select:

• View Health Monitor Profile Configuration
• View Geographic Redundancy Configuration

13. Scroll down, for Serviceability Agent select:

• Serviceability Agents

14. Click Commit.
The Roles Details for REST API Calls window appears, again. Now permission mapping needs to be added for the Session Manager.

15. Click the Add Mapping button.
16. For Select and/or Network Service to Map to Role (REST API Calls) select:

• Group Name = default (---No Group Selected---)
• Element or Resource Type = Session Manager and Routing
• Element or Resource Instance = All

17. Click Next.
18. For Permission Mapping (All Elements of type: SMGR Core Services for ‘REST API Calls’) select:

• The checkbox for Select/Unselected All.

19. Click Commit.

The Roles Details (REST API Calls) window appears (Figure 2-9). Here you can see the permissions that were added.

20. Click Commit.

Figure 2-9 Role Details Confirmation

Add New Administrator for Nectar Access

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

1. Click on the Home tab in the Avaya System Manager web interface.
2. In the Users pane select Administrators. 

Figure 2-10 Avaya Administrators

The Administrative Users window appears (Figure 2-11).

3. Select the Add button. 

Figure 2-11 Administrative Users

The Add New Administrative User window appears (Figure 2-12). 

4. Enter the following credentials:

• User ID = Nectar
• Authentication Type = Local
• Full Name = Administrator’s Full Name
• Email = Administrator’s Email
• Temporary password = Nectar (password as desired)
• Re-enter password = Nectar

5. Click Commit and Continue.

Figure 2-12 New Administrative User

In following window, it is asking for you to Assign a Role. 

6. Scroll down and select the Role you created in Step 5 of Section Create a Role for Nectar Access.
7. Click Commit.
8. Log out of the Avaya System Manager web interface - the Log off link is in the top right corner of the window.
9. Log back in to the Avaya System Manager web interface using the User ID and Temporary password.

The Login Denied window appears (Figure 2-13).

10. Click on Change Password.

Figure 2-13 Change Password

11. In the Password Change window enter the User ID, the new Password credentials and click Save.
12. Log back in to the Avaya System Manager web interface to confirm all the permissions are there.
13. In the Elements pane find and select Routing. The Routing window appears (Figure 2-14).
14. Check if permissions appear (i.e., Locations, SIP Entities, etc.). 

Figure 2-14 Permissions Confirmation

If everything is there, setup is complete.

Configure Avaya System Manager v8.0

Configuring the Avaya System Manager includes the following tasks:

• Confirm Software Version
• Add New Administrator for Nectar Access

Confirm Software Version

To confirm you are using r8.0 or newer on the Avaya System Manager web interface, proceed with the following steps:

1. After logging in, hover over the Menu icon in the top-right corner of the screen; then select
About from the drop-down menu.

Figure 3-1 Menu - About

The About System Manager window appears and provides the version of software you are using.

Add New Administrator for Nectar Access

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

1. After logging in, select Users then select Administrators > Administrative Users.

Figure 3-2 Avaya Administrators

The Administrative Users window appears (Figure 3-3). 

2. Select the Add button.

Figure 3-3 Administrative Users

The Add New Administrative User window appears ( Figure 3-4).

3. Enter the following credentials:

• User ID = Your discretion
• Authentication Type = Local
• Full Name = Your choice
• Email = Suggest administrator’s email
• Temporary password = Your discretion or select Generate Password
• Re-enter password = Your discretion or select Generate Password

4. Click Commit and Continue.

Figure 3-4 New Administrative User

In following window, it is asking for you to Assign a Role.

5. Scroll down and select the checkbox next to Session Manager and Routing Administrator.

6. Click Commit.
7. Log out of the Avaya System Manager; hover over the Menu icon then select Log Out.
8. Log back in to the Avaya System Manager web interface using the new User ID and Temporary password.

The Login error window appears (Figure 3-5).

9. Click on Change Password.

Figure 3-5 Change Password

10. In the Password Change window enter the User ID, the new Password credentials and click Save.
11. Log back in to the Avaya System Manager web interface to confirm all the permissions are there.
12. From the Elements drop-down list, select Routing. The Routing tab appears (Figure 3-6).
13. If permissions appear (i.e., Locations, SIP Entities, etc.), setup is complete. 

Figure 3-6 Permissions Confirmation

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
• Confirm System Manager Connections

Enable System/Session Manager VKM

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

1. Navigate to RIG > Module Configuration.

Figure 4-1 RIG > Module Configuration

The Module Configuration window appears.

2. Select Avaya System/Session Manager; then click Apply.

Figure 4-2 Module Configuration

3. To restart the RIG and apply the changes:

a. Navigate to RIG > Admin > Restart.

Figure 4-3 Restart RIG

b. When the following message appears, click Yes.

Figure 4-4 Restart

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 4-5 Modules > Avaya > System Manager

The Avaya System Manager Setup - Connections window pane appears (Figure 4-6).

2. Right-click in a blank space of Connections pane and select Add.

4. Click Add.

Figure 4-8 Connections

Confirm System Manager Connections

To confirm the Avaya System Manager was setup properly, proceed with the following steps:

1. Select and right-click on the new System Manager Connection.
2. Select View Collections from the drop-down menu.

Figure 4-9 Select View Collections

The Collections window appears (Figure 4-10). Here you can verify that all Collections ran successfully.

NOTE

SNMP for the session managers is derived from the SNMP that is added from the system level that is shown above. 

Figure 4-10 Successful Permissions

If the status for all Collections are successful, setup is complete.

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 4-11 VKM Options - CDR Enable

 2. Select a Session Manager connection you want to enable CDR FTP; then click the VKM Options menu.
3. 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.
3. Right-click on the smCdrEnable parameter and make sure value is set to false. The status is now disabled.

Monitor the System Manager

This section explains the following tasks:

• Inventory
• Infrastructure Confirmation
• Edit Parameters of Existing System Manager
• Remove a System Manager

Inventory

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 view SIP Entities, Entity Links, Location, Session Manager Status, Session Manager Interfaces and Registrations for an existing System Manager.

1. Navigate to Reports > Inventory > Avaya > System Manager (r7.1 or above).

Figure 5-1 - Inventory

The Session Manager Inventory window appears (Figure 5-2).

2. Click SIP Entity. 

Figure 5-2 - Session Manager Inventory

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

Figure 5-3 - SIP Entity

Infrastructure Confirmation

To make sure the Session Manager was built correctly, proceed with the following:

1. Navigate to Health > Elements > Folders > Session Managers. The Elements window appears (Figure 5-4).

You can click on Entity Links or any others to drill-down for more details.

Figure 5-4 - Elements

Edit Parameters of 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 Setup - Configurations (tab) - Connections window pane appears (Figure 5-5).

2. Select a connection, then right-click and select Edit.

Figure 5-5 Avaya System Manager

The Edit System Manager dialog box appears (Figure 5-6).

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

Figure 5-6 - Edit System 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 - Connections window appears.

2. Select a connection you want to remove, then right-click and select Remove.

The connection is removed. 

Conclusion

You are now successfully monitoring the System Manager with Nectar.