Guest

Cisco Prime Collaboration Manager

Cisco Prime Collaboration Manager Quick Start Guide 1.2

  • Viewing Options

  • PDF (288.3 KB)
  • Feedback
Quick Start Guide

Table Of Contents

Cisco Prime Collaboration Manager 1.2 Quick Start Guide

About This Guide

Product Overview

About Cisco Prime CM Licensing

Obtaining a PAK

Obtaining a License File

Installing Prime CM

Before You Begin

System Requirements

Required Ports

Deploying the OVA

Configuring the Virtual Appliance

Upgrading from Prime CM 1.1 to 1.2

Setting up Devices on the Network

Getting Started

Removing SSL Certificate Warning

Navigation and Documentation Reference

Uninstalling Prime CM

Related Documentation

Obtaining Documentation and Submitting a Service Request


Quick Start Guide

Cisco Prime Collaboration Manager 1.2 Quick Start Guide


Revised: July 03, 2012, OL-26266-01

1 About This Guide

This guide explains how to install Cisco Prime Collaboration Manager Release 1.2 on virtualized servers.

This guide is targeted to administrators who configure, monitor, and maintain the Cisco TelePresence System, and troubleshoot problems that may occur. These administrators must be conversant with the following video collaboration applications:

Management—Cisco TelePresence Manager (CTS-Manager) and Cisco TelePresence Management System (Cisco TMS).

Call and session control—Cisco Unified Communications Manager (Cisco Unified CM) and Cisco TelePresence Video Communication Server (Cisco VCS).

Conferencing—Cisco TelePresence Multipoint Switch (CTMS), Cisco TelePresence Server (TS), Multipoint Control Units (MCU), and Cisco TelePresence Media Service Engine (MSE).

Administrators should also be familiar with virtualization concepts and virtualized environments.

For detailed information about configuring and managing Prime CM, see Cisco Prime Collaboration Manager 1.2 User Guide.

New and Changed Information

The following table describes information that has been added or changed since the initial release of the Cisco Prime Collaboration Manager 1.2 Quick Start Guide.

Date
Revision
Location

July 03, 2012

Updated supported software version for CTS-Manager, Cisco TelePresence Multipoint Switch and Cisco TelePresence System series.

Updated Prime CM 1.1 configuration data that is retained after the upgrade to Prime CM 1.2

Updated information on how to obtain license files for Prime CM 1.0 and 1.1 customers.

Setting up Devices on the Network

Upgrading from Prime CM 1.1 to 1.2

About Cisco Prime CM Licensing

June 13, 2012

Initial version.

 

2 Product Overview

Prime CM is a video service assurance and management system that helps you to monitor, troubleshoot, and report. It provides service and network operators with a real-time, unified view of all Cisco TelePresence sessions that are in progress.

Prime CM also provides immediate visibility into the associated media paths of each session and isolates the source of problems. When Mediatrace-capable devices are deployed in the network, Prime CM provides network path visibility, down to the granularity of video flow statistics.

Prime CM:

Supports timely, end-to-end visibility and isolates video-related issues for sessions, endpoints, and the network.

Reduces time to troubleshoot and recover from service-affecting problems.

Provides detailed analysis of the media path, with critical fault and performance statistics, enabling you to isolate network devices that are causing service degradation.

Validates large-scale deployments through comprehensive inventory, health, and status of Cisco TelePresence endpoints, as well as service and network infrastructure devices.

Delivers reports that allow operators to track usage and problem history.

For information on benefits of key features in Prime CM, see Cisco Prime Collaboration Manager 1.2 User Guide.

3 About Cisco Prime CM Licensing

Prime CM provides licenses based on endpoint type. The following license categories are supported for this release:

Multiple-codec endpoint

High-end codec endpoint

Midrange codec endpoint

Mass endpoint

Table 1 provides the mapping between license category and endpoint type.

Table 1 License Category and Endpoint Type 

License Category
Endpoint Type

Multiple-codec endpoints

Cisco TelePresence System 3000

Cisco TelePresence System 3010

Cisco TelePresence System 3200

Cisco TelePresence System 3210

High-end, single-codec endpoints

Cisco TelePresence System 1000

Cisco TelePresence System 1100

Cisco TelePresence System 1300

Cisco TelePresence System 1400

Cisco Profile 42-C20

Cisco Profile 42-C60

Cisco Profile 52-Dual

Cisco Profile 52

Cisco Profile 65

Cisco Profile 65-Dual

Cisco Profile 52-6000MXP

Midrange, single-codec endpoints

Cisco Codec EX60

Cisco Codec EX90

Cisco Codec C90

Cisco Codec C60

Cisco Codec C40

Cisco Codec C20

Cisco Profile 42 C20

Cisco Profile 42 C60

Cisco Profile 150MXP

Cisco Profile 1000MXP

Cisco Profile 1700MXP

Cisco Profile 3000MXP

Cisco Profile 6000MXP

Cisco TelePresence MX200

Cisco TelePresence MX300

Cisco CTS Manager 500

Cisco TelePresence SX20 Quick Set

