This section makes frequent use of data contained in the Technical Requirements.

All relevant sections of the Technical Requirements Data collection should be completed or known before commencing with the steps in this section.

There are two parts to the configuration, the first being the server(s) under management, and the second being the supporting configuration on the web portal.

Both are covered in this chapter.

IP Office Configuration

SNMP Trap and Syslog Setup

Select the ‘System Events’ tab and then the ‘Configuration’ sub-tab, Check the ‘SNMP Enabled’ box and enter the preferred community name and the ‘SNMP Port’ 161. Click OK.

Note: 'Public' is used as an example and is not recommended for production systems



SNMP Agent Field Descriptions

Fields

Setting

SNMP Enabled

Checked

Community Name

Preferred Community name

SNMP Port

161


Select the ‘Alarms’ tab and click on the ‘Add’ button.

Click the radio button for ‘Trap’, Enter the IP address of the VSM Probe into the ‘Server Address’ field, 162 in the ‘Port’ field, your preferred community name in the ‘Community’ field, select IP Office from the ‘Format’ drop down, and select warnings from the ‘Minimum Severity Level’ dropdown.

In the Events box, select all alarm types or only those you are interested in then click ‘OK’.

Note: 'Public' is used as an example and is not recommended for production systems



SNMP Trap Field descriptions

Fields

Setting

Server Address

IP address of the VSM Probe

Port

162

Community

Preferred community name

Format

IP Office

Minimum Severity Level

Warnings


Click ‘Add’ again and this time click on the Radio button for ‘Syslog’. Enter the IP address of the VSM Probe into the ‘IP Address’ field, 514 in the ‘Port’ field, Select UDP from the ‘Protocol’ dropdown and Enterprise from the ‘Format’ dropdown. In the Events box, select all alarm types then click ‘OK’.


Click ‘OK’ to the ‘System Events’ tab.


Syslog Field Descriptions

Fields

Setting

IP Address

IP address of the VSM Probe

Port

514

Protocol

UDP

Format

Enterprise

Configure CDR

Select the ‘SMDR’ Tab, Set the ‘Output’ dropdown to SMDR Only. Enter the IP address of the VSM Probe into the ‘IP Address’ field, entry 9000 in the ‘TCP Port’ field, set ‘Records to Buffer’ field to 500, check the ‘Call Splitting for Diverts’ box. Then click ‘OK’.


CDR Field Descriptions

Fields

Setting

Output

SMDR Only

IP Address

IP Address of VSM Probe

TCP Port

9000

Records to Buffer

500

Call Splitting or Diverts

Checked

Configure RTCP for VQM

This feature is only available on IP Office 9.1 and above.

The following changes are required to define the VSM Probe as the destination for RTCP traffic from the UC environment.

Select the ‘LAN1’ tab, then the ‘VoIP’ sub tab. Uncheck the 'Enable RTCP Monitoring on port 5005' box and then enter the IP address of the VSM Probe into the ‘RTCP Collector IP Address for Phones’ field. 


Lan1: Voip - RTCP Field descriptions

Field

Setting

RTCP Collector IP Address IP Address for Phones

IP Address of the VSM Probe

Enable RTCP Monitoring on Port 5005

Unchecked

Select the 'Telephony' tab, at the bottom left of this tab complete the 'RTCP Collector Configuration' details.

Telephony - RTCP Collector Configuration

Field

Setting

Send RTCP to an RTCP Collector

Checked

Server AddressIP Address of the VSM Probe
UDP Port number5005 (or the specific port administered for your VSM RTCP Collector)

RTCP Reporting Interval (secs)

5

Configure Service User account for Web Services API

VSM utilises the Web Services API on the IP Office to gather information for reporting and Dashboards. The following user needs to be created so that VSM can access the Web Services API on the IP Office. Follow the steps below to administer this user account:

Login to your IP Office as an administrator


From the Top menu in the IP Office manager select – File> Advanced> Security Settings


Service Security Settings

In Security Settings expand ‘Services’ and select ‘Web Services’.

Set the Service Security Level to ‘Secure, Medium’ if it is not already.


Web Service Security Field Descriptions

Field

Setting

Service Security Level

Secure, Medium

Rights Group Settings

In Security Settings expand the ‘Rights Groups’ branch and check to see if there is already a Rights Group called ‘Web Services’ if there is not you will need to create this using the steps below:

In the Security Settings Menu right-click on ‘Rights Groups’ and select ‘New’


