ASM Configuration
Adding a new Session Manager 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. Refer to the completed technical requirements forms:
- If the Session Manager is already installed, use the "admin" account created during installation. This is because any account created after installation of Session Manager is not updated in the sudoers file system and therefore will not have administrative rights.
- 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.
Configure SM SNMP Traps
This section requires the Virsae SNMP Target Profile to be set up in System Manager. If this is not the case, please refer to System Manager Configuration earlier in this document before proceeding.
In System Manager, navigate to Manage Serviceability Agents > Serviceability Agents:
Figure 56 – SM Serviceability Agents
Select an agent from the Agent List window, in this case the Session Manager and click on the Manage Profiles button.
Figure 57 – SM Manage Profile
From the Manage Profiles window, under the SNMP Target Profiles tab, select the Virsae profile, click on Assign and then the Commit button.
Configure SIP Station SNMP Query
To enable VSM to understand the IP Endpoint configuration the SIP stations must allow VSM to proactively run queries.
Make these changes in the 46xxSettings.txt files as follows. (refer to technical requirements forms):
In the SNMP section edit and uncomment the following settings:
SET SNMPADD [VSM Probe IP Address (V4)]
SET SNMPSTRING [SM SNMP Community Name] or public
Configure RTCP Monitoring
To allow VSM to monitor the voice quality of SIP endpoint calls, 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:
SM Device Settings Group
Click on the 'Default Group' button.
SM Device Settings Default Group
Expand 'VoIP Monitoring Manager' and then add the IP address of the VSM Client, the port for the RTCP receiver you wish to send the RTCP data to (default is 5005), and the reporting period (default is 5 seconds). Once complete click 'Save'
Table 28 – SM Device Settings Default Group Field Description
Field | Setting |
---|---|
IP Address | IP Address of the VSM probe |
Port | 5005 - see note |
Reporting Period | 5 |
- A single Equipment Location can support multiple RTCP Receivers. Each individual ACM and its adjuncts should report to a separate discrete RTCP Receiver using a unique port for each.
Configure CDR (Optional)
From the main System Manager navigate to Elements > Session Manager. Select Session Manager Administration:
SM Administration
From the Session Manager Administration window shown below, select the Session Manager Instances tab, select the Session Manager and click on Edit:
SM CDR Configuration
Scroll down to the CDR section and configure as per the table.
SM CDR Field Description
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 |
Click on the Commit button.
SIP Tracer
Navigate to Home > Session Manager > System Tools > Configuration:
SM SIP Tracer Configuration
Select the Session Manager you wish to configure from the 'Session Manager Instances' list then click the 'Read' 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 Field Description
Field | Setting |
---|---|
Remote Server FQDN or IP Address | IP Address of VSM Probe |
Send Trace Method | Syslog |
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 |
- 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 |
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.
The SM configuration is now complete.
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
Select the SNMP v1/v2 tab then click the 'Add' button:
Figure 73 – Avaya SBC SNMP v1/v2 add
Add a Community Name and an IP address and port for the SNMP traps to be sent to then click finish:
Avaya SBC Set SNMP v1/v2 Trap Destination
Avaya SBC Set SNMP v1/v2 Trap Destination Field Description
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.
You should now see the details you have added in the SNMP v1/v2 tab.
Figure 75 – Avaya SBC SNMP v1/v2 Community Name and Trap Destination
Next click on the 'Management Servers' tab then click the 'Add' button:
Avaya SBC SNMP v1/v2 Add Management Server IP
Add the IP address of the VSM appliance Probe then click 'Finish':
Avaya SBC Set SNMP Management Server Field Description
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
Select the SNMP v3 tab then click the 'Add' button:
Figure 77 – Avaya SBC SNMP v3 add
Add a Username, select the radio button for 'authpriv' set a passphrase for both Auth and Priv, Set the radio button for Authentication protocol 'MD5' and Privacy protocol 'DES', and set the Priviledge radio button to 'Read'
- These settings need to match the setup within VSM for the SBC for SNMP V3.
Set the 'Trap IP Address' to the IP address of the VSM probe. All other settings remain default.
Figure 78 – Avaya SBC Set SNMP v3 Trap Destination
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 |
Once Complete click 'Finish':
Avaya SBC v3 Trap Destination Set
You should now see the details you have added in the SNMP v3:
Avaya SBC SNMP v3 Community Name and Trap Destination
Next click on the 'Management Servers' tab then click the 'Add' button.
Add the IP address of the VSM appliance Probe then click 'Finish':
Avaya SBC SNMP v3 Add Management Server IP
Avaya SBC SNMP v3 Add Management Server IP Field Description
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 |
Now click on the 'Log Level' tab and set the level of logging you with to be sent to the collector you have just administered. Best practice would be to send all levels for all types:
Avaya SBC set Log Level
Once complete click 'Save'. You can now log out of the Avaya SBC.
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 |
Click Submit.
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:
Figure 94 – AAM SNMP Stop Master Agent
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 | Choose an SNMP User Name (refer to technical requirements forms) |
Authentication Protocol | SHA |
Authentication Password | Choose an Authentication Password (refer to technical requirements) |
Privacy Protocol | DES |
Privacy Password | Choose a Privacy Password (refer to technical requirements forms) |
Engine ID | Not required |
After adding the SNMP destination it should be listed on the FP Traps page.
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).
SNMP Traps are configured via the AES management portal Utilities> SNMP> SNMP Trap Receivers, then click 'Add':
Figure 104 – AES SNMP Trap Receivers
Populate the required fields as per the table below and then click 'Apply changes':
AES Add SNMP Trap
AES SNMP Trap Field Description
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).