Mass endpoints

Cisco IP Phones

Polycom

Cisco Cius

Cisco Jabber Video for TelePresence

Cisco IP Video Phone E20


Initially, you must download and install an evaluation version of Prime CM from the list of Network Management Evaluation Products on Cisco.com.

The Evaluation license is valid for 60 days. In Evaluation license mode, you can manage the following:

100 high-end, single-codec endpoints

100 high-end, multiple-codec endpoints

500 midrange, single-codec endpoints

2000 mass endpoints

By default, when you download and install the product, you obtain the license in Evaluation mode for 60 days.


Note Prime CM 1.2 base software does not include any licenses.


To license your product:


Step 1 Obtain a product authorization key (PAK) and a license file. See Obtaining a PAK and Obtaining a License File.

Step 2 Add the license file after you install Prime CM. For information about adding license files, see Cisco Prime Collaboration Manager 1.2 User Guide.


Support for Prime CM 1.0 and 1.1 Licenses

The licensing structure has changed in the Prime CM 1.2 release.

If you are a Prime CM 1.0 customer and have upgraded to the Prime CM 1.1 release, then you need to update your license file for Prime CM 1.2. The Prime CM 1.0 license file is not recognized after the Prime CM 1.2 upgrade. You must obtain a new license file for Prime CM 1.2.

If you have installed Prime CM 1.1 directly and upgraded to Prime CM 1.2 release, the Prime CM 1.1 license file is recognized after the upgrade. However, you may need to obtain appropriate Prime CM 1.2 endpoint licenses that were included with the Prime CM 1.1 base license.

You can check whether you are using the Prime CM 1.0 or 1.1 license file by opening the *.lic file. Search for the string CM_LARGE_NTWK_DVCS10K or CM_CODEC25 in your license file; if one of these strings is listed in the license file, then you are using the Prime CM 1.0 license file else it is Prime CM 1.1.

Before upgrading to Prime CM 1.2, you must contact your Cisco account manager to obtain the Prime CM 1.2 Upgrade PID.

To get the Prime CM 1.2 license files, you must contact the Cisco Technical Assistance Center (TAC) team. The TAC team may need the Prime CM Purchase Order details for license entitlement.

Obtaining a PAK

The PAK is located on the software claim certificate. You can obtain the claim certificate through the eDelivery system. For information on eDelivery, see http://www.cisco.com/web/partners/tools/edelivery.html.

Obtaining a License File

To obtain a license file, you must register the Prime CM product with Cisco.com, using the PAK and the Universal Unique Identifier (UUID) that is generated on each Prime CM server. The UUID is automatically generated on the server when you install the evaluation version of Prime CM. You can get the UUID from the About page in Prime CM. You need to provide this value when you generate the license file.

You can generate your license file at:

http://www.cisco.com/go/license

After you obtain the license file, you must add the license to Prime CM. For information, see Cisco Prime Collaboration Manager 1.2 User Guide. When you add the license file, the evaluation license is automatically converted into the perpetual license type that you purchased.

4 Installing Prime CM

Prime CM is delivered as an Open Virtual Appliance (OVA) file. An OVA allows you to easily deploy a prepackaged Virtual Machine (VM).

Before You Begin

Verify the following:

OVA is downloaded and saved to the same machine on which the vSphere client is installed.

VMware ESXi is installed and configured on the ESXi host. See the VMware documentation for information on setting up and configuring your host machine.

VMware ESXi host is reachable with the configured IP settings (address, network mask, and gateway).

VMware vSphere Client is installed. After the virtual host is available on the network, you can browse to its IP address to display a web-based interface from which you can install the VMware vSphere client.


Note The VMWare vSphere Client is Windows-based. Therefore you must download and install the client from a Windows PC.


After you install the VMWare vSphere client, you can run it and log into the virtual host, using the hostname or IP address of the virtual host, the root login ID, and the password that you configured. You can add the host to a vCenter if you want to manage it through vCenter. See VMWare documentation for details.

VMware ESXi server hostname is configured in the DNS server.

VMware ESXi server is synchronized with the NTP server.

Download one of the following Prime CM images from the Cisco Prime Collaboration Manager software download site ():

New installation of Prime CM 1.2: emsam-va-1.2.0-16941.x86_64.ova

Upgrade from Prime CM 1.1 to Prime CM 1.2: emsam-appbundle-1.2.0-16941.x86_64.tar.gz

You must have a valid Cisco.com user account to download the files.

See Setting up Devices on the Network for information about setting up the devices in your network.

System Requirements

Prime CM 1.2 runs on any VMware-certified hardware with ESXi 4.1 or 5.0 installed. Prime CM must be installed on 64-bit machines.


Note We recommend that you install and run Prime CM on Cisco Unified Computing System (UCS), which is VMware-certified.


The OVA defines the configuration of the virtual machine that includes the CPU, memory, disk, and network resources.

Virtual Machine Requirements

Table 2 lists the virtual machine requirements based on the number of endpoints managed in Prime CM.

Table 2 Virtual Machine Requirements 

