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.
ACM Configuration
Adding a new ACM Login
The VSM Probe requires access to Avaya Communication Manager with the appropriate user rights.
This can be achieved by creating a new user within Avaya Communication Manager with user profile 18, or a read-only account with the same level of access.
Browse to the Avaya Communication Manager and log in. Click on Security > Administrator Accounts and select Add Login and Privileged Administrator and click submit:
Enter details as per the table below:
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.
Once this account has been created, test it has the correct privileges by logging on an SAT and running the following non-destructive commands:
ACM Application
- display system-parameters customer-options
- list registered-ip-stations
- list measurements occupancy summary
- status ip-network-region
- monitor security-violations station-security-codes
- display alarms
- test port
ACM server Linux Bash commands
- server
- cat /etc/opt/ecs/ecs.conf
- pingall –s 1
- ifconfig –a
These commands should all return valid data. If not, the account you created is not correct.
Adding a new Media Gateway Login
The VSM Probe requires access to the Media Gateways.
This can be achieved either by using the existing root account or by creating a new administrator account on each Media Gateway.
To use the root account, the password needs to be added to the VSM portal and instructions are in the next section of this manual.
To add a new administrator account, refer to the completed technical requirements forms and run these commands:
G450/430:
- Logon as 'root'
Run the command:
$ Username [choose a username] password [choose a password] access-type admin
- Test you can login to the Gateway with the new credentials.
G700:
- Logon as 'root'
- The prompt should be 'MG-001-1'
- Run the command: 'session stack'
- The prompt should now be 'P330-1'
Run the command: 'Username [choose a username] password [choose a password] access-type admin'
- Test you can login to the Gateway with the new credentials.
SNMP Traps and Access
SNMP traps are used to capture alarms raised by Avaya Communication Manager, SNMP Access is used by VSM to query certain information from the Avaya communication Manager
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, once you have completed SNMP setup Start the Master Agent again:
ACM SNMP Stop Master Agent
SNMP Access
The VSM Probe Server must be allowed to query the Avaya Communication Manager via SNMP.
Click on SNMP > Access. Click on 'Add/Change'.
ACM SNMP Access
Enter the details in the SNMP Version 2c or 3 option and click the Submit button:
SNMP Access Add/Change
ACM SNMP Access Field Description
Fields | Setting |
---|---|
IP Address | IP address of the VSM Probe |
Access | Read-Only |
Community Name/User Name (v3) | Choose an SNMP User Name or Community Name (refer to technical requirements forms) |
Authentication Protocol (v3) | Choose an Authentication Protocol |
Authentication Password (v3) | Choose an Authentication Password (refer to technical requirements) |
Privacy Protocol (v3) | Choose a Privacy Protocol |
Privacy Password (v3) | Choose a Privacy Password (refer to technical requirements forms) |
SNMP Traps
The VSM Probe Server must 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. Enter the details in the SNMP Version 2c or 3 option and click the Submit button:
ACM SNMP Add IP Address
ACM SNMP Trap Field Description
Fields | Setting |
---|---|
IP address | IP address of the VSM Probe |
Notification | trap |
User (v3)/Community Name | Choose an SNMP User Name or Community Name (refer to technical requirements forms) |
Authentication Protocol (v3) | SHA |
Authentication Password (v3) | Choose an Authentication Password (refer to technical requirements) |
Privacy Protocol (v3) | DES |
Privacy Password (v3) | Choose a Privacy Password (refer to technical requirements forms) |
Engine ID (v3) | Not required |
After adding the SNMP destination it should be listed on the FP Traps page:
ACM SNMP Complete
Next the ACM application also needs to be configured to send INADS alarm information to VSM via SNMP. This is done via the shell command "almsnmpconf". To use this command, log into the ACM server Linux prompt. Execute the command:
almsnmpconf -d {VSM Probe IP ADDRESS} -c public
Where:
VSM Probe IP ADDRESS is the IP address of the VSM probe server (i.e. not the IP address of the physical server).
Check that the INAD SNMP alarms are enabled by executing the following command:
almenable
If the output is as below:
then execute the command below to enable it:
almenable –s y
- For customers with duplicated servers, this needs to be done on each server independently.
Modify Station SNMP Settings
To complete the SNMP configuration in Avaya Communication Manager, the VSM probe server must be added to the IP Node names table as shown below and then that Name used in the IP Options page. This configuration allows VSM to request information via SNMP query:
ACM SNMP Node-names IP
ACM SNMP Node-names IP Field Description
Fields | Setting |
---|---|
Name | VSM Probe IP node-name (refer to technical requirements forms) |
IP address | IP Address (V4) (refer to technical requirements forms) |
Submit the form.
ACM SNMP System-parameters IP-Options
- If the Download flag is set to yes as shown above then these settings will be downloaded to the phone and will overwrite any 46xxxSettings.txt file settings.
ACM SNMP System-parameters IP-Options Field Description
Fields | Setting |
---|---|
Download Flag? | Y |
Community String | SNMP Community Name (refer to technical requirements forms) or public |
Source Address | VSM Probe IP node-name (refer to technical requirements forms) |
Submit the form.
Optional: The alternative is to 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. Add text as per below:
SET SNMPADD [VSM Probe IP Address (V4)]
SET SNMPSTRING [ACM SNMP Community Name] or public
- Ensure the Avaya Communication Manager firewall is configured to pass SNMP. Click on Security > Firewall:
ACM Firewall
- ACM policy must accept UDP 161 and 162.
Enable Syslog streaming
The following changes are required to define the VSM Probe as a destination for Avaya Communication Manager Syslog. Click on Security > Server Log Files:
ACM Syslog
ACM Syslog Field Description
Fields | Setting |
---|---|
When Submit button is clicked… | Checked |
Enable logging to the following syslog server | Selected |
Server name | IP address of the VSM Probe |
Selection for which logs are to be sent | All Checked |
Once the details have been entered click the Submit button.
At the SAT terminal enter the command 'Change Logging-Levels', on page 1 set the 'Log Data Values' field to 'Both' and All Action Values (with the exception of Display, Get, List, Monitor and Status) to 'y' and on page 2 set the 'Log PMS/AD Transactions' field to 'Y':
ACM Logging Levels Page 1
ACM Logging Levels Page 2
- These changes increase the logging level to add a greater level of Change Manager reporting.
ACM Logging Levels Field Description
Fields | Setting |
---|---|
Log Data Values | Both |
All Action Values | Y – Except 'Display' 'Monitor' 'Status' 'List' 'Get' |
Log PMS/AD Transactions | Y |
Submit the form.
Configure Off-site Backups
The following changes are required to define the VSM Probe as a destination for ACM Backups. These Backup files will be sent from the VSM Probe to the Virsae Cloud. Click on Data Backup/Restore > Schedule Backup > Add:
ACM Off-site Backups
ACM Off-site Backups Field Description
Fields | Setting |
---|---|
Method | sftp (Secure File Transfer Protocol) |
User Name | 7F6952F9 (must match the SFTP settings in the Web Portal Equipment Location) |
Password | Virsae (must match the SFTP settings in the Web Portal Equipment Location) |
Hostname | VSM Probe IP Address (V4) |
Directory | / |
Click Add New Schedule.
Configure CDR (Optional)
Complete this section if the CDR feed from the customer will use VSM as a destination.
- The more data that can be fed into VSM, the better the outcome will be. If there is a CDR application already in use, configure the secondary CDR feed.
The following changes are required to define the VSM Probe as a CDR destination.
Use the command 'Change IP-Services' and add the service type for the CDR1 or 2:
ACM IP-Services Page 1
Go to page 3 and check the setting for the CDR you just configured are as shown in the image below:
ACM IP-Services Page 3
ACM IP-Services Field Description
Fields | Setting |
---|---|
Local Node | ProcR or C-Lan |
Local Port | 0 |
Remote Node | virsae |
Remote Port | 9000 |
Submit the form.
Use the command 'Change System-Parameters CDR' – using either the primary if available or the secondary if the primary is already used enter the output type as 'Unformatted' and names the output Endpoint CDR1 or CDR2:
ACM System-parameters CDR
ACM CDR Field Description
Fields | Setting |
---|---|
Primary/Secondary Output Format (use whichever is spare) | Unformatted |
Primary/Secondary Output Format (use whichever is spare) | CDR1 or 2 |
Submit the form.
Configure RTCP for VQM
The following changes are required to define the VSM Probe as the destination for RTCP (Voice Quality) traffic from the UC environment:
ACM System-parameters IP-Options
ACM System-parameters IP-Options Field Description
Field | Setting |
---|---|
Default Server IP Address | VSM Probe IP Address (V4) |
Default Server Port | 5005 – see note |
Default RTCP Report Period (secs) | 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.
Submit the form.
Optional: Change 46xxsettings.txt file. The following lines can be added to the 46xxsettings file:
SET RTCPMON [VSM Probe IP Address (V4)]SET RTCPMONPORT 5005SET RTCPMONPERIOD 5
- This setting in the 46xx Settings file is mandatory if you have SIP stations and you wish to receive VQM for their calls. For SIP configuration, refer to SM section of this manual. The phones will need to be restarted.
Web Portal Configuration
Add ACM
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 ACM:
Web Portal - All Equipment Locations
Click on Manage Equipment.
Web Portal – Manage Equipment
Click on Add Equipment.
A form will open which you can populate with the equipment details as per table 12.
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 configuratuon will be carried over for the next item.
Web Portal – Add Equipment
Web Portal - ACM Configure Equipment
Web Portal – Add ACM Field Description
Field | Setting |
---|---|
Vendor | Avaya |
Product | Communication Manager |
Equipment Name | Friendly name for this ACM |
Username | ACM Username (refer to technical requirements forms) |
Password | ACM Password (refer to technical requirements forms) |
Username for Media Gateways | Media Gateway Username (refer to technical requirements forms) |
Password for Media Gateways | Media Gateway Password (refer to technical requirements forms) |
IP Address / Host Name | IP Address of server (Virtual in duplicated servers) |
Site | Friendly name for core site (where this server is located) |
Monitored IP Network Regions | Up to 10 Intervening IP Network Regions, comma separated |
Disable automatic connection to Media Gateways | Check this to stop VSM accessing enhanced Media Gateway service information |
Use the above credentials for all Media Gateways | Unchecking this box allows you to set different credentials for all media gateways |
Complete the Equipment tab and then click on the SNMP Query tab.
Click on the down arrow, and select the SNMP verion you wish VSM to use for querying the ACM:
SNMP V1 or V2
Web Portal – ACM SNMP V1/V2 Query
ACM SNMP V1/V2 Field Descriptions
Fields | Setting |
---|---|
Version | V1, V2 |
SNMP Community String | Community String as administered on the ACM |
SNMP V3
Web Portal – ACM SNMP V3 Query
ACM SNMP V3 Field Description
Fields | Setting |
---|---|
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) |
Under the 'Avaya Phones' section enter the SNMP Community String to be used for querying phones and then click the '+' button.
Once all fields are populated Click on the Test Access button. This will test that VSM can connect to the ACM using the settings you have entered:
Web Portal – ACM Test Access
Both Access and SNMP should return success. If not, trouble-shoot the configuration.
- The Access test ensures the VSM probe can connect to, and login using the account configured.
- The SNMP test ensures an SNMP query can be run.
Once testing is successful, click Add.
Testing Alarm Receipt
Right-click on the ACM you just added:
Web Portal – Updated Avaya Product List
Click on Generate Test Alarm. The command should execute successfully. If not, trouble-shoot the configuration.
Return to the home page. For the particular customer, select Availability Manager > Manage Alarms.
The Test should show as an alarm. If not, trouble-shoot the SNMP Trap configuration.
- This test has ACM generate an SNMP trap and ensures VSM receives the same.
Configure Site Mapping (Optional)
Often the name assigned to the IP Network Region in the ACM configuration is not meaningful to the support team. Update the Site Name if you want to assign something different in these fields. The name you enter will be used to identify the site when reporting alarms.
- This step is entirely optional and in most cases depends on the requirements of the support team.
On the Manage Equipment Page, right-click on the ACM, then click Edit. Click on the Site Mappings Tab.
- Updating this form using the IPNR (IP Network Region) configuration in ACM may not be available immediately following an installation. If this step doesn't work, try again in 24 hours.
The IP Network Region numbers and names are presented from the ACM: