Guest

Cisco Prime Collaboration

Cisco Prime Collaboration Quick Start Guide, 9.0

 Feedback

Table Of Contents

Cisco Prime Collaboration 9.0 Quick Start Guide

Preface

Product Overview

Prime Collaboration Licensing

Access to the Software Image, PAK and License File

Prime Collaboration Assurance Licensing

Prime Collaboration Provisioning Licensing

Installation Requirements

Installing Prime Collaboration

Installing Prime Collaboration Assurance

Deploying the Prime Collaboration Assurance Application

Configuring the Prime Collaboration Assurance Virtual Appliance

Installing Prime Collaboration Provisioning

Deploying the Prime Collaboration Provisioning Virtual Appliance

Configuring the Prime Collaboration Provisioning Virtual Appliance

Getting Started

Getting Started with Prime Collaboration Assurance

Getting Started with Prime Collaboration Provisioning

Enabling SSL for Prime Collaboration Provisioning

Uninstalling Prime Collaboration

Related Documentation

Obtaining Documentation and Submitting a Service Request


Quick Start Guide

Cisco Prime Collaboration 9.0 Quick Start Guide


Revised: September 18, 2013, OL-27256-01

1 Preface

This guide explains how to install Cisco Prime Collaboration (Prime Collaboration) on virtualized servers.

This guide is targeted to administrators who monitor, maintain, and configure the IP telephony system and Cisco TelePresence System. The audience also incudes administrators who troubleshoot problems for Cisco TelePresence System and voice applications. These administrators must be conversant with the following 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 Unified CM Express, 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.


Note If you are already a user of UCMS and Prime Collaboration Manager, see
Cisco Prime Collaboration 9.0 Migration Guide to migrate to Prime Collaboration.


New and Changed Information

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

Date
Revision
Location
September 18, 2013

Updated details for third party SIP endpoints

Updated Prime Collaboration Assurance Licensing section with a note on impact of installing scale licenses.

License Category and Endpoint Type

Prime Collaboration Assurance Licensing

August 12, 2013

Categorized the Prime Collaboration Assurance scale license.

Prime Collaboration Assurance Licensing

June 18, 2013

Updated the Client Machine Requirements table

System Requirements

May 23, 2013

Updated the procedure for registering a new license file for Prime Collaboration Provisioning.

Getting Started with Prime Collaboration Provisioning

February 04, 2013

Updated the software image filenames.

Download Prime Collaboration


2 Product Overview

Cisco Prime Collaboration provides comprehensive voice and video network monitoring with diagnostics for the Cisco Collaboration systems, including the underlying transport infrastructure.

Prime Collaboration is a converged application, which eliminates the need to manage the video deployments separately from voice. It is delivered as two separate applications Prime Collaboration Assurance and Prime Collaboration Provisioning that are installed on separate virtual machines.

This converged application combines the benefits of Prime Collaboration Assurance and Prime Collaboration Provisioning.

Prime Collaboration Assurance application provides:

End-to-end service monitoring for Cisco Collaboration applications.

Real-time service troubleshooting and diagnostics for Cisco TelePresence Systems and Phones.

Video service readiness assessment with Cisco medianet.

Diagnostics tests using Cisco IP Service Level Agreements (IP SLA) and Video SLA Assessment Agent (VSAA).

Service-level and inventory reports for voice and video systems.

Prime Collaboration Provisioning application provides:

Standard services (phone, line, and voicemail, for example) to be ordered for subscribers (the owner of the individual phone, voicemail, or other service).

Configuration templates provide the ability to auto-configure the Cisco Unified Communications voice infrastructure in a consistent way.

Easy addition of Provisioning application to an existing Cisco Unified Communications network.

Simplified policy-driven Day 2 provisioning interface to manage subscribes and users.

A Self-Care feature that enables end users to set up lines, manage services, and configure phone options quickly and easily.

You can run these applications either as:

A converged application with a Single Sign-On. This mode provides a converged user interface with launch points for both Prime Collaboration Assurance and Prime Collaboration Provisioning features, or

Standalone applications with separate login. This mode provides a separate user interface for Prime Collaboration Assurance and Prime Collaboration Provisioning features.

For more information on Prime Collaboration features, see "Introduction to Prime Collaboration" chapter in the Cisco Prime Collaboration 9.0 Administration Guide.

3 Prime Collaboration Licensing

Prime Collaboration is a licensed software product that is secured to the MAC of the host server. Your Prime Collaboration license secures and enables the features and endpoint quantities for Prime Collaboration Assurance and Prime Collaboration Provisioning. Licensing is ordered based on the collaboration management options required (Assurance or Provisioning) and the endpoint type (Phone or Cisco TelePresence) and the quantity of those endpoints.

Access to the Software Image, PAK and License File

The product numbers ordered for Prime Collaboration are: R-xxx and L-xxx. They result in an email being sent to the ordering ship-to email address providing instructions to access the Cisco eDelivery site to download the software image(s) and license Product Authorization Keys (PAKs) you ordered. The software image is downloaded and installed on the host server. The license PAK ID from the ESD site allows you to access the Cisco Licensing Site to associate the server MAC address to a license key or keys that are then installed on the host server(s). These license keys activate the Prime Collaboration software to be used in a production environment. These license keys also convert a trial installation into a production environment.


Note The PAK is used to log in to the Cisco software site and has a MAC address associated to it. The PAK is e-mailed to you, and a license file is created for you to download. Note that individual license files are required for Prime Collaboration Assurance and Prime Collaboration Provisioning. After you download the license files, register them separately with the Prime Collaboration Assurance and Prime Collaboration Provisioning servers, respectively.


Prime Collaboration Assurance Licensing

Prime Collaboration Assurance provides licenses based on endpoint type and quantity. The type of an endpoint determines which licenses you need, and the quantity of the endpoints determines the tier and number of licenses that you need to purchase to manage your network.

The following license categories are supported:

Prime Collaboration Assurance Image (R-PC-version) license (required to activate in a production network)

Prime Collaboration Assurance Scale (L-PC) license:

High-end, single-codec endpoint

High-end, multi-codec endpoint

Midrange endpoints

Mass endpoints

You can manage up to 10,000 mass endpoints in the evaluation mode. You can purchase scale licenses based on the endpoints that you want to manage.

Note:

Scale licenses are cumulative: you can combine licenses to increase the number of endpoints you wish to manage.

Until a scale license is installed, some menu items in the UI are disabled.

For the Mass endpoint license tier, if you have purchased:

500 Mass endpoints license, you can manage up to 100 IP devices.

1000 Mass endpoints license, you can manage up to 300 IP devices.

1000-10000 Mass endpoints license, you can manage up to 2000 IP devices.

10000-60000 Mass endpoints license, you can manage up to 2500 IP devices.

60000 or more Mass endpoints license, you can manage up to 5000 IP devices.

To add Prime Collaboration Assurance license file, go to Administration > License Management (see Getting Started with Prime Collaboration Assurance).

For more details on Assurance licensing, see the Cisco Prime Collaboration Administration Guide.

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

Table 1 License Category and Endpoint Type 

License Category
Endpoint Type

High-end, multi-codec endpoints

Cisco TelePresence System 3000

Cisco TelePresence System 3010

Cisco TelePresence System 3200

Cisco TelePresence System 3210

Cisco TelePresence System TX9000

Cisco TelePresence System TX9200

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 endpoints

Cisco Codec EX60

Cisco Codec EX90

Cisco Codec C90

Cisco Codec C60

Cisco Codec C40

Cisco Codec C20

Cisco TelePresence System 150 MXP

Cisco TelePresence System 1000 MXP

Cisco Tandberg 1500 MXP

Cisco TelePresence System 1700 MXP

Cisco TelePresence System Codec 3000 MXP

Cisco TelePresence System Codec 6000 MXP

Cisco TelePresence System MX200

Cisco TelePresence System MX300

Cisco TelePresence System 500

Cisco TelePresence SX20 Quick Set

Polycom HDX1

Mass endpoints

Cisco IP Phones

Cisco Cius

Cisco Jabber Video for TelePresence (Movi)

Cisco IP Video Phone E20

1 Polycom HDX, registered with Unified CM as a third party SIP endpoint, can be managed using the Mass endpoint license. However, this endpoint will be managed as an IP audio phone and listed only in Phone reports. If this endpoint is registered with Cisco VCS, it can only be managed using the Midrange endpoint license.


Prime Collaboration Provisioning Licensing

The following types of licenses are available in Prime Collaboration Provisioning:

Prime Collaboration Provisioning Image (R-PC-version) license (required to activate in a production network)

Prime Collaboration Provisioning Scale (L-PC) license

Prime Collaboration Provisioning Application Program Interface Feature License (optional)

You can manage up to 10,000 phones in the evaluation mode. You can purchase additive licenses based on the phones that you want to manage.

To know the status of Prime Collaboration Provisioning license, go to Administration > License Management. To register a new license file, see Getting Started with Prime Collaboration Provisioning.

For more details on Provisioning licensing, see the Cisco Prime Collaboration Provisioning Guide.


Note Scale licenses are cumulative: you can combine licenses to increase the number of endpoints you wish to manage.


4 Installation Requirements

Table 2 lists the installation requirements. Ensure you follow the checklist before installing Prime Collaboration.

Table 2 Installation Requirements

Requirement
Description

Number of servers

Prime Collaboration Assurance and Prime Collaboration Provisioning applications must be installed on different virtual machines.

To learn about the installation modes and the required number of servers, see Number of Servers.

Virtualization requirements

The Prime Collaboration Assurance and Prime Collaboration Provisioning images are in the OVA file format.

To learn more about the VMware environment required, see VMware Requirements.

System requirements

System requirements vary based on the number of endpoints that you want to manage. See System Requirements.

Ports requirements

Prime Collaboration uses several protocols to communicate with other processes and devices. You must ensure that the required ports are available for Prime Collaboration to communicate. For more details, see Required Ports for Prime Collaboration.

Device configurations

(CTS-Manager, TMS, CUCM, VCS, Video endpoints, MCU, and so on)

The voice and video endpoints and infrastructure devices require certain configuration for the Prime Collaboration server to communicate. For more details, see Setting up Devices for Prime Collaboration.

Download images

Prime Collaboration images are provided on the eDelivery site and on the Cisco.com support software download site. You must have an order for an eDelivery or ESW contract.