Endpoints Managed in Prime CM
CPU
RAM
NIC
Disk Space

Up to 1000 endpoints

4

8 GB

1 GB

90 GB

More than 1000 endpoints

4

16 GB

1 GB

90 GB



Note By default, the Prime CM 1.2 OVA file is configured to support up to 1000 endpoints. See the VMware documentation for information on editing the OVA file to support more than 1000 endpoints.


Client Machine Requirements

A maximum of 10 users can be logged into Prime CM at the same time.

Table 3 lists the client machine requirements for effective use of Prime CM 1.2.

Table 3 Client Machine Requirements 

Parameter
Requirement
Display Resolution

1024 x 768 or higher.

Supported Browser

The following browsers are supported:

Mozilla Firefox 8.0, 9.0, and 10.0 (Linux, Mac, and Windows)

Windows Internet Explorer 8.0 and 9.0

Prime CM provides a self-signed certificate (HTTPS). To allow access of the Prime CM client, you must ensure that security is set to either medium or low in Internet Explorer.

Note:

Make sure you enable cookies in the browser.

Make sure you set English (United States) [en-us] as the language in the browser.

Adobe Flash Player

You must install Adobe Flash Player on the client machine for Prime CM features to work properly. We recommend that you download and install Adobe Flash Player version 10.x from the Adobe website.


Required Ports

Table 4 gives details of the ports that are used by Prime CM.

Table 4 Ports to Be Used 

Port
Protocol
Direction
Usage

22

TCP

Unidirectional: Prime CM to CTS, C series.

To initiate SSH connection to endpoints during the troubleshooting process.

Unidirectional: Client to Prime CM.

To connect to the Prime CM server from the client machine.

23

TCP

Bidirectional: Prime CM to Medianet-enabled devices.

To initiate the Telnet connection to medianet-enabled devices during the troubleshooting process.

25

TCP

Unidirectional: Prime CM to SMTP server.

SMTP

53

TCP

Unidirectional: Prime CM to DNS server.

DNS

80

TCP

Bidirectional: Client to Prime CM.

Browser access to Prime CM (HTTP).

Bidirectional: Prime CM to Medianet-enabled devices.

To initiate HTTP connection to the medianet-enabled devices during the troubleshooting process.

Unidirectional: Prime CM to Cisco VCS.

To poll call details and Cisco VCS health status (HTTP).

Unidirectional: Prime CM to CTMS.

To poll call details.

Unidirectional: Prime CM to MCU.

To poll call details and MCU health status.

Unidirectional: Prime CM to CTS-Manager.

To import sessions and to poll CTS-Manager health status.

Unidirectional: Prime CM to TMS.

To import sessions and to poll TMS health status.

Unidirectional: Prime CM to C-series.

To poll call details and C-series status (HTTP).

161

UDP

Unidirectional: Server to network devices.

SNMP MIB polling.

Unidirectional: Prime CM to Cisco VCS.

To poll call details and Cisco VCS health status (SNMP).

Unidirectional: Prime CM to CTMS.

To poll CTMS health status.

Unidirectional: Prime CM to MCU.

To poll MCU health status.

Unidirectional: Prime CM to CTS-Manager.

To poll CTS-Manager health status.

Unidirectional: Prime CM to TMS.

To poll TMS health status.

Unidirectional: Prime CM to C-series.

To poll C-series health status.

Unidirectional: Prime CM to CTS.

To poll call details and CTS health status.

162

UDP

Unidirectional: Endpoints to Prime CM.

Trap receiver port.

Unidirectional: Prime CM to trap receivers.

To send SNMP traps.

443

TCP

Bidirectional: Client to server.

Secure browser access to Prime CM (HTTPS).

Bidirectional: Server to call and session control.

HTTPS connectivity for Real Time Monitoring Tool (RTMT), Cisco Unified CM registration, and Cisco VCS.

Bidirectional: Server to multipoint switch and management applications.

HTTPS connectivity to CTMS, CTS-Manager, and TMS.

Unidirectional: Prime CM to VCS.

To poll call details and VCS health status (HTTPS).

Unidirectional: Prime CM to CTMS.

Prime CM Server to multipoint switch and management applications.

Unidirectional: Prime CM to MCU.

To poll call details and MCU health status.

Unidirectional: Prime CM to CTS-Manager.

To import sessions and to poll CTS-Manager health status.

Unidirectional: Prime CM to TMS.

To import sessions and to poll TMS health status.

Unidirectional: Prime CM to C-series.

Prime CM Server to multipoint switch and management applications.

514

UDP

Unidirectional: Cisco Unified Communications Manager to Prime CM.

Syslog receiver port.

2748

TCP

Unidirectional: Prime CM to Cisco Unified Communications Manager.

CTI application server.

2749

TCP

Unidirectional: Prime CM to Cisco Unified Communications Manager.

TLS connection between CTI applications (JTAPI/TSP) and CTIManager

2789

TCP

Unidirectional: Cisco Unified Communications Manager to Prime CM.

JTAPI application server on the client side.

