Cisco Prime Collaboration 9.0 Quick Start Guide

1 Preface

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:

2 Product Overview

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.

•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

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.

1Polycom 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)

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.

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.

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

Note•Hyperthreading 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.

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.

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.

•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

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.

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

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

Note•To 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, seeSupported 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.

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.

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, seeSupported 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.

Installing Prime Collaboration Provisioning

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.

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, seeSupported 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.

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 cpcmThese 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 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, seeSupported 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.

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.

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 cpcmThese 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 Requirementsfor 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

Note•For 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.

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.

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

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:

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

Note•To 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:

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.

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:

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.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)

Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.