User Accounts and Installation Prompts

During installation,

globaladmin, root user, and CLI user accounts are created. You must specify the password for these accounts.

See User Accounts, Password Rules for root User and globaladmin and Password Rules for CLI admin.

Virtual machine details must be specified.

See Installation Prompts


Number of Servers

The number of virtual machines required to install Prime Collaboration is as follows:

One virtual machine to install Prime Collaboration Assurance.

Additional virtual machines to install Prime Collaboration Provisioning. The required number of virtual machines depends on the number of phones that you want to manage:

If you have less than or equal to 10,000 phones (small and medium deployment models), you need one virtual machine where you can install both database and application. To learn about configuring Prime Collaboration Provisioning for small and medium deployment models, see Simple Configuration.

If you have more than 10,000 phones (large and very large deployment models), you need two virtual machines to install database and application separately on each machine. To learn about configuring Prime Collaboration Provisioning for large and very large deployment models, see Advanced Configuration.

Before installing, ensure you know IP addresses for each of the virtual machines as specified above.

System Requirements

Prime Collaboration runs on any VMware-certified hardware with ESXi 4.1 or 5.0 installed. Large and very large deployment models require ESXi 5.0.


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

Prime Collaboration allows you to configure a second NIC (network adapter). To understand how to configure a second NIC, see Troubleshooting Cisco Prime Collaboration.


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

Virtual Machine Requirements for Prime Collaboration Assurance

Table 3 lists the virtual machine requirements for Prime Collaboration Assurance application, based on the number of endpoints managed in Prime Collaboration.

Table 3 Virtual Machine Requirements for Prime Collaboration Assurance

Endpoints Managed in Prime Collaboration

Number of CPUs

CPU Reservation

RAM

Memory Reservation

NIC

Disk Space

Up to 1000 endpoints (Small)

4

3.98 GHz

8 GB

8 GB

1 GB

150 GB

Up to 10,000 endpoints (Medium)

8

3.98 GHz

16 GB

16 GB

1 GB

200 GB

Up to 100,000 endpoints (Large)

12

20 GHz

24 GB

24 GB

1 GB

500 GB

Up to 150,000 endpoints (Very Large)

18

30 GHz

32 GB

32 GB

1 GB

750 GB



NoteHyperthreading must be disabled in the server (BIOS level) for better performance of Prime Collaboration. This is to avoid CPU-related issues that may occur if hyperthreading is enabled. See your hardware documentation for information about disabling hyperthreading.

vCPU speed is dependent on the UCS server or the virtualized hardware.

We do not support oversubscribing server parameters (not using a 1:1 ratio of physical to virtual resources), such as, vCPU and memory.


Virtual Machine Requirements for Provisioning

Table 4 lists the virtual machine requirements for Prime Collaboration Provisioning application, based on the number of endpoints managed in Prime Collaboration.

Table 4 Virtual Machine Requirements for Prime Collaboration Provisioning

Endpoints Managed in Prime Collaboration

Number of CPUs

CPU Reservation

RAM

Memory Reservation

NIC

Disk Space

Up to 1000 endpoints (Small)

1

2 GHz

2 GB

2 GB

1 GB

90 GB

Up to 10,000 endpoints (Medium)

4

3.98 GHz

8 GB

8 GB

1 GB

120 GB

Up to 100,000 endpoints (Application Server) (Large)

8

3.98 GHz

16 GB

16 GB

1 GB

120 GB

Up to 100,000 endpoints (Database Server) (Large)

8

3.98 GHz

16 GB

16 GB

1 GB

120 GB

Up to 150,000 endpoints (Application Server) (Very Large)

8

3.98 GHz

16 GB

16 GB

1 GB

150 GB

Up to 150,000 endpoints (Database Server) (Very Large)

8

3.98 GHz

16 GB

16 GB

1 GB

150 GB



Note Prime Collaboration Provisioning performance is reduced when the read and write latency on the datastore is high. Ensure that the average read and write latency on the datastore is less than two msec.


Client Machine Requirements

Table 5 lists the client machine requirements for effective use of Prime Collaboration.

Table 5 Client Machine Requirements 

Parameter

Requirement

Display Resolution

1440 x 900

Supported Browser

The following browsers are supported:

Mozilla Firefox - ESR 10.0.x and 15. For information about ESR, see: http://www.mozilla.org/en-US/firefox/organizations/faq/)

Windows Internet Explorer 8.0 and 9.0

Prime Collaboration provides a self-signed certificate (HTTPS). To allow access of the Prime Collaboration 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.

Prime Collaboration uses popup dialog boxes at several instances. You must disable the popup-blocker if you have installed it.

Adobe Flash Player

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

Environment

Clients must be able to access Cisco Prime Collaboration:

From outside a firewall-Refer to your firewall documentation for information on how to configure client access.

Across a Virtual Private Network (VPN)-The VPN tunnel should connect the client and a VPN router or similar device.
See Required Ports for Prime Collaboration.


VMware Requirements

Ensure that your VMware environment meets the following requirements:

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

You need to download two OVAs, one each for Prime Collaboration Assurance and Prime Collaboration Provisioning.


Note For Prime Collaboration Provisioning, as a standalone, you need to download an OVA and configure it separately for database and application installation on two different virtual machines if you have more than 10,000 phones.


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


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 Prime Collaboration

Prime Collaboration images are provided on the eDelivery site and on the Cisco.com support software download site. You must have an order for an eDelivery or ESW contract.

If you need to install only Prime Collaboration Assurance, download a Prime Collaboration Assurance OVA based on the number of endpoints that you wish to manage.

Prime Collaboration Assurance application can be configured for the following types of deployment models:

Cisco Prime Collaboration 9.0 assurance OVA for small deployment- <cpc-assurance-9.0.0-24376-small.ova> if you have up to 1000 endpoints (which include less than 100 TelePresence systems)

Cisco Prime Collaboration 9.0 assurance OVA for medium deployment- <cpc-assurance-9.0.0-24376-medium.ova> if you have up to 10,000 endpoints (which include less than 1000 TelePresence systems)

Cisco Prime Collaboration 9.0 assurance OVA for large deployment- <cpc-assurance-9.0.0-24376-large.ova> if you have up to 100,000 endpoints (which include less than 10000 TelePresence systems)

Cisco Prime Collaboration 9.0 assurance OVA for very large deployment- <cpc-assurance-9.0.0-24376-verylarge.ova> if you have up to 150,000 endpoints (which include less than 10000 TelePresence systems)


Note To upgrade your deployment model in order to manage more endpoints, you must run a tuning script. For more information on the tuning script for Prime Collaboration Assurance, see "Upgrading the Deployment Model" in Troubleshooting Cisco Prime Collaboration.


If you need to install only Prime Collaboration Provisioning, download a Prime Collaboration Provisioning OVA based on the number of endpoints that you wish to manage.

Prime Collaboration Provisioning application can be configured for the following types of deployment models:

Cisco Prime Collaboration 9.0 provisioning OVA for small deployment- <cpc-provisioning-9.0.0-21342-small.ova> if you have up to 1000 phones

Cisco Prime Collaboration 9.0 provisioning OVA for medium deployment- <cpc-provisioning-9.0.0-21342-medium.ova> if you have up to 10,000 phones

Cisco Prime Collaboration 9.0 provisioning OVA for large deployment- <cpc-provisioning-9.0.0-21342-large.ova> if you have up to 100,000 phones

Cisco Prime Collaboration 9.0 provisioning OVA for very large deployment- <cpc-provisioning-9.0.0-21342-verylarge.ova> if you have up to 150,000 phones

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

See Setting up Devices for Prime Collaboration for information about setting up the devices in your network for Prime Collaboration.

User Accounts

For Prime Collaboration, you will be required to specify various passwords at different instances. This section is designed to help you specify appropriate passwords in several scenarios that demand your login credentials (applicable for both converged application as well as standalone Prime Collaboration Assurance and Prime Collaboration Provisioning applications).

globaladmin- is a superuser who can access both Prime Collaboration Assurance and Prime Collaboration Provisioning UI.

globaladmin password- specify this password when you configure your virtual appliance for either standalone or converged application. See Configuring the Prime Collaboration Assurance Virtual Appliance and Configuring the Prime Collaboration Provisioning Virtual Appliance. You are also required to specify this password when you login to the UI (see Password Rules for root User and globaladmin).

In Prime Collaboration Provisioning, this password is synched with the password of postgres admin (to perform backup and restore operations). Password will then be updated in the database and in the /opt/cupm/sep/dfc.properties file. You must login as a root user to access dfc.properties file.


Note If you plan to install both Prime Collaboration Assurance and Prime Collaboration Provisioning, ensure that you specify the same password for both applications during installation.


CLI Admin Username—The user name is admin, by default. However, you can specify the user name of your choice.

CLI Admin Password—Specify a password for the SSH CLI admin. This password is used to log in to CLI to check the application status and perform back up and restore (see Password Rules for CLI admin).

CLI is supported only through SSH; telnet is not supported. You can login through SSH using port 26 and port 22 to log in to Provisioning.

Root user—superuser who has all privileges in CLI.

Root password—specify a password for the root user (see Password Rules for root User and globaladmin).

Password Rules for root User and globaladmin

Must contain at least one of each: lowercase letter, uppercase letter, number, and special characters.

No character in the password may be repeated more than three times consecutively.

Cannot contain non-ASCII characters, %, +, and &.

Cannot be cisco or ocsic or any variant obtained by changing the capitalization of letters therein, or by substituting 1,!, or | for i, substituting 0 for o, or substituting $ for s.

Cannot be same as the username, and cannot be the username reversed.

Must contain from 8 to 80 characters.

Cannot end with these characters: *, ; or #.


Caution We recommend that you write down the root password, as it cannot be retrieved.


NoteTo change the root password, you must log in as root user and execute the "passwd" command, which prompts you for a new password.

If you are planning to integrate Provisioning and Assurance servers, make sure that you adhere to the Assurance-specific globaladmin password rules while setting up / creating the password for globaladmin in Provisioning.


Password Rules for CLI admin

Must contain atleast six characters.

Must contain at least one of each: lowercase letter, uppercase letter, and number.

Must not be the same as the username itself.

Installation Prompts

It is recommended that you know the values (beforehand) for the following parameters as you are required to specify them at the console prompts while configuring the virtual appliance:

IP Address—The IP address of the virtual appliance

IP default netmask—The default subnet mask for the IP address

IP default gateway—The IP address of the default gateway

Default DNS domain—The default Domain Name

Primary nameserver—The primary name server. You may add the name server. To configure several name servers, enter y.

Primary NTP server[time.nist.gov]—The primary NTP server

To enter a secondary NTP server, enter y at the next prompt.


Note To configure a tertiary NTP server enter y at the next prompt, after you specify a secondary NTP server.
Prime Collaboration 9.0 supports three NTP servers.


Timezone—The timestamp that is displayed on the UI is the server time. By default, the configured time zone is UTC. For a list of supported time zones, see Supported Timezones for Prime Collaboration. You must use the same time zone for Prime Collaboration Assurance and Prime Collaboration Provisioning servers in converged mode.

Username—CLI Admin user name. The user name is admin, by default. However, you can specify the user name of your choice.

Password—CLI Admin password. This password is used to log in to CLI to check the application status and perform back up and restore.

Root user—superuser who has all privileges in CLI.

Root password—specify a password for the root user.

globaladmin— superuser who can access both Prime Collaboration Assurance and Prime Collaboration Provisioning UI.

globaladmin password— specify a password for the globaladmin.

5 Installing Prime Collaboration

Prime Collaboration is delivered in two separate installable OVAs- Prime Collaboration Assurance and Prime Collaboration Provisioning.

During installation, you must install applications in a standalone mode.

However, Prime Collaboration provides an option for you to converge the Prime Collaboration Assurance and Prime Collaboration Provisioning servers using the Prime Collaboration Assurance user interface. To learn about integrating Prime Collaboration Assurance and Prime Collaboration Provisioning applications, see the "Integrating Prime Collaboration Servers" chapter in the Cisco Prime Collaboration 9.0 Administration Guide.

Installing Prime Collaboration entails the following:

Installing Prime Collaboration Assurance

Installing Prime Collaboration Provisioning

Installing Prime Collaboration Assurance

Installing Prime Collaboration Assurance encompasses Deploying the Prime Collaboration Assurance Application and Configuring the Prime Collaboration Assurance Virtual Appliance.

Deploying the Prime Collaboration Assurance Application

Ensure that requirements listed in Installation Requirements and System Requirements have been met.

To deploy the Prime Collaboration Assurance OVA:


Step 1 Launch your VMWare vSphere client and choose File > Deploy OVF Template.

Step 2 In the Deploy OVF Template window, click Deploy from file.

Step 3 Click Browse and navigate to the location where you have saved the Prime Collaboration Assurance OVA (cpc-assurance-9.0.0-24376-<deployment model>.ova) file.

Step 4 Click Next.

Step 5 In the OVF Template Details window, verify the details about the OVA file, including the product name, version, and the size, then click Next.

Step 6 Click Accept to accept the end-user license agreement. 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. Click Next.

Step 8 In the Disk Format window, select Thick provisioned format to store on the virtual disks, then click Next.

Step 9 Verify the options in the Ready to Complete window, then click Finish to start the deployment.

The deployment takes about 30 minutes to complete. Check the progress bar in the Deploying Virtual Appliance window to monitor the task status.

Step 10 After the deployment task has completed, click Close in the confirmation message box.

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

As a part of the next process, follow Configuring the Prime Collaboration Assurance Virtual Appliance.


Configuring the Prime Collaboration Assurance Virtual Appliance

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

To configure the virtual appliance:


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

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. The virtual machine reboots.


Note Time zone—The timestamp that is displayed on the UI is the server time. By default, the configured time zone is UTC. For a list of supported time zones, see Supported Timezones for Prime Collaboration. You must use the same time zone for Prime Collaboration Assurance and Prime Collaboration Provisioning servers in converged mode.


Step 4 After you finish the installation (when you see the login prompt in console), wait approximately 20 minutes for the Prime Collaboration Assurance processes to be listed on the console, and then log in to the Prime Collaboration Assurance UI.

Step 5 Log in to Prime Collaboration Assurance server to verify the installation. See the "Verifying the Prime Collaboration Assurance Installation" section in Troubleshooting Cisco Prime Collaboration.


Note To stop and start the Prime Collaboration Assurance services, log in as admin and execute the following commands:
<hostname>/admin#application stop cpcm
<hostname>/admin#application start cpcm
The start cpcm command takes 10 to 15 minutes to execute, and the stop cpcm command takes about 10 minutes.



Installing Prime Collaboration Provisioning

Installing Prime Collaboration Provisioning encompasses Deploying the Prime Collaboration Provisioning Virtual Appliance and Configuring the Prime Collaboration Provisioning Virtual Appliance.

You can install Prime Collaboration Provisioning application, based on the OVA you have downloaded:

For small and medium deployment models: you need one virtual machine only to install and configure Prime Collaboration Provisioning. To learn about configuring these deployment models, see Simple Configuration.

For large and very large deployment models: you must configure Prime Collaboration Provisioning OVA for database and application on separate virtual machines. Ensure that you install database before the application. To learn about configuring these deployment models, see Advanced Configuration.

Deploying the Prime Collaboration Provisioning Virtual Appliance