8886

TCP

Unidirectional: Cisco VCS to Prime CM.

To receive feedback/notification from Cisco VCS over HTTP.

8888

TCP

Unidirectional: Cisco VCS to Prime CM.

To receive feedback/notification from Cisco VCS over HTTPS.


Deploying the OVA

Make sure that all system requirements have been met. Review Before You Begin and System Requirements.

To deploy the OVA:


Step 1 Launch your VMWare vSphere client.

Step 2 Choose File > Deploy OVF Template.

Step 3 In the Deploy OVF Template window, click the Deploy from file radio button.

Step 4 Click Browse and navigate to the location where you have saved the emsam-va-1.2.0-16941.x86_64.ova file.

Step 5 Click Next.

The OVF template details are displayed in the OVF Template Details window.

Step 6 Verify the details about the OVA file, including the product name, version, and the size, then click Next.

Step 7 In the Name and Location window, specify a name and location for the template that you are deploying. The name must be unique within the inventory folder and can contain up to 80 characters.

Step 8 Click Next.

Step 9 In the Disk Format window, click one of the following radio buttons to specify the format to store the virtual disks:

Thin provisioned format

Thick provisioned format

We recommend Thick provisioned format.

Step 10 Click Next.

The Ready to Complete window displays the details of the OVA file, the name of the virtual appliance, the size of the disk, the hostname, the disk format, and the storage details.

Step 11 After you verify the options, click Finish to start the deployment.

This will take a few minutes to complete. Check the progress bar in the Deploying Virtual Application window to monitor the task status.

After the deployment task has successfully completed, a confirmation window appears.

Step 12 Click Close.

The virtual appliance that you deployed appears in the left pane of the vSphere client, under the host.


Configuring the Virtual Appliance

After you deploy the Prime CM OVA, you must configure the virtual appliance.


Note Prime CM is installed as an evaluation version, and all features are supported in this version. The evaluation license is valid for 60 days.


To configure the virtual appliance:


Step 1 Power on the virtual machine by right-clicking the virtual appliance and choosing Power > Power On.

The virtual appliance console appears.

Step 2 In the virtual appliance console, enter setup at the localhost login prompt.

Step 3 Enter the required parameters at the console prompts. After entering each parameter, press Enter to bring up the next parameter.


NoteTime zone—When you are prompted to enter the system time zone, while configuring the Prime CM server, specify the default time zone, which is, UTC. You can change/set the time zone through SSH after you install Prime CM server. For a list of supported time zones, see Supported Time Zones for Prime Collaboration Manager. For detailed information on how to set the time zone after you install Prime CM, see Cisco Prime Collaboration Manager 1.2 User Guide.

Username—Do not use cmuser as the administrative username. Because cmuser is the preconfigured Prime CM CLI user, using it could cause problems.

Password—We recommend that you write down the administrative password. This password cannot be retrieved or reset.


The End User License Agreement appears.

Step 4 Review the license agreement and enter y to accept it.

The virtual machine reboots.

Step 5 Log into Prime CM to verify if it is working. (See Getting Started.)


Troubleshooting the Prime CM Installation

If you are unable to launch Prime CM, it could be because the required processes are not running on the Prime CM 1.2 server.

To troubleshoot the installation:


Step 1 Log into the Prime CM 1.2 server using the SSH service and with the user that you created during OVA configuration. By default, this username is admin.

Step 2 Enter the following command to display the processes that are running:

show application status emsam
 
   

The following is sample output of the status command:

STAT   PID USER     COMMAND             ELAPSED
===============================================
S<l   4084 root     Decap_main       1-00:18:32
SNl   5250 root     emsam_fault      1-00:15:55
SNl   4348 root     emsam_inventory  1-00:18:00
SNl   4274 root     emsam_mq         1-00:18:08
SNl   5138 root     emsam_poller     1-00:16:16
SNl   5067 root     emsam_tomcat     1-00:16:19
SNs   4204 oracle   oracle           1-00:18:22
SNsl  4113 oracle   tnslsnr          1-00:18:30
 
   

The parameters in the COMMAND column are the processes that are running on the Prime CM 1.2 server. If you do not see all of these processes running, enter the following commands to restart the Prime CM services:

application stop emsam
application start emsam
 
   

Step 3 Repeat Step 2 and check whether all of the processes are running.

If all of the required processes are still not running on the Prime CM 1.2 server, contact the Cisco TAC.


5 Upgrading from Prime CM 1.1 to 1.2

When you upgrade from Prime CM 1.1 to 1.2, some configuration data is retained. Table 5 lists details of the configuration data that is retained.

If you are using Prime CM 1.0 and wish to upgrade to Prime CM 1.2, you must first upgrade to Prime CM 1.1 and then upgrade to Prime CM 1.2. To upgrade Prime CM 1.0 to 1.1, see Cisco Prime Collaboration Manager Quick Start Guide 1.1


Note The Prime CM 1.1 inventory data is not retained after the upgrade. However, the device credentials data is retained. Run the device discovery task (Inventory > Device Inventory > Discover Devices) to add the inventory data to the Prime CM 1.2 database.


After the upgrade, the configuration data in the following table is the only data that is retained.

Table 5 Configuration Data Retained in Upgrade from Prime CM 1.1 to 1.2

Configuration Data
Navigation in Prime CM
Configuration Required After Migration

Device access credentials

Inventory > Device Inventory > Manage Credentials

No additional configuration required in Prime CM 1.2.

User accounts

Administration > Management > User Management

No additional configuration required in Prime CM 1.2.

Device monitoring configurations

Administration > Device Monitoring Configuration

No additional configuration required in Prime CM 1.2.

Event configurations

Administration > Configuration > Event Settings

No additional configuration required in Prime CM 1.2.

System configurations

Administration > Configuration > System Configuration

Check Month-to-Month Endpoint Utilization and No Show Reports to receive aggregate monthly reports.

If you are managing your network using Cisco Prime NAM, add or import the Cisco Prime NAM devices.

If you are managing your network using Cisco Prime LMS, add the Cisco Prime LMS server details.

If you are managing traps using external tools, configure trap receivers for alarms and events.


Prime CM 1.1 and Prime CM 1.2 are installed on the same virtual machine. To upgrade from Prime CM 1.1 to Prime CM 1.2:


Step 1 Log in to the Prime CM 1.1 server as admin through SSH.

Step 2 Enter the following commands to create a cars repository:

admin# configure terminal
admin(config)# repository cars
admin(config-Repository)# url  ftp://111.222.333.444 (for example)
admin(config-Repository)# user admin password plain cisco (for example)
admin(config-Repository)# exit
admin(config)# exit
 
   

Step 3 Enter the following command to upgrade the Prime CM 1.1 server to Prime CM 1.2:

admin# application upgrade emsam-appbundle-1.2.0-XXXXX.x84_64.tar.gz cars
 
   

Step 4 Open another session via SSH terminal to login to Prime CM admin and confirm that the Prime CM 1.2 server processes are running:

admin# show application status emsam
STAT   PID USER     COMMAND             ELAPSED
===============================================
S<l  15750 root     Decap_main         15:55:41
Sl   17156 root     emsam_fault        15:53:36
Sl   16024 root     emsam_inventory    15:55:26
Sl   15945 root     emsam_mq           15:55:34
Sl   17056 root     emsam_poller       15:53:57
Sl   16983 root     emsam_tomcat       15:53:59
Ss   15860 oracle   oracle             15:55:40
Ssl  15781 oracle   tnslsnr            15:55:41
admin# exit
 
   

Log in to Prime CM to verify if it is working. (See Getting Started.)



Note The upgrade process takes approximately 20 minutes to complete.


6 Setting up Devices on the Network

You must configure endpoints, application managers, call processors, multipoint switches, and network devices with the following credentials before managing them in Prime CM:

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 a device through the CLI to discover the media path for troubleshooting.

JTAPI—Retrieve session status information from the Cisco Unified CM.

CDP—Discover neighboring devices.

Table 6 lists the device credentials and software versions that are required before managing devices in Prime CM.

Table 6 Device Credentials and Software Versions 

Video Collaboration Applications
Supported Software Versions
SNMP
HTTP
CLI
JTAPI
CDP

CTS-Manager

1.7, 1.8

Yes

Yes1

No

No

NA

Cisco Unified CM

8.0 to 8.6

Yes

Yes

No

Yes

NA

Cisco TelePresence Multipoint Switch

1.7, 1.8

Yes

Yes

No

No

NA

Cisco TelePresence System series

1.7, 1.8

Yes

No

Yes

No

NA

Cisco TelePresence Management Suite (Cisco TMS)

13.0, 13.1, 13.2

Yes

Yes2

No

No

Cisco TelePresence Video Communication Server (Control and Expressway)

6.0 to 7.0

Yes

Yes3

No

No

Cisco TelePresence MCU series

Cisco MCU MSE 8510

4.1 or 4.2

Yes

Yes3

No

No

Cisco Telepresence Server 7010

Cisco Telepresence Server MSE 8710

2.1 or 2.2

No

Yes

No

No

Cisco Codec EX series

Cisco Telepresence System Integrator C Series

Cisco Telepresence MX Series

Cisco Telepresence System Profile Series

Cisco Telepresence SX20 Quick Set

4.2 or 5.0

Yes

Yes3

Yes

No

Cisco TelePresence System MXP series

9.1

Yes

Yes3

Yes

Polycom VSX series (8.0. 8.5, 9.0.5)

9.0

Yes

No

No

Polycom HDX series

2.5 to 3.0

Yes

No

No

Cisco Cius

9.2

No

No4

No

Cisco TelePresence Supervisor MSE 8050

2.1

Yes

Yes3

No

No

Cisco IP Video Phone E20

4.0 or 4.1

Yes

Yes

Yes

Cisco Jabber Video for Telepresence (Movi)

4.2

No

No

No

Cisco Telepresence Conductor

1.1

Yes

Yes

No

No