Set the Group Name to ‘Web Services’ and click OK.



Select the new Web Services Rights Group from the list, then in the right hand pane select the ‘Web Services’ tab.


In this Tab in the IP Office Service Rights pane check the boxes for Config Read All and Service Monitor Read. In the Web Manager Rights pane check all boxes.

Then click OK at the bottom right-hand corner.


Rights Group Field Descriptions

Field

Setting

IP Office Service Rights

Check – Config Read All, Service Monitor Read.

Web Manager Rights

Check All.


Create Service User

From the Security Settings Tree select ‘Service Users’ then right-click in the ‘Service Users’ pane and select ‘New’

On some versions of IP Office, you right-click on ‘Service Users tree’ to select ‘New’.


Enter a new username and password. Click OK.


In the ‘Service Users’ pane select the user account you just created.

From the Rights Group Membership section check the ‘WebServices’ group and then click the OK button at the bottom right-hand corner.



Service User Rights Group Field Descriptions

Field

Settings

Right Group Membership

Check - WebServices


This user account is now administered in the IP Office.

If you do not see data from the Webservice user, then it would pay to check the following setting is unchecked.


Web Portal Configuration

Add IP Office

Login to the VSM web portal using your credentials and password. For the particular customer, select Service Desk > Equipment Locations.

Right-click on the Equipment Location (Appliance) that will serve this particular IP Office and select ‘Manage Equipment’:

At the bottom of the ‘Manage Equipment’ page click on the ‘Add Equipment’ Button

A form will open which you can populate with the equipment details as per table 9. 

Select the Vendor ‘Avaya’ and Product ‘IP Office’.


If you are adding more than one piece of the same equipment type check the ‘Add another’ box at the bottom of the form and the bulk of the configuration will be carried over for the next item.


Web Portal – Add IP Office Field Description

Field

Setting

Vendor

Avaya

Product

IP Office

Equipment Name

Friendly name for this IP Office

Username

Username of the Web Services User created in section 2.1.4.3

Password

Password of the Web Services User created in section 2.1.4.3

IP Address/Host Name

IP address or Hostname of the IP Office

Site

Friendly name for core site (where this server is located)

Associated RTCP Receiver

Select Associated RTCP Receiver from drop-down



SNMP

Complete the Equipment tab and then click on the ‘SNMP Query’ tab.

Click on the down arrow, and select the SNMP version you wish VSM to use for querying IP Office:


SNMP V1 or V2

 

IP Office SNMP Field Description

Field

Setting

Version

V1, V2

SNMP Community String

Community string administered in section 2.1.1


SNMP V3

 

IP Office SNMP V3 Field Description

Field

Setting

Version

V3

Username

SNMP V3 Username

Authentication Protocol

SHA (recommended)

Authentication Password

Password

Privacy Protocol

DES (recommended)

Privacy Password

Password


Network Connectivity


Network connectivity settings are configured at the location level and apply to all equipment by default. See here for more information.

The default location-level network connectivity settings (which are detailed in the link above) may be overridden for specific equipment using this tab.

SettingDescription
Disable Network Connectivity Ping for EquipmentSelect 'No' (this is the default) to send out ping tests. Select 'Yes' to disable ping tests from being sent out.
Ping Frequency (minutes)Defines the amount of time (in minutes) between each ping test.
Raise an alarm when maximum ping exceeds (x) msCheck this box and define a time (in milliseconds) to raise an alarm when the ping response time exceeds your set maximum time limit.
Raise an alarm when the average ping exceeds (x) msCheck this box and define a time (in milliseconds) to raise an alarm when the ping response time exceeds your set average time limit.
Raise an alarm when packet loss exceeds (x) %Check this box and define a percentage to raise an alarm when the packet loss of pings sent exceeds your set limit.

You can define alarm raising conditions using all, none or a mixture of the above “Raise an alarm when” settings


Tagging

From the add equipment pop up you can create new tags, apply existing ones, or disassociate existing tags for a specific piece of equipment.

Essentially, this tab implements the functionality on the Manage Tags page but localizes any configuration to the equipment being configured.

See here for more information.

Test Access

Once all fields are populated Click on the Test Access button. This will test that VSM can connect to IP Office using the settings you have entered:


Both SSH and SNMP should return success. If not, troubleshoot the configuration.

The SSH test ensures the VSM collector can connect to, and login using the Service User account configured.
The SNMP test ensures an SNMP query can be run.

Once testing is successful, click Save.



  • No labels