Ensure that requirements listed in Installation Requirements and System Requirements have been met.

To deploy the Prime Collaboration Provisioning OVA:


Step 1 Launch your VMWare vSphere client.

Step 2 Choose File > Deploy OVF Template.

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

Step 4 Click Browse and navigate to the location where you have saved the Prime Collaboration Provisioning OVA (cpc-provisioning-9.0.0-21342-<deployment model>.ova) file.

Step 5 Click Next.

Step 6 In the OVF Template Details window, verify the details about the OVA file, including the product name, version, and the size, then click Next.

Step 7 Click Accept to accept the end-user license agreement. Click Next.

Step 8 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 9 Click Next.

Step 10 In the Disk Format window, select Thick provisioned format to store on the virtual disks, then click Next.

Step 11 Verify the options in the Ready to Complete window, then click Finish to start the deployment.

The deployment takes approximately thirty minutes to complete. Check the progress bar in the Deploying Virtual Appliance window to monitor the task status.

Step 12 After the deployment task has completed, click Close in the confirmation message box.

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

As a part of the next process, follow Configuring the Prime Collaboration Provisioning Virtual Appliance.


Configuring the Prime Collaboration Provisioning Virtual Appliance

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

Based on the OVA you have downloaded, you can configure Prime Collaboration Provisioning virtual appliance as follows:

Simple configuration (see Simple Configuration)

Advanced configuration (see Advanced Configuration)

Simple Configuration

You can configure Prime Collaboration Provisioning OVA for small and medium deployment models.

To do a simple configuration of 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. Refer to the Installation Requirements section. After entering each parameter, press Enter to bring up the next parameter. The virtual machine reboots.


Note Time zone—The timestamp that is displayed on the UI is the server time. By default, the configured time zone is UTC. For a list of supported time zones, see Supported Timezones for Prime Collaboration. You must use the same time zone for Prime Collaboration Assurance and Prime Collaboration Provisioning servers in converged mode.


Step 4 After you finish the installation (when you see the login prompt in console), wait approximately 10 minutes for the Prime Collaboration Provisioning processes to be listed on the console and then login to the Prime Collaboration Provisioning UI.

Step 5 Log in to Prime Collaboration Provisioning server to verify the installation. See the "Verifying the Prime Collaboration Provisioning Installation" section in Troubleshooting Cisco Prime Collaboration.


Note To stop and start the Prime Collaboration Provisioning services, log in as admin and execute the following commands:
<hostname>/admin#application stop cpcm
<hostname>/admin#application start cpcm
These commands take approximately five minutes to complete execution.



Advanced Configuration

You can configure Prime Collaboration Provisioning OVA for large and very large deployment models.

To do an advanced configuration of the virtual appliance:


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

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

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


Note Time zone—The timestamp that is displayed on the UI is the server time. By default, the configured time zone is UTC. For a list of supported time zones, see Supported Timezones for Prime Collaboration. You must use the same time zone for Prime Collaboration Assurance and Prime Collaboration Provisioning servers in converged mode.


Step 4 If you have downloaded large or very large deployment model (more than 10000 phones), you are prompted to enter the type of server to be configured:

You must configure database server before you configure the application server:

a. Choose option 1 to configure the current server as a database server.

b. Enter the IP address for the application server that is to be deployed next.
The virtual machine reboots.

Next, configure the application server:

a. Deploy the application server. See Deploying the Prime Collaboration Provisioning Virtual Appliance section.

b. Configure the application server, following the Steps 1 to 3.

c. Choose option 2 to configure the current server as an application server.

d. When you are prompted, enter the IP address of the database server that you have already configured.
The virtual machine reboots.

Step 5 After you finish the installation (when you see the login prompt in console), wait approximately 10 minutes for the Prime Collaboration Provisioning processes to be listed on the console, and then log in to the Prime Collaboration Provisioning UI.

Step 6 Log in to Prime Collaboration Provisioning server to verify the installation. See the "Verifying the Prime Collaboration Provisioning Installation" section in Troubleshooting Cisco Prime Collaboration.


Note To stop and start the Prime Collaboration Provisioning services, log in as admin and execute the following commands:
<hostname>/admin#application stop cpcm
<hostname>/admin#application start cpcm
These commands take approximately five minutes to complete execution.



6 Getting Started

You can invoke Prime Collaboration using the client browser.

To log in to the Prime Collaboration application:


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

For a converged mode, specify the IP address of Prime Collaboration Assurance; If you specify the IP address of the Prime Collaboration Provisioning application, you will be redirected to the or Prime Collaboration Assurance application.

However, for a standalone mode, specify the IP address of either Prime Collaboration Assurance or Prime Collaboration Provisioning application based on the UI that you want to launch.

Step 2 Enter either of the following:

http://IP Address

https://IP Address


NoteFor Prime Collaboration Assurance, HTTPS has been enabled by default; for Prime Collaboration Provisioning, HTTP has been enabled by default.
If you want HTTPS enabled for Prime Collaboration Provisioning, configure OpenSSL packages that are packaged with the Prime Collaboration Provisioning OVA. See Enabling SSL for Prime Collaboration Provisioning

You can use either the IP address or the hostname of the Prime Collaboration Assurance or Prime Collaboration Provisioning server. We recommend that you use the hostname if you have configured it in DNS.

CLI is supported only through SSH; telnet is not supported. The port used for Prime Collaboration Assurance is 26, for Prime Collaboration Provisioning it is 22.


Based 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 Collaboration uses a self-signed certificate.

Step 3 Remove the SSL certificate warning. See "Removing SSL Certificate Warning" in Troubleshooting Cisco Prime Collaboration.

The Prime Collaboration login page appears.

Step 4 In the Prime Collaboration login page, you must login as a globaladmin, using the same the credentials that you have specified during the configuration.

The dashboard data is populated only after you perform tasks listed in the tables that follow.


Getting Started with Prime Collaboration Assurance

After you install Prime Collaboration Assurance, you must perform the tasks listed in the following table:

 
Task and Description
Navigation in Prime Collaboration Assurance Application
See

Step 1 

Add a new license file

This step is optional if you are evaluating the product.

Administration > License Management

License Management

Step 2 

Manage Users and Roles

Add a new user

Administration > User Management

User Management

Step 3 

Define credentials

Enter the required device credentials to manage devices in Prime Collaboration. For more details, see Setting up Devices for Prime Collaboration.

Operate > Device Work Center > Manage Credentials

Managing Device Credentials

Step 4 

Discover CTS-Manager

Discover Cisco TMS

Discover CUCM

Discover VCS

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.

Operate > Device Work Center > Discover Devices

Discovering Devices

Step 5 

Verify Inventory

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

Operate > Device Work Center > Update Inventory

Managing Inventory

Step 6 

Import Sessions

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

To periodically import sessions from CTS-Manager, Cisco TMS, and Cisco TelePresence Multipoint Switch, define the polling interval based on your business needs, using Operate > Diagnose > Session Diagnostics > Import Sessions.

Operate > Diagnose > Session Diagnostics

Monitoring Sessions

Step 7 

Verify Sessions

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

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

Operate > Diagnose > Session Diagnostics

Monitoring Sessions

Getting Started with Prime Collaboration Provisioning

After you install Prime Collaboration Provisioning, you must perform the tasks listed in the following table:

 
Task and Description
Navigation in Prime Collaboration Provisioning Application
See

Step 1 

Register a new license file.

This step is optional if you are evaluating the product.

1. Log in as root through sftp.

2. Copy the license file to the opt/cupm/license directory on the Provisioning server.

The system validates the license file and updates the license. The updated licensing information appears on the License Status Information page (Administration > License Management).

If the license status is not refreshed after a few minutes, go to the License Management page (choose Administration > System Configuration License Management), and click Perform Audit. The license status is updated in the Licence Management page (Administration > License Management).

Setting Up the Server

Step 2 

Add, configure, and synchronize call processors and message processors.

Design > Set Up Devices > Devices Setup

Managing Devices

Step 3 

Set up domain deployment

Create domains and assign call and message processors

Create service areas

Configure rules

Synchronize domain

Design > Set Up Deployment

Managing Domains and Service Areas

Step 4 

Create and deploy templates to configure Cisco UCM, or Infrastructure Configuration.

Design > Set Up Deployment > Provisioning Template, or Deploy > Infrastructure Configuration

Infrastructure Configuration

Step 5 

Assign subscribers types to service area

Deploy > Subscriber Management > Add Subscribers

Managing Subscribers and Users

Step 6 

Add a new user

Administration > User Management

Managing Subscribers and Users

Step 7 

Provisioning subscriber services

Deploy > Order Management

Managing Orders


Note After installation, you can integrate Prime Collaboration Provisioning application with Prime Collaboration Assurance using the Prime Collaboration Assurance UI. To learn how to integrate Prime Collaboration Provisioning with Prime Collaboration Assurance, see Integrating Prime Collaboration Servers chapter of the Cisco Prime Collaboration 9.0 Administration Guide.


Quick Access to System Setup and Manage Network

The Prime Collaboration landing page appears along with a pop-up to get started where you can optionally click links listed under "System Setup" and "Manage Network" to perform initial configuration of the Prime Collaboration server.

User Interface

If you have installed the Prime Collaboration Assurance as a standalone application, the following tabs are displayed on the UI: Home, Operate, Report, and Administration.

If you have installed the Prime Collaboration Provisioning as a standalone application, the following tabs are displayed on the UI: Home, Design, Deploy, Reports, and Administration.

Enabling SSL for Prime Collaboration Provisioning

Ensure you detach the Prime Collaboration Provisioning from Prime Collaboration Assurance before you enable OpenSSL.

Enabling OpenSSL and Generating a Certificate


Step 1 Download OpenSSL0.9.8s-PC-Linux_64_bit.zip from Cisco.com and extract the zip file to any folder on your local machine.

Step 2 Make a backup of bin, lib, modules folders. You must back up the ssl folder if it already exists.

Step 3 Log in as root user in the Provisioning server and copy the following (extracted) folders to /opt/cupm/httpd:

bin/

lib/

modules/

ssl/


Note While copying the files if you are prompted to overwrite existing files, choose "Yes to All". Ensure that you have chosen "Autoselect" format while copying files through SSH file transfer.


Step 4 Create links from the new lib files (to the Operating System library files) as follows:

