- 03 Aug 2023
- 10 Minutes to read
- Print
- DarkLight
- PDF
Avaya IP Office r10.0 and prior Deployment Guide
- Updated on 03 Aug 2023
- 10 Minutes to read
- Print
- DarkLight
- PDF
Overview
This guide provides instructions to configure the monitoring and management of Avaya IP Office using Nectar’s IP Office Module.
Audience
This guide is intended for system administrators or engineers who have system administration access and technical knowledge of Avaya IP Office and a familiarity with deploying Nectar’s software.
Supported Software Versions
- Avaya IP Office r5-10.0
Requirements
The Avaya IP Office (IPO) VKM can run co-resident on the Windows VM Pro Server or standalone on a separate RIG. You must have a minimum of 100MB of disk space, and 4GB of RAM available. You will need administrative and SNMP access to the VM Pro Server or separate RIG.
RIG Preparation
The Nectar module for IP Office connects to Avaya IP Office through System Status. Avaya IP Office will accept up to two simultaneous connections to System Status. However, they cannot be from the same IP address.
A client will commonly run System Status on the VM Pro Server, which is normally where Nectar software resides. If the client runs the System Status application, it will disconnect the Nectar RIG and interrupt monitoring since both sessions originate from the same IP address.
To avoid this conflict and allow Nectar software monitoring to continue, even if the client initiates a System Status session from the VM Pro Server, assign a secondary static address to the VM Pro Server as discussed below.
Secondary IP Address for RIG
We will assign a secondary, static IP address to the VM Pro Server. Going forward, this is what the client will use to launch a System Status session.
In this example, the VM Pro Server is running on 10.65.22.5. We will assign 10.65.22.9 as a secondary IP address. These steps are based on a Windows 7 PC running VM Pro.
- Open the Windows Control Panel:
- On Windows 7, click the Start icon and select Control Panel.
- On Windows 10, right-click on the Start icon and select Control Panel.
- Click View network status and tasks.
- Click Local Area Network.
- In the Local Area Connection Status window, click the Properties button.
- In the Local Area Connection Properties window, select Internet Protocol Version 4 (TCP/IPv4). Then, click the Properties button.
- In the Internet Protocol Version 4 (TCP/IPv4) Properties window, click Advanced button.
- In the Advanced TCP/IP Settings window, click Add.
- In the TCP/IP Address dialog window, enter the secondary IP address and Subnet mask. Then, click Add.
The Network Interface Controller (NIC) now has two IP addresses. - Click OK (three times), then click Close (two times) to close previous configuration windows. A restart is not required.
IPO Configuration
the IPO by doing the following:
- Specify the SNMP Community String
- Specify the SNMP Trap Destination
- Specify Firewall Settings
- Set Up RTCP Collector
- Restart the IPO
Specify the SNMP Community String
- Connect to the IPO using Avaya’s IP Office Manager application.
- Select System in the left-hand pane.
- Select the System Events tab.
- On the Configuration tab:
- Confirm that the SNMP Enabled box is checked.
- Enter the Community string, and confirm the SNMP Port is 161.
- Click OK when done.
Specify the SNMP Trap Destination
- In System Events tab, select the Alarms tab.
- Click Add.
- Select the Trap radio-button.
- Enter the Server Address, which is the IP address of the Nectar RIG.
- Confirm that the Port defaults to 162.
- Enter the SNMP Community. In this example, we use NectarCMPr.
- Under Events, select all check boxes. (The list extends off the screen.)
- Click OK when done.
Specify Firewall Settings
- Select Firewall Profile in the left-hand panel.
- In the SNMP field, select Bothway from the drop-down menu.
- Click OK when complete.
Set Up RTCP Collector
Follow these steps to set up the RTCP Collector if you are deploying Nectar Real-Time Quality Monitoring.
- Navigate to the LAN1 tab.
- In the sub menu, select VoIP.
- Enter the RIG address in the RTCP collector IP address for phones field.
The RIG IP address must be entered in Step 3 prior to being able to complete Step 4. - Within the RTP panel, Enable RTCP Monitoring on Port 5005 is selected by default and directs RTCP feedback to the IP Office. Click the check box to deselect this selection.
Restart the IPO
Save the configuration and restart the IPO for these changes to take effect.
VM Pro Configuration
If you will be monitoring the VM Pro Server, Nectar needs SNMP read only access to the device. Follow these steps to configure the VM Pro server for SNMP:
- Click Start icon; then enter services.msc. in the Search programs and files text window.
- Right-click on SNMP Service and select Properties.
- Select the Security tab.
- Click Add.
- Select Read Only from the Community Rights drop-down list.
- Enter the Community Name.
- Click Add.
- Click OK to close the Properties window.
- Restart the SNMP service.
Nectar Configuration
Before configuring Nectar software, the Nectar software must be loaded and the Nectar software license must be applied.
Configure the Nectar software doing the following:
- IP Address Binding
- Nectar IP Office Module Execution
- Configure Real-Time Quality Monitoring
- Phone Alarms
- Report Pack
- Report Agent Selection
- Report Schedule
IP Address Binding
If Nectar is co-resident on the VM Pro Server and you have completed the instructions in section Secondary IP Address for RIG, now bind the Nectar software to this secondary address. We recommend doing this through a Remote Desktop Connection (RDC) session to the RIG.
We will do this to both the primary and backup Nectar services.
- Stop these Nectar services through Windows services using the following steps:
- Nectar RIG Server
- Nectar RIG Backup
- To edit the server.properties file; follow the steps below:
- Enter C:\Apps\nectar\etc into the Windows Explorer address bar.
- Find and double-click on server.properties file.
- In the server - Notepad window, add the following line: bindAddress = 10.65.22.9.NOTEThis is an example IP address. Please substitute it with your IP address. For consistency and troubleshooting, create this new entry immediately following the satelliteType = RIG line, which is near the top of the file.
- Save the file.
- Navigate to C:\Apps\nectar\backup\etc to edit the server.properties file.
- Add the following line:
bindAddress = 10.65.22.9.NOTEThis is an example IP address. Please substitute it with your IP address. For consistency and troubleshooting, create this new entry immediately following the satelliteType = RIG line, which is near the top of the file.
- Save the file.
- Restart both RIG services through Windows Services:
- Nectar RIG Server
- Nectar RIG Backup
Nectar IP Office Module Execution
Follow these steps to execute the IP Office module:
- Navigate to Modules > Avaya > IP Office (prior to r10.1).
- In the Avaya IP Office (prior to r10.1) Setup panel, locate and select Add.
The Add IP Office Connection dialog box appears (Figure Add IP Office Connection). - In the General tab, Input the required information:
- Name: enter the name of the IPO system.
- Description: enter a description for the IPO system.
- Address: enter the IP address of the IP Office.
- Secure Service: select the check box.
- Username and Password: enter the username and password to login to System Status.
- In the Community tab, first select the SNMP Version that you are using then enter SNMP credentials (for V3, you will have to enter additional authentication values).
- Enter the Community string.
- If you want to monitor the VM Pro server, in the Voicemail Pro tab, enter the following information:
- Select the Enable Monitoring check box.
- In the Address field, enter the VM Pro server IP address.
- Select the SNMP Version you are using (for V3, you will have to enter additional authentication values).
- Enter the Community string.
- Click OK.
- The system will now appear within the IP Office window.
- The Status column should indicate online. This means that Nectar is successfully communicating with the IPO.
- If the status reads Result: Invalid user or password, try reconfirming your password.
Configure Real-Time Quality Monitoring
Follow these steps to configure Real-Time Quality Monitoring, if deploying.
- Navigate to Configure > Quality Management > Real Time QoS.
In the Configure Real Time QoS dialog window (Figure 19) make the following selections: - RTCP Receiver: set to Enabled
- Traces: set to Enabled.
- Receiver Interface: select or enter the RIG IP address.
- Receiver Port: remains 5005.
- Default Codec: occasionally the codec cannot be determined within the RTCP feed. In that case, Nectar will default to this codec when calculating MOS. Please select the primary codec that your platform uses.
- Hop Name Lookup: set to Enabled. This will use DNS to show layer-3 device names in trace routes, in addition to their IP addresses.
- Threshold Normalization: this is optional (It is a step function for alert level. One packet with bad metrics will not trigger a critical alert level. It will require several packets in sequence and the alert level will gradually increase).
- Use PQOS RTCP Address: leave as is—default.
- Configure Categories: do not change—it is specific to Avaya’s Communications Manager.
- Click Apply to start the RTCP Receiver.
Phone Alarms
You can monitor the status of individual stations. The Stations Traffic Light on the Dashboard, and the underlying Dependency Tree will represent these stations. By default, no stations will be included in Alarming.
Follow these steps to set up Phone Alarms:
- Navigate to Modules > Avaya > IP Office (prior to r10.1).
- In the Avaya IP Office (prior to r10.1) Setup window, select the desired system to highlight it; then select Phone Alarms.
The IP Office Phone Alarms window will display all the extensions in the system. - Select the check boxes next to the station(s) that you want to monitor.
- Click Update in the lower right-hand corner.
Report Pack
The following reports are included in the IPO Report Pack, which are available on the Nectar Partner Hive:
IPO Resource Utilization (Monthly):
- Trunks
- Conference Bridge Channels
- VM Channels
- VCM Channels
- Data Channels
- Modem Channels
IPO VMPro Report (Monthly):
- CPU
- RAM
- Disk
- Etc.
Phone QoS Report-Expanded Summary (Weekly):
- Call Quality Metrics
Follow these steps to load an IPO Report Pack:
- Download the IPO Report Pack from the Nectar Partner Hive.
- Navigate to Reports > Report Manager.
- To upload the IPO Report Pack, right-click in the Reports pane and select Report Packs > Load Report Pack.
The Open dialog window appears. - Locate and select the report pack from the location where it was saved (i.e., Documents folder, Desktop, etc.).
- Click Open.
The reports should appear in the Report Manager > Reports panel.
Report Agent Selection
Follow these steps to associate each of the reports with their respective Nectar Agent.
- Navigate to Reports > Report Manager.
- Find and double-click the IPO Resource Utilization Report (Monthly) report to launch the Edit Report dialog window.
The report name will display in the Report Name field.
. - Select the Components tab.
- Select Rcp#-1 Group all Functions in Agent.
- Select the corresponding agent from the Agent drop-down list.
In the example below (Figure Report Agent Selection), we selected agent Nectar IPO Trunks. - Click Save.
Follow the preceding steps to set the agent for the IPO VMPro Report (Monthly).
No changes need to be made to the IPO Phone QoS-Expanded Summary (Weekly) report.
Report Schedule
Reports will not automatically execute, unless you assign a schedule to them: Follow these steps to assign a report schedule:
- Navigate to Reports > Report Manager.
- Select the Schedules tab.
- Select a report to highlight it, then select Edit from the menu.
- In the Edit Report Schedule dialog box, confirm or select Monthly as the interval for the Repeat parameter.
- Click OK.
The Frequency status appears set to monthly.
Enable Report Schedule
To enable a report schedule(s):
1. Select a schedule to highlight it, then right-click and select Enable.
The report schedule should now read Enabled in the Status column.
Add Report to Schedule
To add a report to the list of schedules, proceed with the following steps:
- Within the Schedules tab, right-click in a blank area of the screen, then select Add... from the pop-up menu.
- In the Add Report Schedule dialog box (Figure 32), click the drop-down arrow next to Report.
- Select the report you want to add (e.g., IPO Resource Utilization).
- Click OK.
The report should appear in the list of schedules.
Verification
Your system is now being monitored by Nectar. This section contains examples of what you should see.
Follow these steps to verify your system is working properly:
Dashboard
The following Dashboard is automatically created for you.
- Navigate to Dashboards > Dashboard (click IP Office tab in Dashboard panel if applicable).
You will see statistics for:
System Channels
- Data Channel
- VCM Channel
- VM Channel
- Modem Channel
- Conference Channel
- Trunk Channels for each Trunk Group
- VM Pro Server Metrics
- VM Pro Service Active Traffic Light
- Disk Usage
- Total CPU Usage
- VM Process CPU Usage
- VM Process Memory Usage
You will see Traffic Lights for the following items. Double-click to see the corresponding Dependency Trees.
- Connectivity: Reflects Nectar connectivity to the IPO
- Trunks: Digital Trunk Alarms
- System: System Hardware Traps
- License: License Traps
- Voice Mail: The VM Pro metrics and service(s)
- Stations: Individual station alerts
Inventory
Follow these steps to view inventory information:
- Navigate to Reports > Inventory > Avaya > IP Office (prior to r10.1).
- In the IP Office (prior to 10.1) Inventory panel, select the system components you want to see.
- Inventory - Full hardware inventory
- Extension Information
- Trunk Summary Information
- System Channels
- Conference Bridge Channels
- Data Channels
- Modem Channels
- Voice Compression Module (VCM) Channels
- Voice Mail (VM) Channels
- Licenses
Real-Time Quality Monitoring
Navigate to Health > Quality Management > Real Time QoS.
The Real Time QoS panel will appear showing all active calls.
Conclusion
Your IP Office system is now being monitored by Nectar.