...
To allow VSM to monitor the voice quality of SIP endpoint calls and gather phone configuration data via SNMP, configure Session Manager to send RTCP reporting to the IP address of the VSM probe.
From the main 'System Manager' dashboard, navigate to Elements > Session Manager. Navigate to Device and Location Configuration > Device Settings Groups:
...
Scroll down to the CDR section and configure as per the table below.
SM CDR Field Description Anchor CDRSection CDRSection
Field | Setting |
|---|---|
Enable CDR | Checked |
Password | SFTP Password (refer to technical requirements forms) |
Data File Format | Standard Flat File |
Include User to User Calls | Unchecked |
Include Incomplete Calls | Unchecked |
...
SM Logging Field Description Anchor Logging Logging
| Field | Setting |
|---|---|
Transport | UDP |
IP Address or FQDN | IP Address of VSM Probe |
Port | 514 |
...
SM SIP Tracer Field Description Anchor SIPTracer6-7 SIPTracer6-7
Field | Setting |
|---|---|
Remote Server FQDN or IP Address | IP Address of VSM Probe |
Send Trace Method | Syslog |
...
| Info |
|---|
‘Max Dropped Message Count’ cannot be zero. Increase this to 1 at a minimum. |
Web Portal Configuration
Add SM
...
Field
...
Setting
...
Equipment Name
...
Friendly name for this SM
...
Username
...
The administrative username you added to SM earlier
...
Password
...
The administrative password you added to SM earlier
...
Use SSH
...
Tick to use SSH, untick to use Telnet
...
IP Address / Host Name
...
IP Address of server
...
Default Site
...
Friendly name for core site (where this server is located)
...
Command Set
...
Avaya Session Manager
Session Manager Version8.x and Later
Select the Session Manager you wish to configure from the 'Session Manager Instances' list then click the 'View' button at the top of the page.
Configure as per the table below then click the ‘Commit’ button at the top of the page. Repeat this for any other Session Managers you wish to administer for SIP Trace output.
SM SIP Tracer
- Select the version of SNMP you selected earlier, complete the form, then click on the Configure Equipment tab.
- Configuring SFTP is optional – it is only required if you are collecting CDR from Session Manager. Otherwise, click on the Configure Equipment tab.
Web Portal – SM SFTP Client
Web Portal – SM SFTP Field Description
| Field | Setting |
|---|
Enable Collection of CDR Files
Selected
File Type
Flat
SFTP User Name
The SFTP username you added to SM earlier
SFTP Password
The SFTP password you added to SM earlier
Remote Server FQDN or IP Address | IP Address of VSM Probe |
Send Trace Method | Syslog |
| Info |
|---|
‘Max Dropped Message Count’ cannot be zero. Increase this to 1 at a minimum. |
Web Portal Configuration
Add SM
Log in to the VSM web portal using your credentials and password.
Complete the Configure SFTP Client tab form, and click on Configure Equipment.
Once testing is successful, click Save.
Browse to System Manager and login. Navigate to Services > Inventory from the dashboard. Navigate to Manage Serviceability Agents > Serviceability Agents:
SM Generate Test Alarm
Generate a Test Alarm by selecting the SM Agent, and clicking on the 'Generate Test Alarm' button.
Return to the VSM home page. For the particular customer, select Availability Manager > Manage Alarms:
Web Portal – SM Test Alarm
The test should show as an alarm. If not, trouble-shoot the configuration.
- This test has SM generate an SNMP trap and ensures VSM receives the same.
...
Avaya Session Border Controller (SBC) Configuration
ASBC Configuration
Adding a new SBC Login
Create an Administrator account. The VSM Probe requires access with Administrative rights. Add an account that when used provides access to the Linux bash prompt.
- Start an SSH session. At the command prompt type su root. When prompted enter the 'root' user password.
- Use the command useradd NAME; where NAME is the account name to create and hit enter.
- Use the command passwd NAME; where NAME is the account name created above and hit enter. Enter the password then hit enter (need to do this twice).
- Enter the command chage –M 99999 NAME; where NAME is the account created above and hit enter to set the System Manager account password to not expire.
SNMP
SNMP is used to capture alarms raised by the Avaya SBC and VSM also queries the SBC via SNMP. The VSM Probe Server must be added as a destination for SNMP traps and also allowed to Query the SBC.
SNMP queries are configured via the Avaya SBC management portal – System Management> Device Specific Settings> SNMP.
You can configure SNMP v1, v2 or v3. Virsae recommends the use of v3.
SNMP v1/v2
...
Service Desk > Equipment Locations. Right-click on the Equipment Location (Appliance) that will serve this particular SM 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 this table.
Select the Vendor ‘Avaya’ and Product ‘Session Manager’.
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 SM Field Description
Field | Setting |
|---|---|
Vendor | Avaya |
Product | Session Manager |
Equipment Name | Friendly name for this SM |
Username | The administrative username you added to SM earlier |
Password | The administrative password you added to SM earlier |
IP Address / Host Name | IP Address of server |
Site | Friendly name for core site (where this server is located) |
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 the SM:
SNMP V1 or V2
SM SNMP V1/V2 Field Descriptions
| Fields | Setting |
|---|---|
Version | V1, V2 |
SNMP Community String | Community String as administered on the SM |
SNMP V3
SM
Fields | Setting |
|---|---|
Community Name | Pick a name to suit your installation |
Traps | VSM appliance Probe Service IP Address:162 |
- The VSM IP address is the IP address of the VSM probe server (i.e. not the IP address of the physical server). After this IP address add a colon and 162, e.g. 192.168.10.10:162.
...
Fields | Setting |
|---|---|
IP Address | VSM appliance Probe Service IP Address |
- The VSM IP address is the IP address of the VSM probe server (i.e. not the IP address of the physical server). After this IP address add a colon and 162, e.g. 192.168.10.10:162.
SNMP v3
...
- These settings need to match the setup within VSM for the SBC for SNMP V3.
...
Fields | Setting |
|---|---|
Username | Set the username you wish to use for VSM e.g. virsae |
Authentication Scheme | AuthPriv |
AuthPassPhrase | Set a password that meets Avaya's criteria |
Authentication Protocol | MD5 or SHA (Recommended) |
PrivPassPhrase | Set a password that meets Avaya's criteria |
Privacy Protocol | DES |
Priviledge | Read |
Trap IP Address | VSM probe IP address |
Port | Default – 162 |
Trap Profile | default |
...
Fields | Setting |
|---|---|
IP Address | VSM appliance Probe Service IP Address |
- The VSM IP address is the IP address of the VSM probe server (i.e. not the IP address of the physical server). After this IP address add a colon and 162, e.g. 192.168.10.10:162.
Syslog
To setup syslog output form the Avaya SBC to VSM go to System Management> Device Specific Settings> Syslog Management: 
Avaya SBC Syslog
Click on the 'Collectors' tab note a collector suffix that is not being used (in this example LOG_LOCAL2) and click on the 'Add' button, choose the collector name from the 'Facility' drop down box and set the 'Collector Type' to 'Remote Syslog', Set the "Protocol' to 'UDP and the 'Address' to '(ip:port)' to the VSM appliance Probe Service IP Address and port 514. Then click 'Finish':
Avaya SBC Add Collector Profile
Avaya SBC Add Collector Profile Field Description
Fields | Setting |
|---|---|
Facility | Choose an unused Collector Name |
Collector Type | Remote Syslog |
Protocol | UDP |
Address | 'VSM appliance Probe Service IP Address':514 |
...
Web Portal Configuration
Add SBC
Avaya Aura Messaging (AAM) Configuration
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.
AAM Configuration
Adding a new AAM Login
The VSM Probe requires access to Avaya Aura Messaging with the appropriate user rights. This can be achieved by creating a new user within Avaya Aura Messaging with user profile 18, or a read-only account with same level of access.
Browse to the Avaya Aura Messaging and login. Click on Security > Administrator Accounts and select Add Login and Privileged Administrator and click submit:
AAM Administer account
Enter details as per the table below:
AAM Add Login
ACM Add Login Field Description
Fields | Setting |
|---|---|
Login name | Choose a Login name (refer to technical requirements forms) |
Additional groups (Profile) | prof18 |
SAT Limit | none |
Date to disable account | Leave blank |
Password | Choose a password (refer to technical requirements forms) |
Force password change | No |
...
Configuring SNMP
SNMP traps are used to capture alarms raised by Avaya Aura Messaging, and to allow VSM to query certain information.
Click on SNMP > Agent Status. To make changes to SNMP configuration the Master Agent must first be stopped by clicking the 'Stop Master Agent' button:
Anchor
The VSM Probe Server must then be added as a destination for SNMP traps. For this reason the VSM Probe Server must be assigned a fixed IP address. Click on SNMP > FP Traps> Add/Change. Enter the details in the SNMP Version 3 option and click the Submit button:
AAM SNMP Add IP Address
AAM SNMP V3 Field Description
| Fields | Setting |
|---|
IP address
IP address of the VSM Probe
Notification
trap
User Name
Version | V3 |
Username | SNMP V3 Username |
(refer to technical requirements forms) | |
Authentication Protocol | SHA |
Authentication Password |
Password (refer to technical requirements) | |
Privacy Protocol | DES |
Privacy Password |
Password (refer to technical requirements forms) |
Engine ID
Not required
...
Web Portal Configuration
Avaya Application Enablement Server (AES) Configuration
AES Configuration
Adding a new AES Login
Create an Administrator account. The VSM Probe requires access with Administrative rights. Add an account that when used provides access to the Linux bash prompt.
The new account should be similar to the default "craft" account.
- Start an SSH session. At the command prompt type su root. When prompted enter the 'root' user password.
- Use the command useradd NAME; where NAME is the account name to create and hit enter.
- Use the command passwd NAME; where NAME is the account name created above and hit enter. Enter the password then hit enter (need to do this twice).
- Enter the command chage –M 99999 NAME; where NAME is the account created above and hit enter to set the System Manager account password to not expire.
SNMP
SNMP is used to capture alarms raised by AES and VSM also queries the AES via SNMP to retrieve TSAPI and DMCC licensing usage statistics. The VSM Probe Server must be added as a destination for SNMP traps and also allowed to Query the AES.
SNMP queries are configured via the AES management portal Utilities> SNMP> SNMP Agent. Enable SNMP Version 2c and set the community name to the same value as was administered in the AES setup form within VSM.
Set the 'Authorized IP Addresses for SNMP Access' to 'Any IP Address' or 'Following IP Address', if the latter then ensure the VSM Appliance Probe IP address is populated in one of the IP address boxes below this setting, then click 'Apply Changes': 
AES SNMP Query
AES SNMP Query Field Description
Fields | Setting |
|---|---|
Enable SNMP Version 2c | Ticked |
Community Name | Same as Administered in VSM for the AES |
Authorized IP Addresses for SNMP Access | Any IP address 'or' Following IP Addresses |
If using 'Following IP Addresses' | IP Address of the VSM Appliance Probe must be entered in one of the IP address fields. |
- The VSM IP address is the IP address of the VSM probe server (i.e. not the IP address of the physical server).
...
Complete the Equipment tab and then click on the ‘CDR’ tab. Select the ‘Enable Collection of CDR Files’ checkbox.
| Note |
|---|
This is only required if you are collecting CDR Files from Session Manager. |
Web Portal – SM CDR Field Description
Field | Setting |
|---|---|
Enable Collection of CDR Files | Selected |
Delete CDR Files After Download | Recommended |
File Type | Flat |
SFTP User Name | The SFTP username you added to SM earlier |
SFTP Password | The SFTP password you added to SM earlier |
Test Access
Once all fields are populated Click on the 'Test Access' button. This will test that VSM can connect to the SM using the settings you have entered:
Both SSH and SNMP should return success. If not, troubleshoot the configuration.
- The SSH test ensures the VSM probe can connect to, and log in using the account configured.
- The SNMP test ensures an SNMP query can be run.
Once testing is successful, click Add.
Generate Test Alarm
Browse to System Manager and log in. Navigate to Services > Inventory from the dashboard. Navigate to Manage Serviceability Agents > Serviceability Agents:
Generate a Test Alarm by selecting the SM Agent, and clicking on the 'Generate Test Alarm' button.
Return to the VSM home page. For the particular customer, select Availability Manager > Manage Alarms:
The test should show as an alarm. If not, troubleshoot the configuration.
| Info |
|---|
This test has the SM generate an SNMP trap and ensures VSM receives the same. |
The SM configuration is now complete.
...
Fields
...
Setting
...
Device
...
SSG
...
IP Address
...
IP address of VSM Appliance probe
...
Port
...
162
...
Notification type
...
Trap
...
SNMP Version
...
2c
...
Security Name
...
public
...
Authentication Protocol
...
None (Password to be blank)
...
Privacy Password
...
None (Password to be blank)
- The VSM IP address is the IP address of the VSM probe server (i.e. not the IP address of the physical server).
Web Portal Configuration
...