Cisco IP phones (89xx, 99xx)

9.2

No

No

No

Network devices (routers and switches)

Yes

No

Yes

No

Yes

1 Requires the Reporting API license and the Reporting API role for the CPCM user.

2 Requires Booking API license and the CPCM user generated by the Booking API.

3 Requires Admin privilege.

4 No credentials are required for HTTP access.


Notes to Set up Devices on the Network

Prime CM supports only IPv4 configured endpoints. It does not support IPv6 configured endpoints. Also, Prime CM does not support dual stack (IPv4 and IPv6 configured) endpoints.

SNMP read-only access is required for CTS-Manager, CTMS, Cisco TelePresence System, Cisco Unified CM, Cisco TMS, Cisco TelePresence Server, Cisco VCS (Control and Expressway), Cisco MCU (appliance and MSE blade), Cisco TelePresence EX Series, Cisco Telepresence System Integrator C Series, Cisco TelePresence System Quick Set C Series, MSE Supervisor, and network devices.

The SNMP service must be enabled on the Cisco TMS Windows server.

For CTS-Manager and CTMS, SNMP must be enabled and configured through CLI.

For Cisco Unified CM, SNMP is enabled and configured through the Cisco Unified Serviceability tool.

A separate HTTP user account must be created with the Live Desk role and Reporting API role assigned to it for the Prime CM application in CTS-Manager. Do not use the admin user login account.

The HTTP user created for Cisco TMS must be a Booking API user generated by the Booking API itself. This user must have the Admin privilege in Cisco TMS.

A user group must be created for the Prime CM application in Cisco TMS with the List Conferences - All role with the Read permission.

For Cisco C-series TelePresence systems running on software version 4.1, the HTTP username must be in lower case.

The HTTP login access must have API privilege for Cisco TelePresence System. It does not require Admin privilege.

A JTAPI application user account is required in addition to HTTP in Cisco Unified CM. You must configure this account in the Cisco Unified CM publisher. Cisco Unified CM subscribers must have the same SNMP credentials as the Cisco Unified CM publisher.

HTTP login access must have Admin privilege for Cisco VCS, Cisco MCU, Cisco TelePresence EX Series, Cisco Telepresence System Integrator C Series, Cisco TelePresence System Quick Set C Series, and Cisco MSE Supervisor.

HTTP login access with Diagnostic Technician and Meeting Manager privileges is required for Cisco TelePresence Multipoint Switch.

Prime CM needs to access the Cisco VCS Expressway devices in the Demilitarized Zone (DMZ) using HTTP and SNMP protocols. It cannot manage and monitor the Cisco VCS Expressway devices if these protocols are blocked by firewalls.

Prime CM requires CLI login credentials to perform end-to-end path trace troubleshooting (to trigger MTR) in Cisco TelePresence System.

Prime CM must be able to ping (ICMP) all devices.

In Cisco VCS, only three servers can be registered for the feedback events. Make sure that there is no server other than the Cisco TMS server registered for Cisco VCS feedback events. The Prime CM server is registered as one of the servers for the feedback events for each Cisco VCS that is managed by the Prime CM server in the network.

For CTS endpoints, the CLI user account for CPCM can have either Admin or helpdesk privilege. The CLI access is required only when troubleshooting functionality is required.

For C/EX/MX/SX and MXP series endpoints, the required CLI user credential will be the same as the HTTP user credential. So no additional user account configuration is required for CLI.

For the C/EX/MX/SX and MXP series endpoints, the HTTP admin-level access is required for monitoring and performing end-to-end troubleshooting path trace.

No user account is required for Cisco Jabber Video for Telepresence (Movi) endpoints from CPCM.

All devices must be reachable via ICMP ping from CPCM (the ICMP ping can be disabled if necessary but that requires root access to CPCM).

Cisco TelePresence Server (TPS) does not support SNMP. Other than that, CPCM 1.2 requires SNMP read-only access for all other types of infrastructure devices.

The CTSMAN must have the Reporting API license. The HTTP user account should be an AD user with a mailbox and in a user group that has the Reporting API role and the Live Desk role in CTSMAN.

The HTTP admin-level access is not required for TPS. Only the HTTP API access privilege is required.

For VCS, the HTTP user for CPCM should have the read-write privilege.

SNMP v2c or v3 credentials are required for routers and switches if the CPCM capability of troubleshooting network issue is desired.

CDP also needs to be enabled on all network devices if troubleshooting path trace is desired.

For routers and switches, CLI login credentials are required if Medianet based troubleshooting is desired.

In Cisco Unified CM, enable the Web Access configuration for Cisco IP phones (89xx, 99xx) and Cisco Cius.

A separate HTTP user account must be created with the Meeting Scheduler and Diagnostic Technician roles assigned to it for the Prime CM application in Multipoint Switch.

For Cisco IP phones (89xx, 99xx), HTTP credentials are not required. However, the Prime Collaboration Manager must be able to access the IP Phone through HTTP.

In Cisco Unified CM, enable the following roles:

Standard CTI Allow Call Monitoring

