Introduction
It is essential that certain prerequisites are met before you use this document to configure IP Office. Refer to the Implementation Guide for the correct process flow.
By following the flow chart you will have all the information required, and the work will be completed in the correct order so that work won’t have to be repeated and tests run at the time will be relevant.
Prerequisite
This document makes frequent use of data contained in the Technical Requirements document.
All relevant sections of the Technical Requirements document must be completed before commencing with the steps in this document.
1.0 Avaya IP Office
1.1. IP Office Configuration
1.1.1. SNMP Trap and Syslog Setup
Select the ‘System Events’ tab and then the ‘Configuration’ sub tab, Check the ‘SNMP Enabled’ box and enter the community name ‘public’ and the ‘SNMP Port’ 161. Click OK.
Figure 1 – IP Office Enable SNMP
Fields | Setting |
SNMP Enabled | Checked |
Community Name | Public |
SNMP Port | 161 |
Table 1 – SNMP Agent Field Descriptions
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, public 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’.
Figure 2 – IP Office SNMP Traps
Fields | Setting |
Server Address | IP address of the VSM Probe |
Port | 162 |
Community | Public |
Format | IP Office |
Minimum Severity Level | Warnings |
Table 2 – SNMP Trap Field descriptions
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’.
Figure 3 – IP Office Syslog
Click ‘OK’ to the ‘System Events’ tab.
Fields | Setting |
IP Address | IP address of the VSM Probe |
Port | 514 |
Protocol | UDP |
Format | Enterprise |
Table 3 – Syslog Field Descriptions
1.1.2. 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’.
Figure 4 – IP Office SMDR (CDR)
Fields | Setting |
Output | SMDR Only |
IP Address | IP Address of VSM Probe |
TCP Port | 9000 |
Records to Buffer | 500 |
Call Splitting or Diverts | Checked |
Table 4 – CDR Field Descriptions
1.1.3. 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. Enter the IP address of the VSM Probe into the ‘RTCP Collector IP Address for Phones’ field. Click ‘OK’.
Figure 5 – IP Office RTCP output
Field | Setting |
RTCP Collector IP Address IP Address for Phones | IP Address of the VSM Probe |
Enable RTCP Monitoring on Port 5005 | Unchecked |
Table 5 – RTCP Field descriptions
ADD TELEPHONY TAB
1.1.4. 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
Figure 6 – IP Office Log on
From the Top menu in the IP Office manager select – File> Advanced> Security Settings
Figure 7 – IP Office Security Settings
1.1.4.1. 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.
Figure 8 – IP Office Service Security Level
Table 6 – Web Service Security Field Descriptions
Field | Setting |
Service Security Level | Secure, Medium |
1.1.4.2. 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’
Figure 9 – IP Office New rights group
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.
Figure 10 – IP Office Web Services Rights Group
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.
Table 7 – Rights Group Field Descriptions
Field | Setting |
IP Office Service Rights | Check – Config Read All, Service Monitor Read. |
Web Manager Rights | Check All. |
1.1.4.3. 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’.
Figure 11 – IP Office New Service User
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.
Figure 12 – IP Office Service User Rights Group Membership
Table 8 – Service User Rights Group Field Descriptions
Field | Settings |
Right Group Membership | Check - WebServices |
This user account is now administered in the IP Office.
1.2. Web Portal Configuration
1.2.1. 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’.
Figure 13 – Web Portal – Add Equipment
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.
Table 9 – 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 |
Figure 14 – Web Portal – IP Office Configure Equipment
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
Figure 15 - Web Portal – IP Office SNMP V1/V2 Query
Table 10 – IP Office SNMP Field Description
Field | Setting |
Version | V1, V2 |
SNMP Community String | Community string administered in section 2.1.1 |
SNMP V3
Figure 16 - Web Portal – IP Office SNMP V3 Query
Table 11 – 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 |
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:
Figure 17 – Web Portal – IP Office Test Access
Both SSH and SNMP should return success. If not, trouble-shoot the configuration.
- The SSH test ensures the VSM probe 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.