Setting up Devices for Prime Collaboration Assurance

From DocWiki

(Difference between revisions)
Jump to: navigation, search
(Required Protocols for the Devices (Includes Supported Software Versions))
m (Disable the the GetTransactionSince Cisco TMS API)
(20 intermediate revisions not shown)
Line 1: Line 1:
This section describes how to configure devices on the network before you manage them in Cisco Prime Collaboration Assurance.  
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)<br> =
+
= Required Protocols for the Devices (Includes Supported Software Versions)<br> =
You must configure the endpoints, application managers, call processors, multipoint switches, and network devices with the following protocols:  
You must configure the endpoints, application managers, call processors, multipoint switches, and network devices with the following protocols:  
Line 11: Line 11:
*CDP - Discover neighboring devices.
*CDP - Discover neighboring devices.
-
<br>
+
'''Note''': For supported software versions, see&nbsp;[http://docwiki.cisco.com/wiki/Supported_Devices_for_Cisco_Prime_Collaboration_Assurance_9.5 Supported Devices for Cisco Prime Collaboration Assurance]. <br>  
{| border="1" cellspacing="1" cellpadding="1" width="1000"
{| border="1" cellspacing="1" cellpadding="1" width="1000"
|-
|-
-
| '''Device'''<br>
+
| '''Device'''<br>  
-
| '''Supported Software'''<br>
+
| '''SNMP'''<br>  
-
| '''SNMP'''<br>
+
| '''HTTP'''<br>  
-
| '''HTTP'''<br>
+
| '''CLI'''<br>  
-
| '''CLI'''<br>
+
| '''JTAPI'''<br>  
-
| '''JTAPI'''<br>
+
| '''MSI'''<br>  
-
| '''MSI'''<br>
+
| '''CDP'''<br>  
-
| '''CDP'''<br>
+
| '''Notes'''<br>
| '''Notes'''<br>
|-
|-
-
| Analog Gateway<br>
+
| Analog Gateway<br>  
-
| -<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Contact Center Enterprise<br>
+
| Contact Center Enterprise<br>  
-
| 7.0 - 9.0<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Contact Center Express<br>
+
| Contact Center Express<br>  
-
| 4.6 - 9.0<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Cisco TelePresence Multipoint Switch<br>
+
| Cisco TelePresence Multipoint Switch<br>  
-
| 1.7 – 1.9<br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| The HTTP user account must have both the Meeting Manager and Diagnostic Technician roles.<br>
| The HTTP user account must have both the Meeting Manager and Diagnostic Technician roles.<br>
|-
|-
-
| Cisco TelePresence System (CTS) <br>
+
| Cisco TelePresence System (CTS) <br>  
-
| 1.7 – 1.9<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| Yes<br>  
-
| Yes<br>
+
| -  
| -  
-
| <br>
+
| <br>  
-
| -<br>
+
| -<br>  
|  
|  
*CLI access is required if you want to use the Troubelshooting feature in Prime Collaboration. HTTP access is not required.  
*CLI access is required if you want to use the Troubelshooting feature in Prime Collaboration. HTTP access is not required.  
Line 78: Line 72:
|-
|-
-
| Cisco TelePresence Manager (CTS-Manager)<br>
+
| Cisco TelePresence Manager (CTS-Manager)<br>  
-
| 1.7 – 1.9<br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
|  
|  
*Requires the Reporting API license and the Reporting API role for the Prime Collaboration user.  
*Requires the Reporting API license and the Reporting API role for the Prime Collaboration user.  
-
*The HTTP user needs to be an exchange mailbox user and its User Group must have Reporting API and Live Desk roles in CTS-Manager.<br>
+
*The HTTP user needs to be an exchange mailbox user and its User Group must have Reporting API and Live Desk roles in CTS-Manager.<br>  
*If you have installed a licensed version of Prime Collaboration, it is mandatory to configure the CTS-Manager Reporting API. If this feature is not configured on the CTS-Manager 1.7, 1.8, or 1.9, Prime Collaboration will not manage the CTS-Manager.<br>
*If you have installed a licensed version of Prime Collaboration, it is mandatory to configure the CTS-Manager Reporting API. If this feature is not configured on the CTS-Manager 1.7, 1.8, or 1.9, Prime Collaboration will not manage the CTS-Manager.<br>
|-
|-
-
| Cisco Unified CM<br>
+
| Cisco Unified CM<br>  
-
| 7.1 – 9.1(1)<br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
|  
|  
*Prime Collaboration supports Cisco Unified CM clusters. You must ensure that the cluster IDs are unique. To verify the cluster ID go to the Enterprise Parameteres Configuration page (System &gt; Enterprise Parameters) on Cisco Unified CM publisher (for every cluster).  
*Prime Collaboration supports Cisco Unified CM clusters. You must ensure that the cluster IDs are unique. To verify the cluster ID go to the Enterprise Parameteres Configuration page (System &gt; Enterprise Parameters) on Cisco Unified CM publisher (for every cluster).  
Line 107: Line 99:
|-
|-
-
| Cisco Unified Communications Manager Business Edition<br>
+
| Cisco Unified Communications Manager Business Edition<br>  
-
| 7.1 – 9.0<br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Customer Voice Portal<br>
+
| Customer Voice Portal<br>  
-
| 4.0 - 8.5<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
Line 135: Line 125:
*Cisco TX 9000 series<br>
*Cisco TX 9000 series<br>
 +
| Yes<br>
 +
| Yes<br>
 +
| Yes<br>
 +
| -<br>
 +
| Yes<br>
 +
| -<br>
|  
|  
-
*EX series: <br>TC 4.2 - 6.0; TE 6.0<br>
+
*The HTTP user requires Admin privilege.<br>  
-
*C, MX, and SX series: <br>TC 4.2 - 6.0<br>
+
*For TC 6.0 and TE 6.0, use the same HTTP credentials for MSI.<br>  
-
*TX series: TX 6.0<br>
+
-
 
+
-
| Yes<br>
+
-
| Yes<br>
+
-
| Yes<br>
+
-
| -<br>
+
-
| Yes<br>
+
-
| -<br>
+
-
|
+
-
*The HTTP user requires Admin privilege.<br>
+
-
*For TC 6.0 and TE 6.0, use the same HTTP credentials for MSI.<br>
+
*For TX 6.0, use the default credentials msiuser and cisco for MSI.<br>
*For TX 6.0, use the default credentials msiuser and cisco for MSI.<br>
|-
|-
-
| Cisco IP Video Phone E20<br>
+
| Cisco IP Video Phone E20<br>  
-
| TE 4.0 - 6.0 <br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
|  
|  
*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.  
*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.  
Line 165: Line 149:
|-
|-
-
| Emergency Responder<br>
+
| Emergency Responder<br>  
-
| 1.0 - 9.0<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Expert Advisor<br>
+
| Expert Advisor<br>  
-
| 7.2 - 7.6<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Finesse<br>
+
| Finesse<br>  
-
| 8.0 - 9.0<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Cisco MCU <br>
+
| Cisco MCU <br>  
-
| 4.1 – 4.3<br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
|  
|  
-
*The HTTP user requires Admin privilege.<br>
+
*The HTTP user requires Admin privilege.<br>  
*This device also include the MSE8000 blade form factors: MSE-8420, MSE-8510, and MSE-8710.<br>
*This device also include the MSE8000 blade form factors: MSE-8420, MSE-8510, and MSE-8710.<br>
|-
|-
-
| Cisco TelePresence MSE Supervisor <br>
+
| Cisco TelePresence MSE Supervisor <br>  
-
| 2.1 – 2.2<br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| The HTTP user requires Admin privilege.<br>
| The HTTP user requires Admin privilege.<br>
|-
|-
-
| Mediasense<br>
+
| Mediasense<br>  
-
| 8.0 - 9.0<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Meeting Place<br>
+
| Meeting Place<br>  
-
| 7.0 - 8.5<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Meeting Place Express<br>
+
| Meeting Place Express<br>  
-
| 2.0 - 2.1<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Personal Assistant<br>
+
| Personal Assistant<br>  
-
| 1.3 -1.4<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Cisco TelePresence System MXP series<br>
+
| Cisco TelePresence System MXP series<br>  
-
| 9.1<br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| <br>  
-
| <br>
+
| <br>  
-
| <br>
+
| <br>  
-
| <br>
+
| <br>
| <br>
|-
|-
-
| Polycom VSX series<br>Polycom HDX series<br>
+
| Polycom VSX series<br>Polycom HDX series<br>  
-
| 2.5 - 3.0<br>(for HDX series)<br>9.0<br>(for VSX series)<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| 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.<br>
| 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.<br>
|-
|-
-
| Cisco Unified Presence <br>
+
| Cisco Unified Presence <br>  
-
| 8.0 - 9.1 <br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
-
|Cisco Unified Presence 9.1 is supported through [http://software.cisco.com/download/type.html?mdfid=284259889&flowid=36842 ''Cisco Prime Collaboration Assurance 9.0 patch 2''].
+
|-
|-
-
| Network devices (routers and switches) <br>
+
| Network devices (routers and switches) <br>  
-
| <br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| Yes<br>  
-
| Yes<br>
+
|  
|  
-
*CDP needs to be enabled for the video Troubleshooting workflow. The Telnet or SSH access is required for Cisco Medianet features, which is part if the video Troubleshooting workflow.<br>
+
*CDP needs to be enabled for the video Troubleshooting workflow. The Telnet or SSH access is required for Cisco Medianet features, which is part if the video Troubleshooting workflow.<br>  
*See the table ''Supported Software Versions for the Cisco Medianet'' Feature below to view the troubleshooting medianet-related data.<br>
*See the table ''Supported Software Versions for the Cisco Medianet'' Feature below to view the troubleshooting medianet-related data.<br>
|-
|-
-
| Cisco TelePresence Management Suite (Cisco TMS)<br>
+
| Cisco TelePresence Management Suite (Cisco TMS)<br>  
-
| 13.0 – 13.2<br><br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
|  
|  
-
*Requires Booking API license (TMS software version 13.1 or below).<br>
+
*Requires Booking API license (TMS software version 13.1 or below).<br>  
-
*The HTTP user for Prime Collaboration needs to be generated through the Booking API on the Cisco TMS windows server. <br>
+
*The HTTP user for Prime Collaboration needs to be generated through the Booking API on the Cisco TMS windows server. <br>  
*Prime Collaboration supports only the default e-mail template for the Booking Confirm e-mail in Cisco TMS. The session import feature will not work, if the default e-mail template is not used. <br>
*Prime Collaboration supports only the default e-mail template for the Booking Confirm e-mail in Cisco TMS. The session import feature will not work, if the default e-mail template is not used. <br>
|-
|-
-
| Cisco Telepresence Server<br>
+
| Cisco Telepresence Server<br>  
-
| 2.1 – 2.2<br>
+
| -<br>  
-
| -<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
|  
|  
*The HTTP user account should have the API Access privilege.  
*The HTTP user account should have the API Access privilege.  
Line 328: Line 297:
|-
|-
-
| Cisco Telepresence Conductor<br>
+
| Cisco Telepresence Conductor<br>  
-
| 1.1 - 1.2<br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
| Cisco Unity  
| Cisco Unity  
-
| 7.0 - 8.6
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
| Cisco Unity Connection  
| Cisco Unity Connection  
-
| 7.0 - 9.1
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
-
| Cisco Unified Connection 9.1 is supported through [http://software.cisco.com/download/type.html?mdfid=284259889&flowid=36842 ''Cisco Prime Collaboration Assurance 9.0 patch 2''].
+
|-
|-
| Cisco Unity Express  
| Cisco Unity Express  
-
| 7.0 - 9.0
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Cisco TelePresence Video Communication Server (Control and Expressway)<br>
+
| Cisco TelePresence Video Communication Server (Control and Expressway)<br>  
-
| 6.0 – 7.1<br>
+
| Yes<br>  
-
| Yes<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| The HTTP user requires Admin privilege.<br>
| The HTTP user requires Admin privilege.<br>
|-
|-
-
| Wireless<br>
+
| Wireless<br>  
-
| -<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Third party devices<br>
+
| Third party devices<br>  
-
| -<br>
+
| Yes<br>  
-
| Yes<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|-
|-
-
| Cisco Jabber Video for Telepresence (Movi)<br>
+
| Cisco Jabber Video for Telepresence (Movi)<br>  
-
| all software versions.<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
|  
|  
*The Cisco Jabber endpoints are discovered either through Cisco Unified CM or Cisco VCS (access credentials are not required).  
*The Cisco Jabber endpoints are discovered either through Cisco Unified CM or Cisco VCS (access credentials are not required).  
Line 411: Line 372:
|-
|-
-
| Cisco Cius<br>
+
| Cisco Cius<br>  
-
| all software versions.<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
|  
|  
-
*The Cisco Cius endpoints are discovered either through Cisco Unified CM or Cisco VCS (access credentials are not required). You must enable web access in Cisco Unified CM for these.<br>
+
*The Cisco Cius endpoints are discovered either through Cisco Unified CM or Cisco VCS (access credentials are not required). You must enable web access in Cisco Unified CM for these.<br>  
-
*Credentials are not required for HTTP access.<br>
+
*Credentials are not required for HTTP access.<br>  
*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.<br>
*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.<br>
|-
|-
-
| Cisco IP phones (89xx, 99xx)<br>
+
| Cisco IP phones (89xx, 99xx)<br>  
-
| all software versions.<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
|  
|  
-
*The Cisco IP Phones endpoints are discovered through Cisco Unified CM. You must enable web access in Cisco Unified CM for these.<br>
+
*The Cisco IP Phones endpoints are discovered through Cisco Unified CM. You must enable web access in Cisco Unified CM for these.<br>  
-
*These video phones require Cisco Unified CM application user to have the additional role ''Standard CTI Allow Control of Phones supporting Connected Xfer and conf''. <br>
+
*These video phones require Cisco Unified CM application user to have the additional role ''Standard CTI Allow Control of Phones supporting Connected Xfer and conf''. <br>  
-
*Credentials are not required for HTTP access.<br>
+
*Credentials are not required for HTTP access.<br>  
*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.<br>
*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.<br>
|-
|-
-
| Border Element, Gatekeeper, H323 Gateway, SIP Gateway MGCP Gateway, SRST Device, Voice Gateway<br>
+
| Border Element, Gatekeeper, H323 Gateway, SIP Gateway MGCP Gateway, SRST Device, Voice Gateway<br>  
-
| IOS 12.x or later<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| -<br>  
-
| -<br>
+
| <br>
| <br>
|}
|}
Line 459: Line 417:
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.  
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 [http://www.cisco.com/en/US/products/sw/voicesw/ps556/tsd_products_support_series_home.html ''Cisco Unified CM guides''] to understand how to create groups, users and assign roles to them.<br>
+
'''Note: The procedures described below are applicable for Cisco Unified CM 8.5. If you are using any other supported versions, see the [http://www.cisco.com/en/US/products/sw/voicesw/ps556/tsd_products_support_series_home.html ''Cisco Unified CM guides''] to understand how to create groups, users and assign roles to them.'''<br>
-
'''Enable HTTP'''  
+
=== '''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.  
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.  
Line 467: Line 425:
To create a user:  
To create a user:  
-
#Create a user group with sufficient privileges. Log in to the Cisco Unified Communications Manager Administration web interface using the administrator role.  
+
#Create a user group with sufficient privileges. Log in to the Cisco Unified CM Administration web interface using the administrator role.  
-
#Navigate to '''User Management''' &gt; '''User Groups''' and create a new group with a suitable name, PC_HTTP_Users in this case.  
+
#Choose&nbsp;'''User Management''' &gt; '''User Group''' and create a new group with a suitable name, PC_HTTP_Users in this case.  
#Click '''Role'''.  
#Click '''Role'''.  
#Click '''Assign Role to Group''' and select the following roles:  
#Click '''Assign Role to Group''' and select the following roles:  
Line 475: Line 433:
#*Standard SERVICEABILITY Administration
#*Standard SERVICEABILITY Administration
#Click '''Save'''.  
#Click '''Save'''.  
-
#From the main menu, navigate to '''User Management''' &gt; '''Application Users''' &gt; '''Create a new user'''. <br>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.  
+
#From the main menu, choose '''User Management''' &gt; '''Application Users''' &gt; '''Create a new user'''. <br>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. (PC_HTTP_Users, for instance).  
+
#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.
#Click '''Save'''. The page is refreshed and the right privileges are displayed.
-
'''Enable SNMP'''  
+
=== '''Enable SNMP''' ===
SNMP is not enabled in Cisco Unified Communications Manager by default.  
SNMP is not enabled in Cisco Unified Communications Manager by default.  
Line 486: Line 444:
#Log in to the '''Cisco Unified Serviceability''' view in the Cisco Unified Communications Manager web GUI.  
#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, navigate to SNMP &gt; v1/v2c &gt; community string.  
+
#From the main menu in the Cisco Unified Serviceability view, choose '''SNMP &gt; v1/v2c &gt; Community String'''.  
#Select a Server and click '''Find'''. <br>If the community string is already defined, the Community String Name is displayed in the Search Results.  
#Select a Server and click '''Find'''. <br>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.  
#Click '''Add new '''to add a new string if no results are displayed.  
-
#Specify the required SNMP information and save the configuration.
+
#Specify the required SNMP information and save the configuration.
 +
#Also make sure the Call Manager SNMP Service is running.
-
'''Enable JTAPI'''  
+
=== '''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.  
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.  
Line 497: Line 456:
To create a new JTAPI&nbsp;user:  
To create a new JTAPI&nbsp;user:  
-
#Log in to the Cisco Unified Communications Manager administration web interface using administrator role.  
+
#Log in to the Cisco Unified&nbsp;CM Administration web interface using administrator role.  
-
#Navigate to User Management &gt; '''User Groups''' and create a new group with a suitable name, '''PC_HTTP_Users''' in this case.  
+
#Choose&nbsp;'''User Management '''&gt; '''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.  
#Move all endpoint devices (for example, Cisco TelePresence codecs) to the Controlled Devices table.  
#Click '''Roles'''.  
#Click '''Roles'''.  
Line 506: Line 465:
#*Standard CTI Allow Control of Phones supporting Connected Xfer and conf
#*Standard CTI Allow Control of Phones supporting Connected Xfer and conf
#Click '''Save'''.  
#Click '''Save'''.  
-
#From the main menu, navigate to '''User Management''' &gt; '''Application Users''' &gt; '''Create a new user'''. <br>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. <br>'''Note''': The password must not contain a semicolon (;) or equals (=).  
+
#From the main menu, choose '''User Management''' &gt; '''Application Users''' &gt; '''Create a new user'''. <br>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. <br>'''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. (PC_HTTP_Users, for instance).  
+
#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.
#Click '''Save'''. The page is refreshed and the right privileges are displayed.
<pre>Note:
<pre>Note:
Line 517: 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://&lt;primecollaboration-ip&gt;/emsam/log/Tomcat/CUCMJTAPIDiag.log
+
and for the JTAPI-related issues using https://&lt;primecollaboration-ip&gt;/emsam/log/SessionMon/CUCMJTAPIDiag.log
</pre>
</pre>
-
'''Adding Prime Collaboration to Cisco Unified Communications Manager 6.x and Later as a Billing Server'''
+
=== '''Configure CDR''' (Billing Server)  ===
-
'''Note:''' Perform this task on Cisco Unified Communications Manager version 6.x and later only. Perform this task only while Prime Collaboration is up and running.
+
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:<br>
-
#Launch Unified Communications Manager Serviceability.
+
#Log in to the Cisco Unified CM Administration web interface.
-
#Choose '''Tools > CDR Management'''.
+
#Choose '''System &gt; Service Parameters'''. The Service Parameters Configuration page appears.
-
#Scroll down to Application Billing Server Parameters and click '''Add New'''. <br> Enter the following:
+
#Set parameters for:
-
#* Host Name / IP Address - Enter the IP address of the system where Prime Collaboration is installed.  
+
#*CDR Enabled Flag by scrolling down to '''System '''and selecting '''True'''.
-
#* User Name - Enter smuser. Do not enter any username other than smuser.  
+
#*Call Diagnostics Enabled by scrolling down to '''Cluster wide Parameters '''(Device - General) and selecting '''Set to Enable Only When CDR Enabled Flag is True'''.
-
#* Password - Enter a password. The default password is smuser. <br> To change this password, change it in Prime Collaboration first. Enter the same password that you entered for smuser while configuring other settings in Prime Collaboration. 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.  
+
#To add Prime Collaboration as a billing server, you must ensure Prime Colaboration is up and running.&nbsp;
-
#* Select SFTP Protocol.
+
##Launch Cisco Unified Serviceability.  
-
#* Directory Path - Enter /home/smuser/.  
+
##Choose '''Tools &gt; CDR Management'''.  
-
#* Resend on Failure (Displayed in Cisco Unified Communications Manager 7.0 and later) - Select this check box.
+
##Scroll down to Billing Applications Server Parameters and click '''Add New'''.  
-
#Click '''Add'''.
+
##Enter the following:&nbsp;
 +
##*Host Name / IP Address—Enter the IP address of the system where Prime Collaboration Assurance is installed.  
 +
##*User Name—Enter ''smuser''.<br>'''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.<br>'''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/''.<br>'''Note:''' Do not enter any directory path other than /home/smuser.  
 +
##*Resend on Failure—Select this check box.<br>
 +
##Click '''Add'''.
-
'''Changing the Password for smuser in Cisco Unified Communications Manager 6.x and Later'''
+
'''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.
-
Perform this task as needed on Cisco Unified Communications Manager versions 6.x and later only.  
+
#From Cisco Unified Serviceability, choose '''Tools &gt; 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.
-
The SFTP password for smuser in Prime Collaboration and the password for the Application Billing Server smuser in Cisco Unified Communications Manager 6.x and later must be identical. Any time you change one, you must change the other to match.
+
'''Change the Password for smuser'''
-
Use this procedure to change the password for the Application Billing Server smuser in Cisco Unified Communications Manager 6.x and later.
+
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.  
-
#Launch Unified Communications Manager Serviceability.
+
Use this procedure to change the password for the Application Billing Server smuser in Cisco Unified Communications Manager.
-
#Select '''Tools > CDR Manageability'''.
+
 
-
#Scroll down to Application Billing Server Parameters and double-click the link for Prime Collaboration. <br> 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.  
+
#Log in to the '''Cisco Unified Serviceability '''view in the Cisco Unified Communications Manager web GUI.  
 +
#Choose '''Tools &gt; CDR Management'''.  
 +
#Scroll down to Billing Application&nbsp;Server Parameters and double-click the link for Prime Collaboration. <br>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'''.
#Click '''Update'''.
-
== Cisco TelePresence Video Communication Server <br> ==
+
=== '''Activate the AXL Web Service'''  ===
 +
 
 +
Perform this procedure for Unified Communications Manager versions.
 +
 
 +
#Launch Cisco Unified Serviceability.
 +
#Choose '''Tools &gt; Service Activation'''.
 +
#Select a server.<br>'''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:&nbsp;'''Set these parameters on each Unified Communications Manager in a cluster.
 +
 
 +
#Log in to Unified&nbsp;CM Administration.
 +
#Choose '''System &gt; 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.'''<br>'''Note:&nbsp;'''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:&nbsp;'''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 &gt; Enterprise Parameters'''. The Enterprise Parameters Configuration page appears.
 +
#Select&nbsp;the Cluster ID. If the cluster ID is already present Prime Collaboration Assurance, change it.<br>'''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 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 &gt; 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.<br>'''Note:&nbsp;'''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.)<br>'''Note:&nbsp;'''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.
 +
If the license server is Enterprise License Manager:
 +
<pre>license management service activate Cisco ELM Resource API</pre>
 +
 
 +
If the license server is Prime License Manager:
 +
<pre>license management service activate Cisco Prime LM Resource API</pre>
 +
 
 +
After the configuration, the following message will be displayed:
 +
<pre>Activating <License_Server> Resource API completed successfully</pre>
 +
 
 +
=== '''Configure Syslog Receiver'''<br>  ===
 +
 
 +
To successfully receive Cisco Unified Communications Manager syslog messages, you must add the syslog receiver from the device’s serviceability web page. <br>
 +
 
 +
#On your Cisco Unified Communications Manager, select Cisco Unified Serviceability from the Navigation pull-down in the top-right corner of the device's home screen.
 +
#Choose '''Alarm &gt; Configuration'''. <br>'''Caution:&nbsp;'''Do not use the Unified CM enterprise service parameter to configure the syslog receiver for Prime Collaboration 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. <br>
 +
#Select Service Group and Service options based on the following table:
 +
#**Service Group &gt; CM Services &gt; Service &gt; Cisco CallManager
 +
#**Service Group &gt; CDR Service &gt; Cisco CDR Agent 
 +
#**Service Group &gt; CDR Service &gt; Cisco CDR Repository Manager
 +
#**Service Group &gt; Database and Admin Services &gt; Cisco Database Layer Monitoring
 +
#**Service Group &gt; Database and Admin Services &gt; Cisco License Manager
 +
#**Service Group &gt; Performance and Monitoring Services &gt; Cisco AMC Service
 +
#**Service Group &gt; Backup and Restore &gt; Cisco DRF Master
 +
#**Service Group &gt; Backup and Restore &gt; Cisco DRF Local
 +
#Click on the '''Enable Alarm''' check box, select Alarm Event Level to "Error" for all listed services except for Cisco CallManager and Cisco License Manager, which should be set to "Informational" level..
 +
#Check '''Apply to All Nodes''' and click '''Save'''.<br>'''Note:&nbsp;'''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 &gt; 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 &gt; Configurations'''.<br>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
 +
#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&nbsp;choose '''Diagnostic Tools &gt; Event Monitoring Service'''.
 +
#Double-click to run.
 +
#Create a recipient to receive notifications by selecting '''File &gt; New &gt; 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.<br>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 &gt; New &gt; Event''', or select the Monitored Events node in the navigation tree and click '''Create New Event'''.<br>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.<br>The content section allows you to record a custom WAV for the event used along with the Recipient Voicemail option.<br>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.<br>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 &gt; New &gt; 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&nbsp;and Presence, select '''Cisco Unified IM and Presence Serviceability '''from the Navigation drop-down in the <br>top-right corner of the device’s home screen.
 +
#Choose '''Alarm &gt; 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<br> ==
 +
 
 +
=== '''Configure a Media Server’s SNMP Services Community String Rights'''<br> ===
 +
 
 +
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''. <br>To set a media server’s SNMP services community string right:<br>
 +
 
 +
#On the media server system, choose '''Start &gt; Settings &gt; Control Panel &gt; Administrative Tools &gt; Services'''.<br>The Services window appears.
 +
#Double-click '''SNMP Service'''. <br>The SNMP Services Properties window appears.
 +
#Select the '''Security '''tab.
 +
#Select '''Community String''' and click '''Edit'''.
 +
#Change the rights from NONE to READ ONLY. <br>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.  
Cisco VCS serves as a call-control appliance for the Cisco TelePresence C Series, E Series, and other similar video endpoints.  
-
'''Enable HTTP'''
+
=== Enable HTTP ===
-
You can access Cisco VCS through a web browser: http://&lt;vcs_serveraddress&gt;, where &lt;vcs_serveraddress&gt; 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.  
+
You can access Cisco VCS through a web browser: http://&lt;vcs_serveraddress&gt;, where &lt;vcs_serveraddress&gt; 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'''
+
=== Enable SNMP ===
-
You can easily enable SNMP from the Cisco VCS web GUI: Navigate to '''System''' &gt; '''SNMP''' and enter the SNMP information.  
+
You can easily enable SNMP from the Cisco VCS web GUI: Choose '''System &gt; SNMP '''and enter the SNMP information. <br>
= Configuring Endpoints  =
= Configuring Endpoints  =
Line 564: Line 718:
== Cisco TelePresence System Video Endpoints  ==
== Cisco TelePresence System Video Endpoints  ==
-
'''Enable HTTP'''  
+
=== '''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://&lt;serveraddress&gt; where &lt;serveraddress&gt; is the IP address or hostname of the Cisco TelePresence system video endpoint.  
You can access Cisco TelePresence system video endpoints through a web browser (preferably using Internet Explorer, if possible) by pointing the browser to:https://&lt;serveraddress&gt; where &lt;serveraddress&gt; is the IP address or hostname of the Cisco TelePresence system video endpoint.  
-
'''Enable SNMP'''  
+
=== '''Enable SNMP''' ===
SNMP for Cisco TelePresence system devices is configured using Cisco Unified Communications Manager phone configuration. To change the SNMP community string:  
SNMP for Cisco TelePresence system devices is configured using Cisco Unified Communications Manager phone configuration. To change the SNMP community string:  
-
#Navigate to Cisco Unified Communications Manager Administration.  
+
#Launch&nbsp;Cisco Unified Communications Manager Administration.  
-
#Navigate to '''Device''' &gt; '''Phone''' and search for Cisco TelePresence system endpoints.  
+
#Choose '''Device''' &gt; '''Phone''' and search for Cisco TelePresence system endpoints.  
#Click the '''Device Name''' link to go to the phone configuration page.  
#Click the '''Device Name''' link to go to the phone configuration page.  
#Edit the SNMP Configuration Parameters.  
#Edit the SNMP Configuration Parameters.  
#Click '''Save''' '''and''' '''Apply Config'''.
#Click '''Save''' '''and''' '''Apply Config'''.
-
'''Enable CLI Access'''  
+
=== '''Enable CLI Access''' ===
SSH access to the Cisco TelePresence system devices is also controlled through Cisco Unified Communications Manager Phone Configuration.  
SSH access to the Cisco TelePresence system devices is also controlled through Cisco Unified Communications Manager Phone Configuration.  
Line 587: Line 741:
before the specified interval, for anyone or any application to be able to perform SSH  
before the specified interval, for anyone or any application to be able to perform SSH  
in the device including Cisco Prime Collaboration. </pre>
in the device including Cisco Prime Collaboration. </pre>
-
 
Endpoint monitoring is based on the SNMP polling. You can configure traps and syslogs on the endpoints, if required.  
Endpoint monitoring is based on the SNMP polling. You can configure traps and syslogs on the endpoints, if required.  
Line 607: Line 760:
== Cisco TelePresence C and EX Series Video Endpoints  ==
== Cisco TelePresence C and EX Series Video Endpoints  ==
-
'''Enable HTTP'''  
+
=== '''Enable HTTP''' ===
By default, HTTP is enabled for Cisco TelePresence Endpoints. Point the web browser to http://&lt;ip_address&gt;, where &lt;ip_address&gt; is the IP address or hostname of the video endpoint. The default password for the administrator user '''admin''' is " ", blank space.  
By default, HTTP is enabled for Cisco TelePresence Endpoints. Point the web browser to http://&lt;ip_address&gt;, where &lt;ip_address&gt; is the IP address or hostname of the video endpoint. The default password for the administrator user '''admin''' is " ", blank space.  
-
'''Enable SNMP'''  
+
=== '''Enable SNMP''' ===
To enable SNMP access for Cisco Prime Collaboration from the web interface:  
To enable SNMP access for Cisco Prime Collaboration from the web interface:  
-
Navigate to '''Configuration''' &gt; '''Adv Configuration''' &gt; '''Network Services''' &gt; '''SNMP''' and click the value to edit.  
+
Choose '''Configuration''' &gt; '''Adv Configuration''' &gt; '''Network Services''' &gt; '''SNMP''' and click the value to edit.
-
'''Enable CLI Access'''  
+
=== '''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.  
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.  
Line 629: Line 782:
HTTP and SNMP access are required to successfully monitor Cisco TMS.  
HTTP and SNMP access are required to successfully monitor Cisco TMS.  
-
'''Enable HTTP'''  
+
=== '''Enable HTTP''' ===
Cisco TMS is accessed through a web browser (http://&lt;serveraddress&gt;/TMS), where &lt;serveraddress&gt; is the IP address or hostname of your server. The default password for the administrator user '''admin''' is '''TANDBERG'''.  
Cisco TMS is accessed through a web browser (http://&lt;serveraddress&gt;/TMS), where &lt;serveraddress&gt; is the IP address or hostname of your server. The default password for the administrator user '''admin''' is '''TANDBERG'''.  
Line 635: Line 788:
If you cannot log in to the web GUI, Cisco Prime Collaboration will not be able to successfully monitor Cisco TMS.  
If you cannot log in to the web GUI, Cisco Prime Collaboration will not be able to successfully monitor Cisco TMS.  
-
'''Enable SNMP'''  
+
=== '''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.  
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.  
Line 641: Line 794:
If you need to add or change these strings:  
If you need to add or change these strings:  
-
Go to the web GUI and navigate to '''Administrative''' '''Tools''' &gt; '''Configuration''' &gt; '''Network Settings''' and change the SNMP settings.  
+
Go to the web GUI and choose '''Administrative''' '''Tools''' &gt; '''Configuration''' &gt; '''Network Settings''' and change the SNMP settings.  
In addition to the Web GUI, SNMP service on the Cisco TMS server must be enabled.  
In addition to the Web GUI, SNMP service on the Cisco TMS server must be enabled.  
Line 655: Line 808:
#Restart the '''SNMP Service '''after the necessary modifications.
#Restart the '''SNMP Service '''after the necessary modifications.
-
== Reporting API for CTS-Manager  ==
+
== 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.  
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.  
Line 678: Line 831:
that you log in with this account in CTS-Manager at least once before you enter the  
that you log in with this account in CTS-Manager at least once before you enter the  
credentials in the Prime Collaboration server.</pre>
credentials in the Prime Collaboration server.</pre>
-
== Cisco TMS Third Party Booking API User  ==
 
-
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.  
+
== Configure Third Party Booking API User in Cisco TMS ==
 +
 
 +
For the Prime Collaboration server to retrieve scheduled meetings from Cisco TMS server, you will require an Application Integration License for each server that uses the API. For details see the following note.
<pre>Note:
<pre>Note:
*We recommend that you review the Cisco TMS Third Party Booking API document available  
*We recommend that you review the Cisco TMS Third Party Booking API document available  
Line 687: Line 841:
*For Cisco TMS 13.2 and later, any HTTP user can be used to retrieve scheduled meetings  
*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
+
from Cisco TMS server.  
-
use the API.</pre>
+
*For Cisco Prime Collaboration Assurance 9.5 and later, if you want to use the frequent polling
 +
of TMS (versions 13.2 and later) feature for session monitoring, you will require a booking API
 +
license for the GetTransactionSince TMS API.</pre>
To enable Prime Collaboration server to retrieve scheduled meetings from Cisco TMS:  
To enable Prime Collaboration server to retrieve scheduled meetings from Cisco TMS:  
Line 707: Line 863:
For more information about the Cisco TMS, see the documents available at [[Www.tandberg.com/support/tms documentation.jsp|TANDBERG]] site.  
For more information about the Cisco TMS, see the documents available at [[Www.tandberg.com/support/tms documentation.jsp|TANDBERG]] site.  
-
For more information on creating groups and setting permission to the group, see ''Ciso Telepresence Management Suite Administrator Guide''.  
+
For more information on creating groups and setting permission to the group, see ''Ciso Telepresence Management Suite Administrator Guide''.
 +
== Disable the the GetTransactionSince Cisco TMS API ==
 +
To disable the GetTransactionSince TMS API (applicable for Prime Collaboration 10.0 and later) :
 +
 
 +
# Log in as a root user in the Prime Collaboration Assurance server through SSH (port 26).
 +
# Run the following command: <pre> goemsam </pre>
 +
# Go to /opt/emms/emsam/conf and open file emsam.properties
 +
# Change the value of com.cisco.nm.emms.access.tms.frequent.polling  to false.
 +
# Restart the Prime Collaboration Assurance server by running the command: <pre> bin/cpcmcontrol.sh start </pre> then the following command: <pre> bin/cpcmcontrol.sh stop </pre>
= Configuring MCUs  =
= Configuring MCUs  =
Line 713: Line 877:
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.  
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'''  
+
=== '''Enable HTTP''' ===
The supervisor web interface can be accessed by pointing the browser to http://&lt;MCU_Address&gt;, where &lt;MCU_Address&gt; is the IP address or hostname of your server. The default password for the '''admin''' user is&nbsp;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.  
The supervisor web interface can be accessed by pointing the browser to http://&lt;MCU_Address&gt;, where &lt;MCU_Address&gt; is the IP address or hostname of your server. The default password for the '''admin''' user is&nbsp;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.  
Line 720: Line 884:
#Log in to the supervisor web interface.  
#Log in to the supervisor web interface.  
-
#Go to '''Hardware''' &gt; '''Blades''' and click the IP address of the MCU MSE 8510 blade.  
+
#Choose&nbsp;'''Hardware''' &gt; '''Blades''' and click the IP address of the MCU MSE 8510 blade.  
#Click '''Log in''', and enter the username '''admin''' with no password.
#Click '''Log in''', and enter the username '''admin''' with no password.
-
'''Enable SNMP'''  
+
=== '''Enable SNMP''' ===
You can edit SNMP settings by logging in to the MCU Codian Web Interface:  
You can edit SNMP settings by logging in to the MCU Codian Web Interface:  
-
#Navigate to '''Network''' &gt; '''SNMP'''.  
+
#Choose '''Network''' &gt; '''SNMP'''.  
#Edit the SNMP Read Only and Read Write strings as required.  
#Edit the SNMP Read Only and Read Write strings as required.  
#Click '''Update SNMP Settings''' to apply the changes.
#Click '''Update SNMP Settings''' to apply the changes.
Line 733: Line 897:
= Configuring Cisco TelePresence Multipoint Switch  =
= Configuring Cisco TelePresence Multipoint Switch  =
-
'''Enable HTTP'''  
+
=== '''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).  
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).  
Line 741: Line 905:
You can access the Multipoint Switch through a web browser (preferably using Internet Explorer) by pointing the browser to: https://&lt;ctms_serveraddress&gt;, where &lt;ctms_serveraddress&gt; is the IP address or hostname of the Multipoint Switch.  
You can access the Multipoint Switch through a web browser (preferably using Internet Explorer) by pointing the browser to: https://&lt;ctms_serveraddress&gt;, where &lt;ctms_serveraddress&gt; is the IP address or hostname of the Multipoint Switch.  
-
'''Enable SNMP'''  
+
=== '''Enable SNMP''' ===
SNMP is enabled by default and it monitors the Multipoint Switch system status (navigate to Troubleshoot &gt; 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.  
SNMP is enabled by default and it monitors the Multipoint Switch system status (navigate to Troubleshoot &gt; 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.  
Line 761: Line 925:
credentials in the Prime Collaboration server.
credentials in the Prime Collaboration server.
</pre>
</pre>
-
= Configuring Cisco Mediatrace, Cisco IOS IP SLA, and Performance Monitoring for Network Devices  =
+
 
 +
= Configuring Cisco Network Analysis Module<br> =
 +
 
 +
== '''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:
 +
<pre>ip http server {enable | disable} </pre>
 +
To configure NAM as an https server, from the command line on the NAM, enter this command:
 +
<pre>ip http secure server {enable | disable}</pre>
 +
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.
 +
<pre>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.</pre>
 +
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:
 +
<pre>ip http port &lt;port number&gt;
 +
ip http secure port &lt;port number&gt;</pre>
 +
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 &gt; 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''.<br>
 +
 
 +
== '''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 &gt; System &gt; 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''.<br>
 +
 
 +
= Network Devices  =
 +
 
 +
== Configure Cisco Mediatrace, Cisco IOS IP SLA, and Performance Monitoring ==
If you have enabled [http://www.cisco.com/web/solutions/medianet/knowledgebase/index.html#~configure 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.  
If you have enabled [http://www.cisco.com/web/solutions/medianet/knowledgebase/index.html#~configure 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.  
Line 770: Line 993:
<br>
<br>
-
<pre>mediatrace initiator source-ip ''IP Address''</pre>
+
<pre>mediatrace initiator source-ip &lt;IP Address&gt;</pre>
<br>'''For Mediatrace Responder''': <br>
<br>'''For Mediatrace Responder''': <br>
Line 831: Line 1,054:
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.  
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<br> ==
+
=== Supported Software Versions for the Cisco Medianet Feature<br> ===
<br>
<br>
Line 903: Line 1,126:
|}
|}
-
<br>
+
== Enable Cisco IOS Devices to Send SNMP Traps ==
 +
 
 +
For devices running Cisco IOS software, provide the following commands:
 +
<pre>(config)# snmp-server [community string] ro
 +
(config)# snmp-server enable traps
 +
(config)# snmp-server host [trap receiving host ip address] traps [community string] </pre>
 +
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:
 +
<pre>(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]</pre>
 +
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).
 +
 
 +
= Configuring MGCP Voice Gateways to Support CVTQ =
 +
 
 +
This configuration is applicable for voice gateways running Cisco IOS 12.4(4)T or later.
 +
 
 +
TIC5510 DSP supports the DSP/KF voice quality metric that Prime Collaboration needs.
 +
For more information, see [http://www.cisco.com/en/US/docs/ios/12_4t/12_4t15/vqmetric.html ''DSP Voice Quality Metrics Guide''].
 +
 
 +
To confirm that a voice gateway has TIC5510 DSP, look for 5510 in the output of this command:
 +
 
 +
<pre>show voice dsp detailed</pre>
 +
 
 +
For more information, see [http://www.cisco.com/en/US/docs/ios/voice/command/reference/vr_book.html ''Cisco IOS Voice Command''].
 +
 
 +
To enable voice quality statistics on the voice gateway, use the following command:
 +
 
 +
<pre>mgcp voice-quality-stat all</pre>
 +
 
 +
Note: A warning message might be displayed advising that "enable voice stats might impact performance".
 +
 
 +
For more information, see [http://www.cisco.com/en/US/docs/ios/voice/command/reference/vr_book.htm ''Cisco IOS Voice Command''].
----
----
Line 921: Line 1,179:
<br>
<br>
-
[[Category:Cisco_Prime_Collaboration_9_0]]
+
[[Category:Cisco_Prime_Collaboration]]

Revision as of 09:36, 12 November 2013

This section describes how to configure devices on the network before you manage them in Cisco Prime Collaboration Assurance.

Contents

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
-
-
  • CLI access is required if you want to use the Troubelshooting feature in Prime Collaboration. HTTP access is not required.
  • The HTTP credentials (helpdesk role) are same as the SSH credentials, which are required by Prime Collaboration to troubleshoot.
Cisco TelePresence Manager (CTS-Manager)
Yes
Yes
-
-
-
-
  • Requires the Reporting API license and the Reporting API role for the Prime Collaboration user.
  • The HTTP user needs to be an exchange mailbox user and its User Group must have Reporting API and Live Desk roles in CTS-Manager.
  • If you have installed a licensed version of Prime Collaboration, it is mandatory to configure the CTS-Manager Reporting API. If this feature is not configured on the CTS-Manager 1.7, 1.8, or 1.9, Prime Collaboration will not manage the CTS-Manager.
Cisco Unified CM
Yes
Yes
-
Yes
-
-
  • Prime Collaboration supports Cisco Unified CM clusters. You must ensure that the cluster IDs are unique. To verify the cluster ID go to the Enterprise Parameteres Configuration page (System > Enterprise Parameters) on Cisco Unified CM publisher (for every cluster).
  • The same credentials must be created for all devices in the cluster whenever clustering is used.
  • The JTAPI user needs to have these roles Standard AXL API Access, CCM Admin Users, SERVICEABILITY Administration, CTI Enabled, and CTI Allow Call Monitoring.
  • The session monitoring feature is supported only from Cisco Unified CM 8.5 release onwards.
Cisco Unified Communications Manager Business Edition
Yes
Yes
-
Yes
-
-

Customer Voice Portal
Yes
-
-
-
-
-

  • Cisco Codec EX series
  • Cisco TelePresence System Integrator C Series
  • Cisco TelePresence MX Series
  • Cisco TelePresence System Profile Series
  • Cisco TelePresence SX20 Quick Set
  • Cisco TX 9000 series
Yes
Yes
Yes
-
Yes
-
  • The HTTP user requires Admin privilege.
  • For TC 6.0 and TE 6.0, use the same HTTP credentials for MSI.
  • For TX 6.0, use the default credentials msiuser and cisco for MSI.
Cisco IP Video Phone E20
Yes
Yes
Yes
-
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.
  • Use the same HTTP credentials for MSI.
Emergency Responder
Yes
-
-
-
-
-

Expert Advisor
Yes
-
-
-
-
-

Finesse
Yes
-
-
-
-
-

Cisco MCU
Yes
Yes
-
-
-
-
  • The HTTP user requires Admin privilege.
  • This device also include the MSE8000 blade form factors: MSE-8420, MSE-8510, and MSE-8710.
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
  • CDP needs to be enabled for the video Troubleshooting workflow. The Telnet or SSH access is required for Cisco Medianet features, which is part if the video Troubleshooting workflow.
  • See the table Supported Software Versions for the Cisco Medianet Feature below to view the troubleshooting medianet-related data.
Cisco TelePresence Management Suite (Cisco TMS)
Yes
Yes
-
-
-
-
  • Requires Booking API license (TMS software version 13.1 or below).
  • The HTTP user for Prime Collaboration needs to be generated through the Booking API on the Cisco TMS windows server.
  • Prime Collaboration supports only the default e-mail template for the Booking Confirm e-mail in Cisco TMS. The session import feature will not work, if the default e-mail template is not used.
Cisco Telepresence Server
-
Yes
-
-
-
-
  • The HTTP user account should have the API Access privilege.
  • This device also include the MSE8000 blade form factors: MSE-8420, MSE-8510, MSE-8710.
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)
-
-
-
-
-
-
  • The Cisco Jabber endpoints are discovered either through Cisco Unified CM or Cisco VCS (access credentials are not required).
  • 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 Cius
-
-
-
-
-
-
  • The Cisco Cius endpoints are discovered either through Cisco Unified CM or Cisco VCS (access credentials are not required). You must enable web access in Cisco Unified CM for these.
  • Credentials are not required for HTTP access.
  • 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 IP phones (89xx, 99xx)
-
-
-
-
-
-
  • The Cisco IP Phones endpoints are discovered through Cisco Unified CM. You must enable web access in Cisco Unified CM for these.
  • These video phones require Cisco Unified CM application user to have the additional role Standard CTI Allow Control of Phones supporting Connected Xfer and conf.
  • Credentials are not required for HTTP access.
  • 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.
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:

  1. Create a user group with sufficient privileges. Log in to the Cisco Unified CM Administration web interface using the administrator role.
  2. Choose User Management > User Group and create a new group with a suitable name, PC_HTTP_Users in this case.
  3. Click Role.
  4. Click Assign Role to Group and select the following roles:
    • Standard AXL API Access
    • Standard CCM Admin Users
    • Standard SERVICEABILITY Administration
  5. Click Save.
  6. 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.
  7. 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).
  8. 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:

  1. Log in to the Cisco Unified Serviceability view in the Cisco Unified Communications Manager web GUI.
  2. From the main menu in the Cisco Unified Serviceability view, choose SNMP > v1/v2c > Community String.
  3. Select a Server and click Find.
    If the community string is already defined, the Community String Name is displayed in the Search Results.
  4. Click Add new to add a new string if no results are displayed.
  5. Specify the required SNMP information and save the configuration.
  6. 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:

  1. Log in to the Cisco Unified CM Administration web interface using administrator role.
  2. Choose User Management > User Group and create a new group with a suitable name, PC_HTTP_Users in this case.
  3. Move all endpoint devices (for example, Cisco TelePresence codecs) to the Controlled Devices table.
  4. Click Roles.
  5. 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
  6. Click Save.
  7. 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 (=).
  8. 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).
  9. 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:

  1. Log in to the Cisco Unified CM Administration web interface.
  2. Choose System > Service Parameters. The Service Parameters Configuration page appears.
  3. 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.
  4. To add Prime Collaboration as a billing server, you must ensure Prime Colaboration is up and running. 
    1. Launch Cisco Unified Serviceability.
    2. Choose Tools > CDR Management.
    3. Scroll down to Billing Applications Server Parameters and click Add New.
    4. 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.
    5. 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.

  1. From Cisco Unified Serviceability, choose Tools > Control Center - Network Services.
  2. From the list of Unified Communications servers, select the publisher.
  3. Scroll down to CDR Services.
  4. Select the Cisco CDR Repository Manager radio button.
  5. 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.

  1. Log in to the Cisco Unified Serviceability view in the Cisco Unified Communications Manager web GUI.
  2. Choose Tools > CDR Management.
  3. 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.
  4. Click Update.

Activate the AXL Web Service

Perform this procedure for Unified Communications Manager versions.

  1. Launch Cisco Unified Serviceability.
  2. Choose Tools > Service Activation.
  3. Select a server.
    Note: Activate the AXL Web Service on the Publisher node.
  4. Scroll down to Database and Admin Services and select Cisco AXL Web Service.
  5. 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.

  1. Log in to Unified CM Administration.
  2. Choose System > Service Parameters. The Service Parameters Configuration page appears.
  3. Select the server and the service:
    1. Select the name of the Unified Communications Manager server. This is a Unified Communications Manager from which Prime Collaboration Assurance will gather data.
    2. Select the Unified Communications Manager service.
  4. 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.
  5. 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

  1. Log in to Unified CM Administration.
  2. Choose System > Enterprise Parameters. The Enterprise Parameters Configuration page appears.
  3. 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.
  4. Scroll down to CDR Parameters and set CDR File Time Interval to 1.
  5. 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.

  1. SSH to Unified CM.
  2. Enter the command.

If the license server is Enterprise License Manager:

license management service activate Cisco ELM Resource API

If the license server is Prime License Manager:

license management service activate Cisco Prime LM Resource API

After the configuration, the following message will be displayed:

Activating <License_Server> 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.

  1. On your Cisco Unified Communications Manager, select Cisco Unified Serviceability from the Navigation pull-down in the top-right corner of the device's home screen.
  2. Choose Alarm > Configuration.
    Caution: Do not use the Unified CM enterprise service parameter to configure the syslog receiver for Prime Collaboration 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.
  3. 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
      • Service Group > CDR Service > Cisco CDR Repository Manager
      • Service Group > Database and Admin Services > Cisco Database Layer Monitoring
      • Service Group > Database and Admin Services > Cisco License Manager
      • Service Group > Performance and Monitoring Services > Cisco AMC Service
      • Service Group > Backup and Restore > Cisco DRF Master
      • Service Group > Backup and Restore > Cisco DRF Local
  4. Click on the Enable Alarm check box, select Alarm Event Level to "Error" for all listed services except for Cisco CallManager and Cisco License Manager, which should be set to "Informational" level..
  5. Check Apply to All Nodes and click Save.
    Note: 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:

  1. 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.
  2. Choose System Settings > Enterprise Parameters.
  3. 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.
  4. Select Cisco Unity Connection Serviceability from the Navigation drop-down in the top-right corner of the device’s home screen.
  5. 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
  6. 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:

  1. Open the Tools Depot on the Desktop and choose Diagnostic Tools > Event Monitoring Service.
  2. Double-click to run.
  3. 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.
  4. Enter a Recipient Name to identify a single recipient (or a group as there can be multiple E-mail addresses under SMTP).
  5. 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
  6. 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:

  1. Select Event Source from the pull-down menu
  2. 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.
  3. Select Type to filter what level notifications should be sent for.
  4. Select Errors, Warnings, and Informational for all level events or if the Type is unknown.
  5. 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.
  6. Select OK after adding the new event.

To activate the new event, one or more Recipients need to be added to it.

  1. 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.
  2. 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:

  1. Select the event Source from the pull-down.
  2. 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.
  3. 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:

  1. 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.
  2. Choose Alarm > Configurations.
  3. 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.
  4. 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:

  1. On the media server system, choose Start > Settings > Control Panel > Administrative Tools > Services.
    The Services window appears.
  2. Double-click SNMP Service.
    The SNMP Services Properties window appears.
  3. Select the Security tab.
  4. Select Community String and click Edit.
  5. 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:

  1. Launch Cisco Unified Communications Manager Administration.
  2. Choose Device > Phone and search for Cisco TelePresence system endpoints.
  3. Click the Device Name link to go to the phone configuration page.
  4. Edit the SNMP Configuration Parameters.
  5. 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:

  1. Go to Start on the server console.
  2. Click Run and specify services.msc.
    A Service window will pop open on the server console.
  3. Right-click SNMP Service and select Properties.
  4. 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.
  5. Optionally, click Traps to add the IP address of Cisco Prime Collaboration and a community string. This address is used in SNMP traps.
  6. 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.
  7. 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:

  1. In the LDAP server, create a user group. For example,create a group named pc_group.
  2. 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.
  3. 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.
  4. 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 will require an Application Integration License for each server that uses the API. For details see the following note.

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. 
*For Cisco Prime Collaboration Assurance 9.5 and later, if you want to use the frequent polling 
of TMS (versions 13.2 and later) feature for session monitoring, you will require a booking API
license for the GetTransactionSince TMS API.

To enable Prime Collaboration server to retrieve scheduled meetings from Cisco TMS:

  1. 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.
  2. Choose GenerateConferenceAPIUser.
  3. 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.
  4. Click Invoke.
  5. In the Cisco TMS application, verify the user name configured in Step 3is listed in the Users page.
  6. In the Cisco TMS application, create a user group. For example, create a group named pc_group.
  7. Add the user created in Step 3 to the group created in Step 6. For example, add pc_user to pc_group.
  8. 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.
  9. 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.

Disable the the GetTransactionSince Cisco TMS API

To disable the GetTransactionSince TMS API (applicable for Prime Collaboration 10.0 and later) :

  1. Log in as a root user in the Prime Collaboration Assurance server through SSH (port 26).
  2. Run the following command:
     goemsam 
  3. Go to /opt/emms/emsam/conf and open file emsam.properties
  4. Change the value of com.cisco.nm.emms.access.tms.frequent.polling to false.
  5. Restart the Prime Collaboration Assurance server by running the command:
     bin/cpcmcontrol.sh start 
    then the following command:
     bin/cpcmcontrol.sh stop 

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:

  1. Log in to the supervisor web interface.
  2. Choose Hardware > Blades and click the IP address of the MCU MSE 8510 blade.
  3. 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:

  1. Choose Network > SNMP.
  2. Edit the SNMP Read Only and Read Write strings as required.
  3. 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.

  1. Log into NAM using the web interface.
  2. Choose Setup > Monitor. The Core Monitoring Functions table displays.
  3. Click RTP Stream Monitoring. The RTP Stream Setup window appears.
  4. Click the Monitoring Enabled check box.
  5. 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.
  1. Log into NAM using the web interface.
  2. Choose Admin > System > NAM System Time. The NAM System Time Configuration dialog box appears.
  3. Select the NTP Server radio button.
  4. 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.
  5. Select the Region and local time zone from the lists.
  6. 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).

Configuring MGCP Voice Gateways to Support CVTQ

This configuration is applicable for voice gateways running Cisco IOS 12.4(4)T or later.

TIC5510 DSP supports the DSP/KF voice quality metric that Prime Collaboration needs. For more information, see DSP Voice Quality Metrics Guide.

To confirm that a voice gateway has TIC5510 DSP, look for 5510 in the output of this command:

show voice dsp detailed

For more information, see Cisco IOS Voice Command.

To enable voice quality statistics on the voice gateway, use the following command:

mgcp voice-quality-stat all

Note: A warning message might be displayed advising that "enable voice stats might impact performance".

For more information, see Cisco IOS Voice Command.









Rating: 2.2/5 (6 votes cast)

Personal tools