Setting up Devices for Prime Collaboration Assurance
From DocWiki
m (1 revision: Added ELM configuration) |
m (→Enable JTAPI) |
||
Line 476: | Line 476: | ||
You can access the log files to verify whether the endpoints are assisned with the CTI-controlled roles in the Unified CM | You can access the log files to verify whether the endpoints are assisned with the CTI-controlled roles in the Unified CM | ||
- | and for the JTAPI-related issues using https://<primecollaboration-ip>/emsam/log/ | + | and for the JTAPI-related issues using https://<primecollaboration-ip>/emsam/log/SessionMon/CUCMJTAPIDiag.log |
</pre> | </pre> | ||
+ | |||
=== '''Configure CDR''' (Billing Server) === | === '''Configure CDR''' (Billing Server) === | ||
Revision as of 01:31, 1 October 2013
This section describes how to configure devices on the network before you manage them in Cisco Prime Collaboration Assurance.
Required Protocols for the Devices (Includes Supported Software Versions)
You must configure the endpoints, application managers, call processors, multipoint switches, and network devices with the following protocols:
- HTTP - Access the device through HTTP to poll system status and meeting information.
- SNMP - Read Community String and SNMP Authentication Protocol (SNMP V2 or SNMP V3) - Discover and manage the device.
- CLI - Access the device through CLI to discover media path for troubleshooting.
- JTAPI - Retrieve the session status information frosm the Cisco Unified CM.
- CDP - Discover neighboring devices.
Note: For supported software versions, see Supported Devices for Cisco Prime Collaboration Assurance.
Device | SNMP | HTTP | CLI | JTAPI | MSI | CDP | Notes |
Analog Gateway | Yes | - | - | - | - | - | |
Contact Center Enterprise | Yes | - | - | - | - | - | |
Contact Center Express | Yes | - | - | - | - | - | |
Cisco TelePresence Multipoint Switch | Yes | Yes | - | - | - | - | The HTTP user account must have both the Meeting Manager and Diagnostic Technician roles. |
Cisco TelePresence System (CTS) | Yes | - | Yes | - | | - |
|
Cisco TelePresence Manager (CTS-Manager) | Yes | Yes | - | - | - | - |
|
Cisco Unified CM | Yes | Yes | - | Yes | - | - |
|
Cisco Unified Communications Manager Business Edition | Yes | Yes | - | Yes | - | - | |
Customer Voice Portal | Yes | - | - | - | - | - | |
| Yes | Yes | Yes | - | Yes | - |
|
Cisco IP Video Phone E20 | Yes | Yes | Yes | - | Yes | - |
|
Emergency Responder | Yes | - | - | - | - | - | |
Expert Advisor | Yes | - | - | - | - | - | |
Finesse | Yes | - | - | - | - | - | |
Cisco MCU | Yes | Yes | - | - | - | - |
|
Cisco TelePresence MSE Supervisor | Yes | Yes | - | - | - | - | The HTTP user requires Admin privilege. |
Mediasense | Yes | - | - | - | - | - | |
Meeting Place | Yes | - | - | - | - | - | |
Meeting Place Express | Yes | - | - | - | - | - | |
Personal Assistant | - | - | - | - | - | - | |
Cisco TelePresence System MXP series | Yes | Yes | Yes | | | | |
Polycom VSX series Polycom HDX series | Yes | - | - | - | - | - | End-to-end troubleshooting is not supported. However, the path trace can be discovered from the first-hop-router (FHR) if router CLI access is provided for Prime Collaboration. |
Cisco Unified Presence | Yes | Yes | - | - | - | - | |
Network devices (routers and switches) | Yes | - | Yes | - | - | Yes |
|
Cisco TelePresence Management Suite (Cisco TMS) | Yes | Yes | - | - | - | - |
|
Cisco Telepresence Server | - | Yes | - | - | - | - |
|
Cisco Telepresence Conductor | Yes | Yes | - | - | - | - | |
Cisco Unity | Yes | - | - | - | - | - | |
Cisco Unity Connection | Yes | Yes | - | - | - | - | |
Cisco Unity Express | Yes | - | - | - | - | - | |
Cisco TelePresence Video Communication Server (Control and Expressway) | Yes | Yes | - | - | - | - | The HTTP user requires Admin privilege. |
Wireless | Yes | - | Yes | - | - | - | |
Third party devices | Yes | - | - | - | - | - | |
Cisco Jabber Video for Telepresence (Movi) | - | - | - | - | - | - |
|
Cisco Cius | - | - | - | - | - | - |
|
Cisco IP phones (89xx, 99xx) | - | - | - | - | - | - |
|
Border Element, Gatekeeper, H323 Gateway, SIP Gateway MGCP Gateway, SRST Device, Voice Gateway | - | - | - | - | - | - | |
Configuring Call Controllers and Processors
Cisco Unified Communications Manager
All CTS endpoints must be added as controlled devices in Cisco Unified CM to facilitate call detection. You must configure a HTTP and JTAPI user on the call processor.
Note: The procedures described below are applicable for Cisco Unified CM 8.5. If you are using any other supported versions, see the Cisco Unified CM guides to understand how to create groups, users and assign roles to them.
Enable HTTP
You do not have to create a new user if you want to allow Cisco Prime Collaboration to use admin credentials to log in. Alternatively, if you want to allow Cisco Prime Collaboration Manager to use the right credentials to log in to Cisco Unified Communications Manager, you must create a new HTTP user group and a corresponding user that Cisco Prime Collaboration can use to communicate.
To create a user:
- Create a user group with sufficient privileges. Log in to the Cisco Unified CM Administration web interface using the administrator role.
- Choose User Management > User Group and create a new group with a suitable name, PC_HTTP_Users in this case.
- Click Role.
- Click Assign Role to Group and select the following roles:
- Standard AXL API Access
- Standard CCM Admin Users
- Standard SERVICEABILITY Administration
- Click Save.
- From the main menu, choose User Management > Application Users > Create a new user.
Specify a suitable password on the Application User Configuration page. You can select only certain type of devices from the Available Devices text area, or allow Cisco Prime Collaboration to monitor all devices. - In the Permission Information section, click Add to User Group and select the group that was created in Step 1 (for example, PC_HTTP_Users).
- Click Save. The page is refreshed and the right privileges are displayed.
Enable SNMP
SNMP is not enabled in Cisco Unified Communications Manager by default.
To enable SNMP:
- Log in to the Cisco Unified Serviceability view in the Cisco Unified Communications Manager web GUI.
- From the main menu in the Cisco Unified Serviceability view, choose SNMP > v1/v2c > Community String.
- Select a Server and click Find.
If the community string is already defined, the Community String Name is displayed in the Search Results. - Click Add new to add a new string if no results are displayed.
- Specify the required SNMP information and save the configuration.
- Also make sure the Call Manager SNMP Service is running.
Enable JTAPI
JTAPI (Java Telephony API) is used to retrieve the session status information from the device. You must create a JTAPI user in the call processor with the required permission to receive JTAPI events on endpoints. Prime Collaboration manages multiple call processor clusters. You must ensure that the cluster IDs are unique. Create a new JTAPI user to help Cisco Prime Collaboration get the required information.
To create a new JTAPI user:
- Log in to the Cisco Unified CM Administration web interface using administrator role.
- Choose User Management > User Group and create a new group with a suitable name, PC_HTTP_Users in this case.
- Move all endpoint devices (for example, Cisco TelePresence codecs) to the Controlled Devices table.
- Click Roles.
- Click Assign Role to Group and select the following roles:
- Standard CTI Allow Call Monitoring
- Standard CTI Enabled
- Standard CTI Allow Control of Phones supporting Connected Xfer and conf
- Click Save.
- From the main menu, choose User Management > Application Users > Create a new user.
Specify a suitable password on the Application User Configuration page. You can select only certain type of devices from the Available Devices text area, or allow Cisco Prime Collaboration to monitor all devices.
Note: The password must not contain a semicolon (;) or equals (=). - In the Permission Information section, click Add to User Group and select the group that was created in step 1. (for example, PC_HTTP_Users).
- Click Save. The page is refreshed and the right privileges are displayed.
Note: *Ensure the following services are activated and started: **Cisco CTIManager **Cisco AXL Web Service See the Cisco Unified Communications Manager guide for details about how to configure the application user. You can access the log files to verify whether the endpoints are assisned with the CTI-controlled roles in the Unified CM and for the JTAPI-related issues using https://<primecollaboration-ip>/emsam/log/SessionMon/CUCMJTAPIDiag.log
Configure CDR (Billing Server)
You can monitor Call Detail Record (CDR) trunk utilization on your Unified CMs using Prime Collaboration Assurance. To monitor CDR-based trunk data using Prime Collaboration Assurance:
- Log in to the Cisco Unified CM Administration web interface.
- Choose System > Service Parameters. The Service Parameters Configuration page appears.
- Set parameters for:
- CDR Enabled Flag by scrolling down to System and selecting True.
- Call Diagnostics Enabled by scrolling down to Cluster wide Parameters (Device - General) and selecting Set to Enable Only When CDR Enabled Flag is True.
- To add Prime Collaboration as a billing server, you must ensure Prime Colaboration is up and running.
- Launch Cisco Unified Serviceability.
- Choose Tools > CDR Management.
- Scroll down to Billing Applications Server Parameters and click Add New.
- Enter the following:
- Host Name / IP Address—Enter the IP address of the system where Prime Collaboration Assurance is installed.
- User Name—Enter smuser.
Note: Do not enter any username other than smuser. - Password—Enter a password. The default password is smuser. To change this password:
- Change it in Prime Collaboration Assurance first.
- Enter the same password that you entered for smuser while configuring other settings in Prime Collaboration Assurance.
Note: If you changed the password in Prime Collaboration Assurance and Unified Communications Manager does not immediately accept the new password, wait one minute and enter the new password again.
- Protocol—Select SFTP Protocol.
- Directory Path—Enter /home/smuser/.
Note: Do not enter any directory path other than /home/smuser. - Resend on Failure—Select this check box.
- Click Add.
Note: In some cases, for CDR/CMR files to be delivered to a newly added billing server, it is necessary to first restart the CDR Repository Management Service.
- From Cisco Unified Serviceability, choose Tools > Control Center - Network Services.
- From the list of Unified Communications servers, select the publisher.
- Scroll down to CDR Services.
- Select the Cisco CDR Repository Manager radio button.
- Click the Restart button.
Change the Password for smuser
The SFTP password for smuser in Prime Collaboration and the password for the Application Billing Server smuser in Cisco Unified Communications Manager must be identical. Any time you change one, you must change the other to match.
Use this procedure to change the password for the Application Billing Server smuser in Cisco Unified Communications Manager.
- Log in to the Cisco Unified Serviceability view in the Cisco Unified Communications Manager web GUI.
- Choose Tools > CDR Management.
- Scroll down to Billing Application Server Parameters and double-click the link for Prime Collaboration.
Enter a new password. If you changed the password in Prime Collaboration and Cisco Unified Communications Manager does not immediately accept the new password, wait one minute and enter the new password again. Do not change the values in any other fields; Host Name / IP Address, User Name, SFTP Protocol, and Directory Path must remain the same. - Click Update.
Activate the AXL Web Service
Perform this procedure for Unified Communications Manager versions.
- Launch Cisco Unified Serviceability.
- Choose Tools > Service Activation.
- Select a server.
Note: Activate the AXL Web Service on the Publisher node. - Scroll down to Database and Admin Services and select Cisco AXL Web Service.
- Click Save.
Configuration for CVTQ Data
For Prime Collaboration Assurance to obtain CVTQ data from a Unified Communications Manager, you first need to perform configuration tasks while logged in to Unified Communications Manager.
You might also need to perform some additional configuration on H.323 and SIPs gateways if voice activity detection (VAD) is enabled on them so that MOS is calculated properly and, therefore, reported correctly in CDRs.
Set Unified Communications Manager Service Parameters
Note: Set these parameters on each Unified Communications Manager in a cluster.
- Log in to Unified CM Administration.
- Choose System > Service Parameters. The Service Parameters Configuration page appears.
- Select the server and the service:
- Select the name of the Unified Communications Manager server. This is a Unified Communications Manager from which Prime Collaboration Assurance will gather data.
- Select the Unified Communications Manager service.
- Set these parameters:
- CDR Enabled Flag—Scroll down to System. Set to True.
- Call Diagnostics Enabled—Scroll down to Clusterwide Parameters (Device - General). Set to Enable Only When CDR Enabled Flag is True.
Note: It is recommended that you ensure that Call Diagnostics Enabled is set to Enable Only When CDR Enable Flag is True on the publisher and on each of the subscribers.
- Click Update.
Caution: Do not enable the CDR Log Calls With Zero Duration Flag service parameter. Enabling it can adversely impact Prime Collaboration Assurance (and CDR Analysis and Reporting). Resources spent processing numerous zero-duration call records can take away from the number of non-zero-duration calls that Prime Collaboration Assurance can process.
Set Unified Communications Manager Enterprise Parameters
- Log in to Unified CM Administration.
- Choose System > Enterprise Parameters. The Enterprise Parameters Configuration page appears.
- Select the Cluster ID. If the cluster ID is already present Prime Collaboration Assurance, change it.
Note: Each cluster that you add to Prime Collaboration Assurance must have a unique cluster ID. - Scroll down to CDR Parameters and set CDR File Time Interval (min) to 1.
- Click Update.
Configure Voice Gateways when VAD is Enabled
Enabling voice activation detection (VAD) can save bandwidth, but it can also impact Prime Collaboration Assurance MOS calculations for CVTQ reports and might cause noticeable or unacceptable clipping of words. VAD is enabled by default in Cisco IOS voice (under dial peer configuration), and disabled by default in Unified Communications Manager (under System > Service Parameters).
When VAD is enabled on a voice gateway in a cluster, you can see lower MOS values in CVTQ reports for calls between the voice gateway and a Cisco Unified IP Phones. You need to:
- Configure the comfort noise payload type to 13 (from the default of 19) on H.323, SCCP, and SIP gateways. Doing so enables Cisco Unified IP Phones and voice gateways to properly adjust the MOS calculation.
Note: Sensors calculate MOS correctly for voice gateways when VAD is enabled. - Be aware that low MOS will be reported for calls between Cisco Unified IP Phones and MGCP gateways on CVTQ reports. (Comfort noise payload type is not configurable on MGCP gateways.)
Note: Call Management Record (CMR) data will not be available in Prime Collaboration Assurance for Cisco Unified Border Element (CUBE), because Unified Communications Manager does not support CMR for SIP trunks.
Activate Enterprise License Management Resource API
Whenever the ELM and Unified CM co-resides, the service in Unified CM which provides the REST API to get license data needs to be activated manually.
- SSH to Unified CM.
- Enter the command.
license management service activate Cisco ELM Resource API
After the configuration, the following message will be displayed:
Activating Cisco ELM Resource API completed successfully
Configure Syslog Receiver
To successfully receive Cisco Unified Communications Manager syslog messages, you must add the syslog receiver from the device’s serviceability web page.
- On your Cisco Unified Communications Manager, select Cisco Unified CM Administration from the Navigation drop-down in the top-right corner of the device’s home screen.
- Choose System > Enterprise Parameters.
- Go to Cisco Syslog Agent section and update the following required fields:
- Remote Syslog Server Name with the IP address of Prime Collaboration Assurance .
- Select Informational from the drop-down menu for Syslog Severity For Remote Syslog Messages.
- Select Cisco Unified Serviceability from the Navigation drop-down in the top-right corner of the device’s home screen.
- Choose Alarm > Alarm Configuration.
Caution: Do not use the CCM enterprise service parameter to configure the syslog receiver for Prime Collaboration Assurance syslog integration. When the enterprise parameter is enabled, all syslog messages (with matching severity levels) are sent regardless of whether or not they are intended to be processed by Prime Collaboration Assurance.
- Select the correct alarm configuration elements (Server, Service Group, and Service) for your particular machine and then click Go. For example:
- Enter Prime Collaboration Assurance server name/address in Server text box.
- Select Service Group and Service options based on the following table:
- Service Group > CM Services > Service > Cisco CallManager
- Service Group > CDR Service > Cisco CDR Agent and Cisco CDR Repository Manager
- Service Group > Database and Admin Services > Cisco Database Layer Monitoring
- Service Group > Performance and Monitoring Services > Cisco AMC Service
- Service Group > Backup and Restore > Cisco DRF Client and Cisco DRF Master
- Service Group > Remote Syslogs
- Click on the Enable Alarm check box, select proper Alarm Event Level.
See the Alarm Configuration Settings in Cisco Unified Serviceability Administration Guide for Cisco Unified Communications Manager on Cisco.com.
For example, for Local Syslogs, set the alarm event level to Error. - Enter any necessary information based on your Unified Communications Manager. For device cluster discovery or remote syslog notification, set the alarm event level to Informational.
- Check Apply to All Nodes and click Save.
Syslog messages have a limitation of 1,024 characters (including the heading). Any syslog-based event details may not contain the full information because of this syslog limitation. If the syslog message exceeds this limit, it is truncated to 1,024 characters by the syslog sender.
Cisco Unity Connection
Configure Syslog Receiver
To successfully receive Cisco Unity Connection syslog messages, you must add the syslog receiver from the device’s serviceability web page. To configure syslog receiver on Cisco Unity Connection:
- On your Cisco Unity Connection, select Cisco Unity Connection Administration from the Navigation drop-down in the top-right corner of the device’s home screen.
- Choose System Settings > Enterprise Parameters.
- Go to Cisco Syslog Agent section and update the following required fields:
- Remote Syslog Server Name with the IP address of Prime Collaboration Assurance.
- Select Informational from the drop-down menu for Syslog Severity For Remote Syslog Messages.
- Select Cisco Unity Connection Serviceability from the Navigation drop-down in the top-right corner of the device’s home screen.
- Choose Alarm > Configurations.
Select the correct alarm configuration elements for your particular machine:- For Unity Connection 8.x:
- Enable Informational Alarms for Local syslogs
- Enable Informational Alarms for Remote Syslogs and enter the Server name as Prime Collaboration Assurance Server IP address
- For Unity Connection 8.x:
- Click Save to save the configuration to complete syslog configuration.
Configure the Unity Event Monitoring Service
The Event Monitoring Service (EMS) should already be installed along with the Remote Serviceability Kit.
Configure the Event Monitoring Service to support these Unity events in Prime Collaboration Assurance:
- OutOfDiskSpace
- HardDiskError
- ExchangeLoginFailed
To configure the Event Monitoring Service:
- Open the Tools Depot on the Desktop and choose Diagnostic Tools > Event Monitoring Service.
- Double-click to run.
- Create a recipient to receive notifications by selecting File > New > Recipient, or select the Recipients node in the navigation tree and click Create New Recipient.
- Enter a Recipient Name to identify a single recipient (or a group as there can be multiple E-mail addresses under SMTP).
- Select the desired notification method tabs.
- The SNMP trap tabs works with the Remote Serviceability Kit to send traps to a destination (defined under windows SNMP service properties).
- The Syslog tab allows entry of a Syslog server address for the event.
- The failover tab is not a notification, but can force a failover upon receipt of a specified event.
The Test button at the top of the page sends a test event to the defined recipients. These can be: - Event Source: EMSTest
- Event ID:10001
- Description: Event Monitoring Service Test Message
- Create a monitored event by selecting File > New > Event, or select the Monitored Events node in the navigation tree and click Create New Event.
If the event exists currently in the Windows Event Viewer, to populate the event information in the Add New Event dialog:- Select the event in Windows Event Viewer.
- Select Copy Event to Clipboard.
- Use Import Event From Clipboard in the Add New Event dialog.
To manually add the event:
- Select Event Source from the pull-down menu
- Select a specific Event ID and enter the desired ID. All Event IDs could also be used to obtain all events from a specified event source.
- Select Type to filter what level notifications should be sent for.
- Select Errors, Warnings, and Informational for all level events or if the Type is unknown.
- Enter Notes that will be included with the notification, such as troubleshooting steps.
The content section allows you to record a custom WAV for the event used along with the Recipient Voicemail option.
The Email Subject and Body can be used to customize the formatting of the messages sent to Recipient Email and SMTP notification methods. If no customization is desired, leave default fields as is. - Select OK after adding the new event.
To activate the new event, one or more Recipients need to be added to it.
- Select the newly added event and click on the Add Recipients icon. The Recipients and notification methods can be further defined with check boxes here.
- Check the Active check box and Apply to activate the event.
You may also perform this step from the Monitored Events node in the navigation tree.
You can also exclude or ignore events that pass the other criteria by selecting File > New > Exclusion, or select the Exclusions node in the navigation tree and click Create New Exclusion.
If the event exists currently in the Windows Event Viewer, you can populate the event information in the Add Exclusion dialog by selecting the event in Windows Event Viewer and clicking Copy Event to Clipboard. Then use Import Event From Clipboard in the Add Exclusion dialog.
To manually exclude the event:
- Select the event Source from the pull-down.
- Select Specific Event ID and enter the desired ID. All Event Ids could also be used to obtain all events from a specified event Source.
- Select OK when finished adding the new exclusion.
Cisco Unified Presence
Configure Syslog Receiver
To successfully receive Cisco Unified Presence syslog messages, you must add the syslog receiver from the device’s serviceability web page. To configure syslog receiver on Cisco Unified Presence:
- On your Cisco Unified Communications Manager IM and Presence, select Cisco Unified IM and Presence Serviceability from the Navigation drop-down in the
top-right corner of the device’s home screen. - Choose Alarm > Configurations.
- Select the correct alarm configuration elements (Server, Service Group, and Service) for your particular machine and then click Go. For example:
- Enter the Prime Collaboration Assurance server name/address in Server text box.
- Select CUP Services in the Service Group.
- For Remote Syslogs, select Enable Alarms and set the Alarm Event Level to Informational.
- Click Save to save the configuration to complete syslog configuration.
Media Servers
Configure a Media Server’s SNMP Services Community String Rights
Use this procedure on media servers running voice application software. Prime Collaboration Assurance installation ensures that the SNMP service is installed and enabled on that server.
Prime Collaboration Assurance cannot monitor supported voice applications running on a media server if community string rights for SNMP services are set to none. The SNMP queries will not succeed unless the rights for the community string are changed to read-only, read-write, or read-create.
To set a media server’s SNMP services community string right:
- On the media server system, choose Start > Settings > Control Panel > Administrative Tools > Services.
The Services window appears. - Double-click SNMP Service.
The SNMP Services Properties window appears. - Select the Security tab.
- Select Community String and click Edit.
- Change the rights from NONE to READ ONLY.
Prime Collaboration Assurance requires read-only rights. You are not required to set the rights to read-write or read-create.
Cisco TelePresence Video Communication Server
Cisco VCS serves as a call-control appliance for the Cisco TelePresence C Series, E Series, and other similar video endpoints.
Enable HTTP
You can access Cisco VCS through a web browser: http://<vcs_serveraddress>, where <vcs_serveraddress> is the IP address or hostname of your VCS appliance. The default password for administrator user admin is TANDBERG. If you cannot log in to the web GUI, Cisco Prime Collaboration will not be able to successfully manage the VCS. Ensure the password field is not blank as it is not recommended.
Enable SNMP
You can easily enable SNMP from the Cisco VCS web GUI: Choose System > SNMP and enter the SNMP information.
Configuring Endpoints
Cisco TelePresence System Video Endpoints
Enable HTTP
You can access Cisco TelePresence system video endpoints through a web browser (preferably using Internet Explorer, if possible) by pointing the browser to:https://<serveraddress> where <serveraddress> is the IP address or hostname of the Cisco TelePresence system video endpoint.
Enable SNMP
SNMP for Cisco TelePresence system devices is configured using Cisco Unified Communications Manager phone configuration. To change the SNMP community string:
- Launch Cisco Unified Communications Manager Administration.
- Choose Device > Phone and search for Cisco TelePresence system endpoints.
- Click the Device Name link to go to the phone configuration page.
- Edit the SNMP Configuration Parameters.
- Click Save and Apply Config.
Enable CLI Access
SSH access to the Cisco TelePresence system devices is also controlled through Cisco Unified Communications Manager Phone Configuration.
Note: If the value of SSH admin Life and SSH helpdesk Life field is zero, the password never expires (recommended for lab testing scenarios). However, if the value is not zero, the admin must ensure that passwords are changed before the specified interval, for anyone or any application to be able to perform SSH in the device including Cisco Prime Collaboration.
Endpoint monitoring is based on the SNMP polling. You can configure traps and syslogs on the endpoints, if required.
To monitor traps and syslogs:
- Configure trap and syslog receivers for endpoints in call processors.
- Enter the Prime Collaboration IP address to configure the trap receiver: <PrimeCollaboration_ip_addr>
- Enter the Prime Collaboration IP address and port number 20514 to configure syslog receiver.: <PrimeCollaboration_ip_addr>:20514.
- Enable endpoints to send traps and syslogs.
To enable traps:
- In CISCO-TELEPRESENCE-MIB, set ctpPeripheralErrorNotifyEnable to true (1)
- In CISCO-TELEPRESENCE-CALL-MIB, set ctpcStatNotifyEnable to true (1)
- In CISCO-TELEPRESENCE-CALL-MIB, set threshold values for call stats ctpcStatMonitoredEntry
To enable syslogs: In CISCO-SYSLOG-MIB, set clogNotificationsEnabled to true (1).
Cisco TelePresence C and EX Series Video Endpoints
Enable HTTP
By default, HTTP is enabled for Cisco TelePresence Endpoints. Point the web browser to http://<ip_address>, where <ip_address> is the IP address or hostname of the video endpoint. The default password for the administrator user admin is " ", blank space.
Enable SNMP
To enable SNMP access for Cisco Prime Collaboration from the web interface:
Choose Configuration > Adv Configuration > Network Services > SNMP and click the value to edit.
Enable CLI Access
SSH must be enabled by default on TC 4.0 releases. Provide admin user access to Cisco Prime Collaboration ensure that the admin password is set and is not the default value, which is blank. Admin user access is necessary if you want to troubleshoot video sessions from Cisco TelePresence devices using Cisco Prime Collaboration. Some of the commands required to run the traceroutes are available only when you log in as root.
We recommend that you enter the real interface IP address of the gateway that runs the Hot Standby Router Protocol (HSRP), instead of the virtual IP address, while configuring the CTS. This enables Prime Collaborationto accurately discover the troubleshooting path.
Configuring Call Management Applications
Cisco TelePresence Management Suite
HTTP and SNMP access are required to successfully monitor Cisco TMS.
Enable HTTP
Cisco TMS is accessed through a web browser (http://<serveraddress>/TMS), where <serveraddress> is the IP address or hostname of your server. The default password for the administrator user admin is TANDBERG.
If you cannot log in to the web GUI, Cisco Prime Collaboration will not be able to successfully monitor Cisco TMS.
Enable SNMP
By default, public and Public are enabled as SNMP Read Only (RO) community strings for Cisco TMS. This string is used by Cisco TMS to poll other devices.
If you need to add or change these strings:
Go to the web GUI and choose Administrative Tools > Configuration > Network Settings and change the SNMP settings.
In addition to the Web GUI, SNMP service on the Cisco TMS server must be enabled.
To enable SNMP:
- Go to Start on the server console.
- Click Run and specify services.msc.
A Service window will pop open on the server console. - Right-click SNMP Service and select Properties.
- Click Security and select Add new SNMP string.
Do not modify the default selection: Accept SNMP packets from any host unless you want only specific hosts polling SNMP from Cisco TMS. - Optionally, click Traps to add the IP address of Cisco Prime Collaboration and a community string. This address is used in SNMP traps.
- Optionally, click Agent to specify SNMP contact and location for Cisco TMS. The Cisco Prime Collaboration uses this information to display the location of Cisco TMS in the inventory.
- Restart the SNMP Service after the necessary modifications.
Configure Reporting API in Cisco CTS-Manager
For Prime Collaboration server to retrieve scheduled meetings from from CTS-Manager, you must have a valid Metrics Dashboard and Reporting API license in CTS-Manager. This user account should be configured in Active Directory with a mailbox and in a user group with general security. The Active Directory user group should be assigned the Reporting API role and the Live Desk role in the CTS-Manager Access Management page.
Note: We recommend that you review the Getting Started With TelePresence Reporting API document available at [http://developer.cisco.com/web/tra/start] for an understanding of the Reporting API.
Note: The procedures described below are applicable for CTS-Manager 1.8. If you are using any other supported versions, see the CTS-Manager Reporting API related documents.
To enable Prime Collaboration server to retrieve scheduled meetings from from CTS-Manager 1.8:
- In the LDAP server, create a user group. For example,create a group named pc_group.
- In the group that you created in the LDAP server, create a user. For example, create a user named pc_user.
You must ensure that a valid mailbox is configured for the user created in the group in the LDAP server. - In CTS-Manager, in the Access Management page, assign the Live Desk role and the Reporting API User role for the group you created in the LDAP server, for example, pc_group created in Step 1.
- Discover the CTS-Manager in Prime Collaboration with the user that you created in the LDAP server. For example, use pc_user.
For more information about the Reporting API, see Cisco Telepresense Manager Reporting API Developer's Guide for Release 1.8.
For more information about user and group configuration in LDAP server, see Cisco Telepresense Manager 1.8 Administration and Installation Guide.
Note: After creating the user account in CTS-Manager for the Prime Collaboration application, we recommend that you log in with this account in CTS-Manager at least once before you enter the credentials in the Prime Collaboration server.
Configure Third Party Booking API User in Cisco TMS
For the Prime Collaboration server to retrieve scheduled meetings from Cisco TMS server, you must have one Application Integration License for each server that uses the API.
Note: *We recommend that you review the Cisco TMS Third Party Booking API document available at [http://www.tandberg.com/support/tms_documentation.jsp] for an understanding of the Booking API. *For Cisco TMS 13.2 and later, any HTTP user can be used to retrieve scheduled meetings from Cisco TMS server. In addition, you do not need to install a Booking API License to use the API.
To enable Prime Collaboration server to retrieve scheduled meetings from Cisco TMS:
- From the Cisco TMS server, go to http://localhost/tms/external/booking/remotesetup/remotesetupservice.asmx.
The RemoteSetupService page appears. You may replace localhost in the above URL with the IP address of the Cisco TMS server. - Choose GenerateConferenceAPIUser.
- Enter the values for the following parameters:
- userNameBase - The base portion of the user name. For example, pc_user.
- encPassword - A base64 encoded password that is to be used for the newly created user. To encode the password to base64, we recommend
that you use the web utility available at the following URL: http://www.motobit.com/util/base64-decoder-encoder.asp. - emailAddress - The email address of the user. Do not enter values in this field.
- sendNotifications - To allow the user to receive scheduling notifications. You must enter False in this field since Prime Collaboration
will be polling from Cisco TMS.
- Click Invoke.
- In the Cisco TMS application, verify the user name configured in Step 3is listed in the Users page.
- In the Cisco TMS application, create a user group. For example, create a group named pc_group.
- Add the user created in Step 3 to the group created in Step 6. For example, add pc_user to pc_group.
- In the Groups page, for the group created in Step 6, check the Read permission check box for List Conferences-All (under the Booking pane). For example, pc_group must have the read permission to List Conferences-All.
- Discover the Cisco TMS in Cisco Prime Collaboration with the user that you created in Step 3. For example, use pc_user.
For more information about the Cisco TMS, see the documents available at TANDBERG site.
For more information on creating groups and setting permission to the group, see Ciso Telepresence Management Suite Administrator Guide.
Configuring MCUs
A Cisco TelePresence MCU MSE 8510 (MCU MSE 8510) cluster consists of a Cisco TelePresence MCU MSE 8050 Supervisor Blade (MCU MSE 8550) and a MCU MSE 8510 blade. After the basic information is configured, HTTP access is enabled by default.
Enable HTTP
The supervisor web interface can be accessed by pointing the browser to http://<MCU_Address>, where <MCU_Address> is the IP address or hostname of your server. The default password for the admin user is a blank space (no password). If you cannot log in to the web GUI, Cisco Prime Collaboration will not be able to successfully manage the MCU MSE Supervisor.
To log in to the web interface of the MCU MSE 8510 blade:
- Log in to the supervisor web interface.
- Choose Hardware > Blades and click the IP address of the MCU MSE 8510 blade.
- Click Log in, and enter the username admin with no password.
Enable SNMP
You can edit SNMP settings by logging in to the MCU Codian Web Interface:
- Choose Network > SNMP.
- Edit the SNMP Read Only and Read Write strings as required.
- Click Update SNMP Settings to apply the changes.
Configuring Cisco TelePresence Multipoint Switch
Enable HTTP
A separate HTTP user account must be created with the Meeting Scheduler and Diagnostic Technician roles assigned to it for the Prime Collaboration application. This user can be configured in the Multipoint Switch web user interface when logged in as admin. After the dedicated HTTP user has been created, you must login to CTMS web UI using this user credential and then change the password (the same password can be entered).
An admin user is not required by Cisco Prime Collaboration to manage the Multipoint Switch.
You can access the Multipoint Switch through a web browser (preferably using Internet Explorer) by pointing the browser to: https://<ctms_serveraddress>, where <ctms_serveraddress> is the IP address or hostname of the Multipoint Switch.
Enable SNMP
SNMP is enabled by default and it monitors the Multipoint Switch system status (navigate to Troubleshoot > System Resources for system status details). You can designate a particular server where SNMP trap messages are gathered and stored. You configure all SNMP settings through the Multipoint Switch CLI commands.
The following SNMP settings are enabled by default:
- SNMPv3 username set to mrtg: This name is for internal use of the system and should not be deleted.
- SNMPv2c username set to public: This name is for internal use of the system and should not be deleted.
- No trap receiver is configured. Use Multipoint Switch CLI commands to configure SNMP trap receiver information.
Use SSH in the Multipoint Switch to configure SNMP using the CLI. The CLI commands to configure SNMP Read Only and Read/Write are as follows:
- set snmp user add 2c snmpro r
- set snmp user add 2c snmprw rw
Note: Replace snmpro and snmprw with your SNMP Read and Read/Write community strings. After creating the user account in CTMS for the Prime Collaboration application, we recommend that you log in with this account in CTMS at least once before you enter the credentials in the Prime Collaboration server.
Configuring Cisco Network Analysis Module
Enable http or https Server and Configure a Web Administrator User
To access a NAM, the NAM must be configured as an http or http secure (https) server and you must configure an http or https port. The first time that you enable an http or https server on NAM, you are prompted for a web administrator username and password. The username and password of a web administrator user must be entered into Prime Collaboration Assurance.
To configure NAM as an http server, from the command line on the NAM, enter this command:
ip http server {enable | disable}
To configure NAM as an https server, from the command line on the NAM, enter this command:
ip http secure server {enable | disable}
If this is the first time that NAM has been configured as an http or https server, you are prompted for a web Administrator username and password as shown in the following example.
ip http server enable Enabling HTTP server... No web users are configured. Please enter a web administrator user name [admin]: New password: Confirm password: User admin added. Successfully enabled HTTP server.
Note the username and password; you must enter it in Prime Collaboration Assurance.
To configure the http or https port, use the appropriate one of these commands:
ip http port <port number> ip http secure port <port number>
For complete instructions, including how to reset the web administrator password, see the installation and configuration guide or note for the particular NAM hardware.
Enable RTP Stream Monitoring
Ensure that RTP stream monitoring is enabled on each NAM that you add to Prime Collaboration Assurance.
- Log into NAM using the web interface.
- Choose Setup > Monitor. The Core Monitoring Functions table displays.
- Click RTP Stream Monitoring. The RTP Stream Setup window appears.
- Click the Monitoring Enabled check box.
- Click Apply.
For more information, see User Guide for the Cisco Network Analysis Module Traffic Analyzer.
Configure NAM to Use the NTP Server
To correlate information from sensors and Unified Communications Managers, timing is very important. Therefore:
- Prime Collaboration Assurance must be configured to use the NTP server that Unified Communications Manager uses.
- Cisco strongly recommends that you also configure each NAM to use the same NTP server that Prime Collaboration Assurance uses.
- Log into NAM using the web interface.
- Choose Admin > System > NAM System Time. The NAM System Time Configuration dialog box appears.
- Select the NTP Server radio button.
- Enter the DNS name or IP address for the NTP server that Prime Collaboration Assurance uses in the first set of NTP server name and IP address text boxes.
- Select the Region and local time zone from the lists.
- Click Apply.
For more information, see User Guide for the Cisco Network Analysis Module Traffic Analyzer.
Network Devices
Configure Cisco Mediatrace, Cisco IOS IP SLA, and Performance Monitoring
If you have enabled Cisco Mediatrace on your network nodes, Prime Collaboration provides Medianet Path View as part of the troubleshooting data. If you have enabled Cisco IOS IP Service Level Agreements (SLAs) on your network nodes, you can measure the network performance and health using the Proactive Troubleshooting feature.
For Cisco Mediatrace:
- Enable the initiator and/or responder roles on relevant routers and switches using the following commands:
For Mediatrace Initiator:
mediatrace initiator source-ip <IP Address>
For Mediatrace Responder:
mediatrace responder
- Configure a Telnet local login user with privilege 15 on the initiators.
- Configure Web Services Management Agent (WSMA) over HTTP or HTTPS on the initiators. See Web Services Management Agent (WSMA) Configuration Guide for details on the configuration commands.
Local Auth Example:
username <username> priv 15 secret <username_enable_password> ip http authentication local
For WSMA (HTTP) Configuration:
ip http server ip http timeout-policy idle 60 life 86400 requests 10000 wsma agent exec profile wsma_listener_http wsma agent config profile wsma_listener_http ! wsma profile listener wsma_listener_http transport http
For WSMA (HTTPS) Configuration:
ip http secure-server wsma agent exec profile wsma_listener_https wsma agent config profile wsma_listener_https ! wsma profile listener wsma_listener_https transport https
For WSMA SSH Configuration:
crypto key generate rsa ip ssh timeout 120 ip ssh version 2 ! wsma agent exec profile wsma_listener_ssh wsma agent config profile wsma_listener_ssh ! wsma profile listener wsma_listener_ssh transport ssh
For Cisco IOS IP Service Level agreement (SLA):
- Enable the responder role using the command:
ip sla responder
- The initiator role is not required.
- Configure a Telnet local login user with privilege 15 on the IP SLA initiators.
You can verify whether these roles are enabled on the device by using Prime Collaboration Inventory (Operate > Device Work Center > Current Inventory table).
For Performance Monitoring (PM) Configuration:
Configure the Performance Monitor policy on the relevant interfaces. Prime Collaboration collects PM flow statistics through MIBs. If this is configured, Prime Collaboration does not require the CLI access to routers.
Supported Software Versions for the Cisco Medianet Feature
Platform | Minimum IOS Release | Minimum Package | Feature Support |
Catalyst 3560 | 15.0(1)SE2 | IP Base | Mediatrace, Performance Monitor, IPSLA-VO |
Catalyst 3750 | 15.0(1)SE2 | IP Base | Mediatrace, Performance Monitor, IPSLA-VO |
Catalyst 4500E Supervisor 7-E/7L-E | XE 3.3.0SG | IP Base | Mediatrace, Performance Monitor, IPSLA-VO |
Catalyst 4500E Supervisor 6-E/6L-E | 15.1(1)SG | IP Base | Mediatrace, Performance Monitor, IPSLA-VO |
Catalyst 6500 Supervisor 2T | 15.0(1)SY | IP Services | Mediatrace, Performance Monitor |
ISR 2900 and 3900 | 15.1(3)T | UC and Data | Mediatrace, Performance Monitor |
| 15.2(2)T | UC and DSP | IPSLA-VO Sender |
| 15.2(2)T | IP Base | IPSLA-VO Responder |
ISR 1900 | 15.1(3)T | UC and Data | Mediatrace, Performance Monitor |
| 15.2(2)T | IP Base | IPSLA-VO Responder |
ISR 880 and 890 | 15.1(3)T | Universal | Mediatrace, Performance Monitor |
ASR 1000 | XE 3.5 | IP Base | Performance Monitor |
Enable Cisco IOS Devices to Send SNMP Traps
For devices running Cisco IOS software, provide the following commands:
(config)# snmp-server [community string] ro (config)# snmp-server enable traps (config)# snmp-server host [trap receiving host ip address] traps [community string]
Where [community string] indicates an SNMP read-only community string and [trap receiving host ip address] indicates the SNMP trap receiving host (the Prime Collaboration server). For more information, see the appropriate command reference guide.
Enable Catalyst Devices to Send SNMP Traps
For devices running Catalyst software, provide the following commands:
(enable)# set snmp community read-only [community string] (enable)# set snmp trap enable all (enable)# set snmp trap [trap receiving host ip address] [community string]
Where [community string] indicates an SNMP read-only community string and [trap receiving host ip address] indicates the SNMP trap receiving host (the Prime Collaboration server).