Standard CTI Enabled

Standard CTI Allow Control of Phones supporting Connected Xfer and conf

For required protocol configurations, see Setting up Devices on the Network for Prime Collaboration Manager.

7 Getting Started

You can invoke Prime CM using the client browser.

To log into Prime CM:


Step 1 Open a browser session from your machine. See Client Machine Requirements for information about supported browsers.

Step 2 Enter either of the following:

http://IP Address

https://IP Address

 
   

Note You may use either the IP address or the hostname of the Prime CM server. We recommended that you use the hostname if you have one configured.


Depending on the browser you are using, one of the following appears:

In Windows Internet Explorer, the Certificate Error: Navigation Blocked window.

In Mozilla Firefox, the Untrusted Connection window.

These windows appear because Prime CM uses a self-signed certificate.

Step 3 Remove the SSL certificate warning. See Removing SSL Certificate Warning.

The Prime CM login page appears.

Step 4 In the Prime CM login page, enter the username and password. By default, admin is the username and password.


Note You must change the default password, admin, to proceed with using Prime CM. If you click Cancel, you will be logged out.


Step 5 In the Change Password popup window, enter the current password and the new password.


Note The new password you create must meet all of the conditions mentioned in the Basic Password Validity Rules popup window.


Step 6 Confirm the new password.

Step 7 Click Save.

You are logged out of Prime CM.

Step 8 Log in with the new password.

The Prime CM landing page appears. Note that the dashboard data is populated only after you perform tasks listed in the following table.


After you install Prime CM, you must perform the tasks listed in the following table. The table also lists corresponding sections in the Cisco Prime Collaboration Manager 1.2 User Guide that provide detailed information about the tasks.

 
Task
Description
Section in the Cisco Prime Collaboration Manager User Guide

Step 1 

Add a new license file

This step is optional if you are evaluating the product.

Add the Prime CM Base license file, using Administration > License Management.

For details on how to obtain the new license files if you are upgrading from Prime CM 1.1 to 1.2, see About Cisco Prime CM Licensing.

Managing Licenses, under Setting Up and Maintaining the Server

Step 2 

Define credentials

Enter the required device credentials to manage devices in Prime CM, using Inventory > Device Inventory > Manage Credentials. See Setting up Devices on the Network for more information.

The device credentials data will be available in the Prime CM 1.2 database if you upgrade from Prime CM 1.1 to Prime CM 1.2.

Managing Credentials, under Managing Devices

Step 3 

Discover CTS-Manager

and/or

Discover Cisco TMS

Discover either the CTS-Manager or TMS, using Inventory > Device Inventory > Discover Devices.

The Cisco Unified CM, Cisco TelePresence Multipoint Switch, Cisco TelePresence System, default gateway, and switches are discovered along with CTS-Manager.

The Cisco VCS, Cisco MCU, Cisco Profile and Codec, default gateway, and switches are discovered along with Cisco TMS.

Cisco Telepresence Conductor is not auto discovered through CTS-Manager/TMS. The Cisco Telepresence Conductor need to be discovered separately.

Discovering Devices, under Managing Devices

Step 4 

Verify Inventory

Verify whether all discovered devices are in the Managed state, using Inventory > Device Inventory.

If there are any devices in any other states, see the Job Management page (Administration > Job Management) to review the discovery job details.

Managing Inventory, under Managing Devices

Managing Jobs, under Setting Up and Maintaining the Server

Step 5 

Import Sessions

Import the video collaboration sessions from CTS-Manager, Cisco TMS, and Cisco TelePresence Multipoint Switch to monitor the sessions, using Monitoring > Session Monitoring.

To periodically import sessions from CTS-Manager, Cisco TMS, and Cisco TelePresence Multipoint Switch, define the polling interval based on your business needs, using Administration > Device Monitoring Configuration.

Monitoring Sessions, under Monitoring Sessions and Endpoints

Defining the Polling Intervals, under Setting Up and Maintaining the Server

Step 6 

Verify Sessions

Verify whether all session details have been imported from CTS-Manager, Cisco TMS, and Cisco TelePresence Multipoint Switch, using Monitoring > Session Monitoring.

Prime CM collects scheduled sessions data for five days (for the past one day, for the current day, and for three days ahead).

Monitoring Sessions, under Monitoring Sessions and Endpoints

Removing SSL Certificate Warning

This section provides information on removing the SSL certificate warning for:

Windows Internet Explorer—You can permanently remove the SSL certificate warning by installing the Prime CM self-signed certificate.

Mozilla Firefox—You can remove the SSL certificate warning only by adding an exception.

In Windows Internet Explorer, to remove the SSL certificate warning:


Step 1 Choose Continue to this website (not recommended).

Step 2 Choose Tools > Internet Options.

Step 3 In the Internet Options dialog box, click the Security tab, choose Trusted sites, and then click Sites.

Step 4 Confirm that the URL that appears in the field and matches the application URL, and then click Add.

Step 5 Close all dialog boxes and refresh the browser.

Step 6 Choose Certificate Error to the right of the address bar, and then click View certificates.