ln -s /opt/cupm/httpd/lib/libssl.so.0.9.8 /lib64
ln -s /opt/cupm/httpd/lib/libcrypto.so.0.9.8 /lib64

Step 5 Navigate to /opt/cupm/httpd/bin directory and run the following command for access permissions:

chmod 777 openssl

Step 6 Run the following command to create a key:

./openssl genrsa -out /opt/cupm/httpd/mycorp.com.key 1024

Step 7 Run the following command create the ssl certificate:

./openssl req -new -key /opt/cupm/httpd/mycorp.com.key -x509 -out /opt/cupm/httpd/mycorpcom.crt -days 365

where, "mycorpcom.crt" is the certificate name and "mycorp.com.key" is the key name

The key and certificate files will now be created in the opt/cupm/httpd folder.

Sample Output:

Country Name (2 letter code) [AU]:US

State or Province Name (full name) [Some-State]:CA

Locality Name (eg, city)[ ]:CA

Organization Name (eg, company) [Internet Widgits Pty Ltd]:mycorp, LLC

Organizational Unit Name (eg, section)[ ]:Sales

Common Name (eg, YOUR name)[ ]:

Email Address [ ]:you@mycorp.com

Step 8 Update the following lines in the /opt/cupm/httpd/conf/ssl.conf file to map the certificate with the key file:

Replace SSLCertificateFile conf/server.crt with SSLCertificateFile /opt/cupm/httpd/mycorpcom.crt

Replace SSLCertificateKeyFile conf/server.key with SSLCertificateKeyFile /opt/cupm/httpd/mycorp.com.key

Step 9 Configure the Apache Server (see Configuring the Apache Server).

Configuring the Apache Server


Step 1 In the Prime Collaboration Provisioning system, make a backup of the httpd.conf file located at /opt/cupm/httpd/conf.

Step 2 In the httpd.conf file, comment the following tags only (and not the content within these tags) using vi editor:

#<IfModule mod_ssl.c>

#</IfModule>

Step 3 In the ssl.conf file, uncomment the following tags only (and not the content within these tags). The default SSL port is 443.

<IfDefine SSL>

</IfDefine>

Ensure that the following lines are present in the ssl.conf file:

Listen 443

<VirtualHost _default_:443>

ServerName host.your-domain.com:443

Step 4 Restart the Apache server using the following command:

      /opt/cupm/httpd/bin# ./apachectl -k stop
      /opt/cupm/httpd/bin# ./apachectl -k start -DSSL


NoteTo enable https by default when you start the Prime Collaboration Provisioning application, modify the following lines in the "/opt/cupm/cupm-full-service.sh" and "opt/cupm/cupm-app-service.sh" files. You can then restart the Prime Collaboration Provisioning services:

$PM_BASE/httpd/bin/apachectl -k start & as $PM_BASE/httpd/bin/apachectl -k start -DSSL &

$PM_BASE/httpd/bin/apachectl -k stop & as $PM_BASE/httpd/bin/apachectl -k stop -DSSL &

You can check if the ports 80 or 443 are enabled (listening), using the following command from the SSH console,

#lsof -i :443

#lsof -i :80

We recommend that you configure port 443 in the ssl.conf file. If you need to change the port number, in the ssl.conf file, change "Listen 443" to the required port.

If you want to exclusively run HTTPS only, you must disable HTTP by commenting out "Listen 80" in the /opt/cupm/httpd/conf/httpd.conf file, and then restart the Apache server.


Changing the SSL Port

If the standalone Prime Collaboration Provisioning application is installed on a co-resident system, you must change the port used for SSL by one of the applications.

To change the port used for SSL by Prime Collaboration Provisioning:


Step 1 In the Prime Collaboration Provisioning system, open the ssl.conf file (located at /opt/cupm/httpd/conf).

Step 2 Change the port number in the following lines:

Listen 443

VirtualHost _default_:443

Step 3 Save the changes and close the file.

Step 4 Restart the Apache server.


Note After you change the port number, you must enter the new port number when you access Prime Collaboration Provisioning application. For example, https://hostname:443.



7 Uninstalling Prime Collaboration

The uninstallation process applies to both Prime Collaboration Assurance and Prime Collaboration Provisioning:


Note Before you uninstall Prime Collaboration, ensure that you delete all the node-to-node tests from the application. If you do not delete these tests, they will continue to run on the router.



Step 1 Log in to vSphere client and connect to the ESXi server that is running the virtual appliance that you want to uninstall.

Step 2 Right-click the Prime Collaboration Assurance or Prime Collaboration Provisioning virtual appliance and choose Power > Shut Down Guest (or choose Power Off).

Step 3 Right-click the Prime Collaboration Assurance or Prime Collaboration Provisioning virtual appliance and choose Delete from disk in the Confirm Delete window.


8 Related Documentation

This guide is one of multiple short guides for Cisco Prime Collaboration 9.0. To perform other Prime Collaboration tasks, such as user management, device management, voice provisioning, network monitoring, and fault management, see Cisco Prime Collaboration 9.0 Documentation Overview for a list of all available documents.

Also, you can search for specific Prime Collaboration related information using the Search this Category search engine available at http://www.cisco.com/en/US/products/ps12363/tsd_products_support_series_home.html.

9 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.