Step 7 In the Certificate dialog box, click Install Certificate.

Step 8 In the Certificate Import Wizard dialog box, click Next.

Step 9 Click the Place all certificates in the following store radio button, and then click Browse.

The Select Certificate Store dialog box appears.

Step 10 Choose Trusted Root Certification Authorities, and then click OK.

Step 11 Click Next > Finish.

Step 12 In the Security Warning message box, click Yes.

Step 13 In the Certificate Import Wizard message box, click OK.

Step 14 In the Certificate dialog box, click OK.

Step 15 Repeat Step 2 and Step 3.

Step 16 Select the URL in the Websites section, and then click Remove.

Step 17 Close all dialog boxes, restart the browser, and invoke Prime CM. See Getting Started for information on invoking Prime CM.

If you have a safe URL implemented, do the following:

a. Choose Tools > Internet Options.

b. In the Internet Options dialog box, click the Advanced tab.

c. In the Security section, uncheck the Warn about certificate address mismatch check box.


In Mozilla Firefox, to remove the SSL certificate warning:


Step 1 Click I Understand the Risks > Add Exception.

Step 2 In the Add Security Exception dialog box, click Confirm Security Exception.


8 Navigation and Documentation Reference

This section provides navigation paths to access Prime CM features, and lists the sections in the Prime CM documentation that describe the features.

Table 7 Navigation and Documentation Reference 

Task
Navigation in Prime CM
Section in
Cisco Prime Collaboration Manager 1.2 User Guide

Displaying the summary of different segments of a video collaboration network, such as session details, faults, endpoint details, and inventory details

Home

Video Collaboration Dashboard.

Managing licenses

Administration > Management > License Management

Managing Licenses.

Defining users and roles

Administration > Management > User Management

Defining Users and Roles. This section contains task-to-role mapping.

Defining polling intervals

Administration > Configuration > Device Monitoring Configuration

Defining the Polling Intervals.

Configuring system configuration parameters for alarm and report notification

Administration > Configuration > System Configuration

Configuring System Configuration Parameters.

Customizing event severity and enabling monitoring of events for all endpoints and video collaboration devices

Administration > Configuration > Event Settings

Customizing Event Parameters

Managing Jobs

Administration > Management > Job Management

Managing Jobs

Configuring log levels to debug

Administration > Configuration > Log Configuration

Setting the Log Level

Configuring time zone and refresh interval

Administration > Configuration > User Preference Configuration

Configuring Timezone and Refresh Interval. This section also contains time zone configuration information for the Prime CM server.

Configuring device credentials in Prime CM

Inventory > Device Management > Device Inventory > Manage Credentials

Managing Credentials

Discovering devices

Inventory > Device Management > Device Inventory > Discover Devices

Discovering Devices

Updating inventory for devices managed in Prime CM

Inventory > Device Management > Device Inventory > Update Inventory

Updating Inventory

Exporting inventory details for managed endpoints and infrastructure devices

Inventory > Device Management > Device Inventory > Export Inventory

Exporting Inventory

Verifying whether all endpoints and switches and the default gateway have been discovered

Inventory > Device Management > Device Inventory (Current Inventory)

Managing Inventory

Importing sessions to Prime CM from CTS-Manager and Cisco TMS

Monitoring > Sessions & Endpoints > Session Monitoring > Import Sessions

Monitoring Sessions

Verifying that sessions have been imported

Monitoring > Session Monitoring

Monitoring Sessions

Verifying that endpoints are being monitored

Monitoring > Endpoint Monitoring

Monitoring Endpoints

Generating reports

Reports > Interactive >

All Sessions Summary Report

Endpoint Utilization Report

No Show Endpoints Summary Report

Conferencing Device Utilization Report

Session Detail

Generating Reports

Managing faults

Monitoring > Alarms & Events > Alarms; Monitoring > Events

Managing Faults

Troubleshooting sessions

Automatic troubleshooting—
Administration > Device Monitoring Configuration

Manual troubleshooting—Quick view from Sessions Monitoring and Endpoints Monitoring pages.

Troubleshooting Sessions

Proactively measuring network performance and health

Monitoring > Sessions & Endpoints > Proactive Troubleshooting

Proactively Troubleshooting the Network

Readiness assessment of a network to deploy Cisco Video or TelePresence systems

Monitoring > Sessions & Endpoints > Media Path Analysis

Analyzing Media Paths

Performing backup and restore

CLI

Performing Backup and Restore


9 Uninstalling Prime CM

To delete the Prime CM virtual appliance:


Step 1 Login to vSphere client and connect to the ESX server running CM 1.2.

Step 2 Right-click the Prime CM virtual appliance, go to Power > Shut Down Guest (or choose Power Off).


10 Related Documentation

You can access Prime CM documents at Cisco Prime Collaboration Manager 1.2 Documentation Overview.


Note We sometimes update the documentation after original publication. Therefore, you should also review the documentation on Cisco.com for any updates.


Click here to access the Cisco Prime Collaboration Manager training VODs.

11 Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.