DocWiki - User contributions [en]

Category:Unified CCE, Release 9.0

2012-07-25T21:43:23Z

Jbeaudry:

{| border="1" class="wikitable"
!style="background-color:#FFE0C8;"| Introduction
|-
|This page lists all troubleshooting tips for UCCE Release 9.0.
|-
|If you encounter the following scenarios, feel free to add to our initial list:
* You find a new, valid tip and would like to share it with other Unified Expert Advisor users.
* You discover an easier solution/process/workaround to an existing issue.
|-
|If you want to '''ask a question''', '''post a comment''', or '''discuss an issue''' regarding a specific article:

::# Log in
::# Navigate to the article in question
::# Click the '''Discussion''' tab at the top of the page
::# Edit the Discussion page as described above under Editing
::# To start a different thread under a new subheading on the Discussion page, click the '''+''' tab at the top of the page instead of the Edit tab.

|-
!style="background-color:#FFE0C8;"| '''Navigation'''
|-
|'''Back:''' [[Troubleshooting Unified CCE]]

'''Add tip:''' [[Create Contact Center Troubleshooting Tips]]
|-
|}

Category talk:Unified Customer Voice Portal

2011-06-22T16:38:44Z

Jbeaudry: New page: I think we need a link on this main jump page to the CVP content present on the Virtualization section: http://docwiki.cisco.com/wiki/Virtualization_for_Unified_CVP Otherwise, people have...

I think we need a link on this main jump page to the CVP content present on the Virtualization section:
http://docwiki.cisco.com/wiki/Virtualization_for_Unified_CVP

Otherwise, people have to know to first search for "UC virtualization", then realize there's a CVP-specific sub-section. That's not an intuitive workflow. Thanks.

File:P6.jpg

2010-10-06T20:16:05Z

Jbeaudry:

File:P7.jpg

2010-10-06T20:15:45Z

Jbeaudry:

File:P8.jpg

2010-10-06T20:15:16Z

Jbeaudry:

File:P9.jpg

2010-10-06T20:14:59Z

Jbeaudry:

File:P10.jpg

2010-10-06T20:14:31Z

Jbeaudry:

File:P11.jpg

2010-10-06T20:14:07Z

Jbeaudry:

File:P12.jpg

2010-10-06T20:13:51Z

Jbeaudry:

File:P13.jpg

2010-10-06T20:13:34Z

Jbeaudry:

File:P14.jpg

2010-10-06T20:13:15Z

Jbeaudry:

File:P15.jpg

2010-10-06T20:12:54Z

Jbeaudry:

File:P16.jpg

2010-10-06T20:12:37Z

Jbeaudry:

File:P5.jpg

2010-10-06T20:12:17Z

Jbeaudry:

File:P4.jpg

2010-10-06T20:11:56Z

Jbeaudry:

File:P3.jpg

2010-10-06T20:11:33Z

Jbeaudry:

File:P2.jpg

2010-10-06T20:11:16Z

Jbeaudry:

File:P1.jpg

2010-10-06T20:09:15Z

Jbeaudry:

CVP Reporting Server Configuration

2010-10-06T19:58:01Z

Jbeaudry:

== Login to SAN ==

Open a browser (Java plug-in is required for this application) and direct to EMC access

Enter your Login Info:
Once you are logged in you should see this

[[Image:P1.jpg]]

Now, navigate to "Storage Pools"

[[Image:P2.jpg]]

Right Click on "RAID Groups"

[[Image:P3.jpg]]

From the "RAID Type:" Choose either RAID 5 or RAID 10 based on your selection.

=== RAID 5 ===

[[Image:P4.jpg]]

=== RAID 10 ===

[[Image:P5.jpg]]

'''Next Step:'''

Create *Logical Unit Number (LUN)*

Now, right click on your +RAID Group+ _{+}ID{+}_ and select *Create LUN...* option

[[Image:P6.jpg]]

On the configuration page, leave everything as default and click on *Apply*

[[Image:P7.jpg]]

A confirmation message window will appear, please select *Yes* to continue.

[[Image:P8.jpg]]

You should see the following message if you have successfully created LUN:

[[Image:P9.jpg]]

Now, you should be able to see the new created LUN under the "*LUN Folders*"

[[Image:P10.jpg]]

Now right click and Select Option of "+Add to Storage Group...+"

[[Image:P11.jpg]]

On the assign page:

[[Image:P12.jpg]]

Click on the arrow "->" and click *OK*

[[Image:P13.jpg]]

Confirmation message pop-up window:

[[Image:P14.jpg]]

Success message will appear.

[[Image:P15.jpg]]

You should now see it under your "Storage Groups"

[[Image:P16.jpg]]

'''You will be able to see Disk available from the VMWare station that has access to the Hosts you assigned to the Storage Groups.'''

Unified Customer Voice Portal

2010-10-06T19:56:04Z

Jbeaudry: /* System Performance Monitoring Using Windows Perfmon Counters */

== Updates to this Page ==

The following is a list of significant updates to this page:

{| class="wikitable"

|-
! Date
! Update

|-
| September 24, 2010
| Distribution of Cisco UCS Unified CVP DocWiki for Tech review.
|-
| September 25, 2010
| Cleaned up IOPS tables, product naming conventions, section consistency with Unified CCE UCS wiki.
|-
| September 26, 2010
| Validated links, performed spell check, noted areas still requiring additional technical review.
|-
| September 27, 2010
| Updated feedback to the following areas: Information for Partners, VMWare and Application Software Requirements, UCS Network Configuration, Configuring ESXi datastore.
|-
|September 28, 2010
|Updated feedback to the following sections: Modified link to Information for Partners; Unified CVP 8.0(1) Support for Virtualization on the ESXi/UCS Platform (Modified bullet that referred to 'Distributed'; Coresidency (Deleted references to realtime; Modified last bullet regarding support on Blade.) '''
|-
|September 30, 2010
| Unified CVP Virtualization information posted to Unified Communications Virtualization Wiki.

|}

== Information for Partners about Cisco Unified CVP on UCS Deployment Certification and Ordering ==
'''It is important that partners who are planning to sell UCS products on Unified Cisco Customer Voice Portal, read the ''' '''[http://docwiki.cisco.com/wiki/Unified_Contact_Center_Enterprise Unified CCE DocWiki page].'''

This page contains essential information for partners about the following:

:* Partner Certification Requirements
:* UCS Server Ordering Information
:* Important Notes on Cisco UCS Service and Support

== Unified CVP 8.0(1) Support for Virtualization on the ESXi/UCS Platform ==
Starting with Release 8.0(1), virtualization of the following deployments and Unified CVP components on Cisco Unified Communications Systems (UCS) B-Series hardware is supported:
:* Unified CVP Call Server
:* Unified CVP VXML Server
:* Unified CVP Reporting Server
:* Unified CVP Ops Console

The following deployments and Unified CVP components have not been qualified and '''are not supported''' in virtualization:
:* H323 Call flow Deployment
:* Distributed VXML Server and Call Server deployment where each server runs in a separate VM
:* All in one lab deployment with small reporting server

The following VMware features are not supported with Unified CVP:
:* VMware Physical to Virtual migration
:* VMware Snapshots
:* VMware Consolidated Backup
:* VMware High Availability (HA)
:* VMware Site Recovery Manager
:* VMware vCenter Update Manager
:* VMware vCenter Converter

== UCS Hardware Requirements ==
Requirements for Cisco Unified Customer Voice Portal using UCS B200 M1 hardware are located [[Unified_Computing_System_Hardware#B-200_M1_Requirements|here]].

== VMware and Application Software Requirements ==

The following software requirements apply specifically to Unified Customer Voice Portal:

:* VMWare ESXi 4.0 only, minimum version 4.0U1. Versions of ESXi prior to 4.0U1 and all versions of ESX are unsupported.
:* The Windows, Informix, and other third party software requirements for the Unified CVP applications in the ESXi/UCS platform are the same as in the physical server. For such information, refer to the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/cvp8_0/installation/guide/cvp_801_install.pdf Hardware and System Software Specification for Cisco Unified Customer Voice Portal, Release 8.0(1)].

== UCS Network Configuration ==

'''IMPORTANT:''' For instructions on performing the network configuration needed to deploy Cisco Unified Customer Voice Portal (Unified CVP) on a virtualized platform, please see below.

'''1) TCP Setting modification on Reporting Server'''
It is highly recommended that customers modify the default "Number of Receive Buffers" setting on the Reporting server to maximize full reporting and call load on the virtualized platform. If this setting is not modified after installing the OS, messages will get backed up on the CallServer and Message Queues will fill up resulting in a sharp drop in cps rate.

* Set the "Number of Receive buffers" on the Reporting Server TCP settings to 4096 (max).
Instructions:
# On Reporting server, click on Control Panel->Network Connection.
# Right click on Network Connection.
# Click on advanced tab.
# Under property tab, select "Number of Receive Buffers".
# In the Value pulldown, enter 4096.
# Restart the Reporting Server.

'''2) Use TCP protocol over UDP for SIP Comprehensive call flow as a SIP Best Practice''' Use TCP for SIP Comprehensive call flows. Using UDP may cause call setup failures or may result in abnormally long calls under heavy load. Typically TCP should be set on all call legs, but it is a requirement on the ingress leg. This can be set on the POTS dialpeer by setting the session transport to tcp.

'''3) Cisco VLAN trunking to VMWare'''
For information on best practices for Cisco VLAN trunking to VMware, refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware website ].

=== Support for Unified Communications Manager Clustering Over the WAN with Unified CVP on UCS Hardware ===

You can deploy the Unified Communications Manager (Unified CM) Clustering Over the WAN deployment model with Unified CVP on UCS B-series hardware.

When you implement this deployment model, be sure to follow the best practices outlined in the section "Multiple Cisco Unified CM Clusters" in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf Cisco Unified CVP Solution Reference Network Design (SRND) ].

In addition, note the following expectation for UCS B-series hardware points of failure:

* Multiple points of failure on the Unified CVP UCS B-series HA deployment can cause catastrophic failure, such as ICM software failovers and interruption of service. If multiple points of failure occur, replace the failed redundant components and links immediately.

* '''B-Series Considerations'''
When deploying Clustering Over the WAN with B-Series hardware, use of the Cisco UCS M81KR Virtual Interface Card is mandatory.

New B-Series deployments using Clustering Over the WAN must use a Nexus 7000 Series / Nexus 5000 Series vPC infrastructure, or a Cisco Catalyst 6500 Series Virtual Switching Supervisor Engine 720-10G.

== Notes for Deploying Unified CVP Applications on UCS B-Series Hardware with SAN ==

In Storage Area Network (SAN) architecture, storage consists of a series of arrays of Redundant Array of Independent Disks (RAIDs). A Logical Unit Number (LUN) that represents a device identifier can be created on a RAID array. A LUN can occupy all or part of a single RAID array, or span multiple RAID arrays.

In a virtualized environment, datastores are created on LUNs. Virtual Machines (VMs) are installed on the SAN datastore.

Keep the following considerations in mind when deploying Unified CVP 
 applications on UCS B-series hardware with SAN:

'''Compliance Considerations'''
* A SAN RAID group must be dedicated to Unified CVP database components; these SAN RAID groups must not be shared by other applications. The SAN disk array must be configured as RAID 10, for added performance and fault tolerance. SAN solutions are typically deployed in a shared environment where multiple applications are contending for storage access. If the SAN storage deployment is identified as affecting the functions of the contact center solution, the customer will be required to deploy a direct attached storage solution instead. Moreover, if in the process of troubleshooting, the SAN itself is identified as the problem, the customer must contact the system integrator or the SAN vendor for resolution.

'''Design Considerations'''
* The SAN must be designed in accordance with the UCS High Availability guidelines documented at [http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html].
* The SAN design and configuration must meet the Unified CVP IOPS and Performance numbers described in the [[Unified_Customer_Voice_Portal#Performance_Requirements|Performance Requirements]].
* The SAN design and configuration must meet the following VMware ESXi disk performance guidelines:
** Disk Command Latency – It should be 15 mSec or less. 15mSec latencies or greater indicates a possible over-utilized, mis-behaving, or mis-configured disk array.
'''Configuration Considerations'''
*For UCS B-series, Virtual Machines must be stored on and booted from the SAN.
** Kernel Disk Command Latency – It should be very small in comparison to the Physical Device Command Latency, and it should be close to zero. A high Kernel Command Latency indicates there is a lot of queuing in the ESXi kernel.
* The SAN design and configuration must meet the following Windows performance counters on Unified CVP VMs:
** AverageDiskQueueLength must remain less than (1.5 ∗ (the total number of disks in the array)).
** %Disktime must remain less than 60%.
* Any given SAN array must be designed to have an IOPS capacity exceeding the sum of the IOPS required for all resident UC applications. Unified CVP applications should be designed for the 95th percentile IOPS values published in this wiki. Refer to the Performance Requirements section below for additional information. For other UC applications, please follow their respective IOPS requirements and guidelines.
'''Storage/Size Considerations'''
*Unified CVP requires application storage to be on VMFS. Raw Device Mapping (RDM) is not supported.
* The total size of all Virtual Machines on a disk (total size = VM disk + RAM copy) must not exceed 90% of the capacity of a datastore.
'''Input/Output Operations per Second (IOPS) Considerations'''
* IOPS utilization should be monitored for each application to ensure that the aggregate IOPS is not exceeding the capacity of the array. Prolonged buffering of IOPS against an array may result in degraded system performance and delayed reporting data availability. Refer to the Performance Requirements section below for additional information.
'''Maintenance Considerations'''
* To help keep your system running most efficiently, schedule automatic database purging and database backups to run when your system is least busy.
'''Support Considerations'''
* The ESXi boot from SAN feature is not supported; it must be installed to internal storage.

== Steps for Installing Unified CVP Components on Virtual Machines ==
Follow the steps and references below to install or migrate the Unified CVP components on Virtual Machines.
# Install, setup, and configure the UCS Hardware.
# Configure the UCS Network. See reference at [[Unified_Contact_Center_Enterprise#UCS_Network_Configuration|UCS Network Configuration]].
# Install and Boot VMWare ESXi. Refer to the following installation guide: [http://www.cisco.com/en/US/docs/unified_computing/ucs/sw/b/os/vmware/install/bseries-vmware-install.html Cisco UCS B-Series Blade Servers VMware Installation Guide].
# Create the Unified CVP Virtual Machines from the OVA template. OVA templates are available [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y here ]
# Install Windows OS and Websphere Application Server (if using VXML Server with WAS) on the created Virtual Machines. (Note: Microsoft Windows Server 2003 ''Standard Edition'' should be used for virtual machine guests. See related information in the links below.)
#Install Unified CVP Software components on the configured Virtual Machines. See install reference for installing Unified CVP Components in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/cvp8_0/installation/guide/cvp_801_install.pdf Unified CVP Install and Upgrade guide].

== Unified CVP Component Capacities and VM Configuration Requirements ==

This section provides details associated with [[Unified_Communications_VMWare_Requirements|VM requirements]].

This table shows the supported Unified CVP components, their capacities, and the VM computing resource requirements.   You must use the OVA virtual machine templates to create the Unified CVP component VMs.

{| class="wikitable"
|-
! Unified CVP Component
! vCPU
! RAM (GB)
! vDisk (GB)
! vNIC
! Template Name

|-
| Unified CVP Call Server/VXML Server/co-located Call Server and VXML Server
| 4 vCPU
| 4 GB
| 146 GB
| 1 vNIC
| Cisco Unified CVP Call Server-VXML Server.ova

|-
| Unified CVP Reporting Server (Large)
| 4 vCPU
| 4 GB
| Disk 1 - 72 GB, Disk 2 - 438 GB
| 1 vNIC
| Cisco Unified CVP Reporting Server.ova

|-
| Unified CVP Operations Console
| 2 vCPU
| 2 GB RAM
| 20 GB
| 1 vNIC
| Cisco Unified CVP Operations Console.ova

|}

== Unified CVP Component Co-Residency ==

You can have one or more Unified CVP VMs co-resident on the same ESXi server.  However, you must follow the rules described below:
:* You can have any number of Unified CVP virtual machines and combination of co-residency of Unified CVP virtual machines on an ESXi server as long as the sum of all the virtual machine CPU and memory resource allocation is not over committed on the available ESXi server computing resources. 
:* You must not have CPU overcommitted on the ESXi server that is running Unified CVP application components .  The total number of vCPUs among all the virtual machines on an ESXi host must not greater than the total number of CPUs available on the ESXi server.  In the case of the Cisco UCS B-200 M1, the total number of CPUs available is 8.
:* You must not have memory overcommitted on the ESXi host that is running UC realtime applications.  You must allocate minimum 2GB of memory for the ESXi kernel.  For example, if an ESXi server on B-200 M1 hardware has 36GB of memory, after you allocate 2GB for the ESXi kernel, you have 34GB available for the virtual machines.  The total memory allocated for all the virtual machines on an ESXi server must not be greater than 34GB in this case.
:* VM co-residency with Unified Communications and third party applications were not tested on the same blade with Unified CVP products. '''

== Creating Virtual Machines from OVA VM Templates ==

Open Virtualization Format (OVF) is an open standard for packaging and distributing virtual appliances.  Files in this format have an extension of .ova. The naming convention for the template is PRODUCT_COMPONENT_USER COUNT_VERSION_VMVER.ova

Follow the instructions in the Downloading OVA Templates section below to download the OVA templates from cisco.com to a local datastore that vSphere Client can access.

=== Downloading OVA Templates ===
:*Proceed to the [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y Cisco Download Page for CVP].

:*To download a single OVA file, click the '''Download File''' button next to that file. To download multiple OVA files, click the '''Add to Cart''' button next to each file that you want to download, then click on the '''Download Cart''' link. A Download Cart page appears.

:*Click the '''Proceed with Download''' button on this page. A Software License Agreement page appears.

:*Read the Software License Agreement, then click the '''Agree''' button

:*On the next page, click on either the '''Download Manager''' link (requires Java) or the '''Non Java Download Option''' link. A new browser window appears.

:*If you selected Download Manager, a Select Location dialog box appears. Specify the location where you want to save the file, and click '''Open''' to save the file to your local machine.

:*If you selected Non Java Download Option, click the '''Download''' link on the new browser window. Specify the location and save the file to your local machine.

=== Creating Virtual Machines by Deploying the OVA Templates ===

In the vSphere client, perform the following steps to deploy the Virtual machines.

# Highlight the host or cluster to which you wish the VM to be deployed.
# Select '''File''' > '''Deploy OVF Template'''.
# Click the '''Deploy from File''' radio button and specify the name and location of the file you downloaded in the previous section '''or''' click the '''Deploy from URL''' radio button and specify the complete URL in the field, then click '''Next'''.
#Verify the details of the template, and click '''Next'''.
#Give the VM you are about to create a name, and choose an inventory location on your host, then click '''Next'''.
#Choose the datastore on which you would like the VM to reside - be sure there is sufficient free space to accommodate the new VM, then click '''Next'''.
#Choose a virtual network for the VM, then click '''Next'''.
#Verify the deployment settings, then click '''Finish'''.

=== Notes ===
:* VM CPU affinity is not supported. You do not need to set CPU affinity for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform.
:* VM resource Reservation - VM resource reservation is not supported for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform. The VM computing resources should have a default reservation setting, which is no resource reservations.
:* You cannot change the computing resource configuration of your VM at any time.
:* You can never go below the minimum VM computing resource requirements as defined in the OVA templates.
:* It is required that hyperthreading be enabled by default when running CVP on ESXi. ESXi Server hyperthread is enabled by default and this setting should not be modified. Please ensure all VM's with CVP servers has hyperthreading enabled.

== Remote Control of the Virtual Machines ==

For administrative tasks, you can use either Windows Remote Desktop or the VMware Infrastructure Client for remote control.

== Installing VMware Tools==

The VMware Tools must be installed on each of the VMs and all of the VMware Tools default settings should be used. Please refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware documentation] for instructions on installing or upgrading VMware Tools on the VM with Windows operating system.

== Installing Unified CVP Components on Virtual Machines ==
You can install the Unified CVP components after the configuration of the VMs. Installation of these Unified CVP components on a VM is the same as the installation of these components on physical hardware.

Refer to the Unified CVP documentation for the steps to install Unified CVP components. You can install the supported Virus Scan software, the Cisco Security Agent (CSA), or any other software in the same way as on physical hardware.

== Configuring the ESXi Data Store Block Size for Administration and Data Server ==

The creation of the virtual machine for the Unified CVP Reporting Server requires a large virtual disk size. You must follow the steps described below to configure the ESXi data store size to 438 GB for it to handle the Unified CVP Reporting Server data before you deploy the OVAs

Steps to configure the ESXi for CVP Reporting server to RAID10 found at [[ CVP Reporting Server Configuration ]]

== Performance Requirements ==

:* CPU usage (average) should not exceed 60% for the ESXi Server and for each of the individual processors, and for each VM.
:* Memory usage (average) should not exceed 80% for the ESXi Server and for each of the VMs.
:* VM snapshots are not supported in production since they have significant impact on system performance. 
:* The SAN must be able to handle the following Unified CVP application disk I/O characteristics.
:* Enable hyperthreading on all ESXi servers.

== Performance Numbers on B-Series ==

'''HTTP Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 900
|-
| VXML Standalone
| 900
|-
| VXML Standalone with Req ICM Label (VXML Server on Tomcat)
| 900
|-
| VXML Standalone on WAS
| 900
|-
| VXML Standalone with Req ICM Label on WAS
| 900
|}

'''HTTPS Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 275
|-
| VXML Standalone
| 275
|-
| VXML Standalone on WAS
| 275
|}

== VM IOPS Measurement ==

'''IOPS Summary: (Unit in Number, Data are Blade-based)'''
{| class="wikitable"
|-
!CVP Server
!Average
!MAX
!95th Percentile
|-
|CS/VXML Servers
|380
|1536
|797
|-
|Reporting Server
|692
|3403
|2024
|}

== Timekeeping Best Practices for Windows ==

You should follow the best practices outlined in the VMware Knowledge Base article [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1318 VMware KB: Timekeeping best practices for Windows].
* ESXi hosts and domain controllers should synchronize the time from the same NTP source.
* When Unified Unified CVP virtual machines join the domain, they synchronize the time with the domain controller automatically using w32time.
* Be sure that '''Time synchronization between the virtual machine and the host operating system''' in the VMware Tools tool box GUI of the Windows Server 2003 guest operating system remains deselected; this checkbox is deselected by default.

== System Performance Monitoring Using Windows Perfmon Counters ==

You must comply with the best practices described in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf SRND section System Performance Monitoring].

-----
Back to [[Unified_Communications_Virtualization|Unified Communications Virtualization main page]]

Unified Customer Voice Portal

2010-10-06T19:54:50Z

Jbeaudry: /* Unified CVP Component Capacities and VM Configuration Requirements */

== Updates to this Page ==

The following is a list of significant updates to this page:

{| class="wikitable"

|-
! Date
! Update

|-
| September 24, 2010
| Distribution of Cisco UCS Unified CVP DocWiki for Tech review.
|-
| September 25, 2010
| Cleaned up IOPS tables, product naming conventions, section consistency with Unified CCE UCS wiki.
|-
| September 26, 2010
| Validated links, performed spell check, noted areas still requiring additional technical review.
|-
| September 27, 2010
| Updated feedback to the following areas: Information for Partners, VMWare and Application Software Requirements, UCS Network Configuration, Configuring ESXi datastore.
|-
|September 28, 2010
|Updated feedback to the following sections: Modified link to Information for Partners; Unified CVP 8.0(1) Support for Virtualization on the ESXi/UCS Platform (Modified bullet that referred to 'Distributed'; Coresidency (Deleted references to realtime; Modified last bullet regarding support on Blade.) '''
|-
|September 30, 2010
| Unified CVP Virtualization information posted to Unified Communications Virtualization Wiki.

|}

== Information for Partners about Cisco Unified CVP on UCS Deployment Certification and Ordering ==
'''It is important that partners who are planning to sell UCS products on Unified Cisco Customer Voice Portal, read the ''' '''[http://docwiki.cisco.com/wiki/Unified_Contact_Center_Enterprise Unified CCE DocWiki page].'''

This page contains essential information for partners about the following:

:* Partner Certification Requirements
:* UCS Server Ordering Information
:* Important Notes on Cisco UCS Service and Support

== Unified CVP 8.0(1) Support for Virtualization on the ESXi/UCS Platform ==
Starting with Release 8.0(1), virtualization of the following deployments and Unified CVP components on Cisco Unified Communications Systems (UCS) B-Series hardware is supported:
:* Unified CVP Call Server
:* Unified CVP VXML Server
:* Unified CVP Reporting Server
:* Unified CVP Ops Console

The following deployments and Unified CVP components have not been qualified and '''are not supported''' in virtualization:
:* H323 Call flow Deployment
:* Distributed VXML Server and Call Server deployment where each server runs in a separate VM
:* All in one lab deployment with small reporting server

The following VMware features are not supported with Unified CVP:
:* VMware Physical to Virtual migration
:* VMware Snapshots
:* VMware Consolidated Backup
:* VMware High Availability (HA)
:* VMware Site Recovery Manager
:* VMware vCenter Update Manager
:* VMware vCenter Converter

== UCS Hardware Requirements ==
Requirements for Cisco Unified Customer Voice Portal using UCS B200 M1 hardware are located [[Unified_Computing_System_Hardware#B-200_M1_Requirements|here]].

== VMware and Application Software Requirements ==

The following software requirements apply specifically to Unified Customer Voice Portal:

:* VMWare ESXi 4.0 only, minimum version 4.0U1. Versions of ESXi prior to 4.0U1 and all versions of ESX are unsupported.
:* The Windows, Informix, and other third party software requirements for the Unified CVP applications in the ESXi/UCS platform are the same as in the physical server. For such information, refer to the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/cvp8_0/installation/guide/cvp_801_install.pdf Hardware and System Software Specification for Cisco Unified Customer Voice Portal, Release 8.0(1)].

== UCS Network Configuration ==

'''IMPORTANT:''' For instructions on performing the network configuration needed to deploy Cisco Unified Customer Voice Portal (Unified CVP) on a virtualized platform, please see below.

'''1) TCP Setting modification on Reporting Server'''
It is highly recommended that customers modify the default "Number of Receive Buffers" setting on the Reporting server to maximize full reporting and call load on the virtualized platform. If this setting is not modified after installing the OS, messages will get backed up on the CallServer and Message Queues will fill up resulting in a sharp drop in cps rate.

* Set the "Number of Receive buffers" on the Reporting Server TCP settings to 4096 (max).
Instructions:
# On Reporting server, click on Control Panel->Network Connection.
# Right click on Network Connection.
# Click on advanced tab.
# Under property tab, select "Number of Receive Buffers".
# In the Value pulldown, enter 4096.
# Restart the Reporting Server.

'''2) Use TCP protocol over UDP for SIP Comprehensive call flow as a SIP Best Practice''' Use TCP for SIP Comprehensive call flows. Using UDP may cause call setup failures or may result in abnormally long calls under heavy load. Typically TCP should be set on all call legs, but it is a requirement on the ingress leg. This can be set on the POTS dialpeer by setting the session transport to tcp.

'''3) Cisco VLAN trunking to VMWare'''
For information on best practices for Cisco VLAN trunking to VMware, refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware website ].

=== Support for Unified Communications Manager Clustering Over the WAN with Unified CVP on UCS Hardware ===

You can deploy the Unified Communications Manager (Unified CM) Clustering Over the WAN deployment model with Unified CVP on UCS B-series hardware.

When you implement this deployment model, be sure to follow the best practices outlined in the section "Multiple Cisco Unified CM Clusters" in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf Cisco Unified CVP Solution Reference Network Design (SRND) ].

In addition, note the following expectation for UCS B-series hardware points of failure:

* Multiple points of failure on the Unified CVP UCS B-series HA deployment can cause catastrophic failure, such as ICM software failovers and interruption of service. If multiple points of failure occur, replace the failed redundant components and links immediately.

* '''B-Series Considerations'''
When deploying Clustering Over the WAN with B-Series hardware, use of the Cisco UCS M81KR Virtual Interface Card is mandatory.

New B-Series deployments using Clustering Over the WAN must use a Nexus 7000 Series / Nexus 5000 Series vPC infrastructure, or a Cisco Catalyst 6500 Series Virtual Switching Supervisor Engine 720-10G.

== Notes for Deploying Unified CVP Applications on UCS B-Series Hardware with SAN ==

In Storage Area Network (SAN) architecture, storage consists of a series of arrays of Redundant Array of Independent Disks (RAIDs). A Logical Unit Number (LUN) that represents a device identifier can be created on a RAID array. A LUN can occupy all or part of a single RAID array, or span multiple RAID arrays.

In a virtualized environment, datastores are created on LUNs. Virtual Machines (VMs) are installed on the SAN datastore.

Keep the following considerations in mind when deploying Unified CVP 
 applications on UCS B-series hardware with SAN:

'''Compliance Considerations'''
* A SAN RAID group must be dedicated to Unified CVP database components; these SAN RAID groups must not be shared by other applications. The SAN disk array must be configured as RAID 10, for added performance and fault tolerance. SAN solutions are typically deployed in a shared environment where multiple applications are contending for storage access. If the SAN storage deployment is identified as affecting the functions of the contact center solution, the customer will be required to deploy a direct attached storage solution instead. Moreover, if in the process of troubleshooting, the SAN itself is identified as the problem, the customer must contact the system integrator or the SAN vendor for resolution.

'''Design Considerations'''
* The SAN must be designed in accordance with the UCS High Availability guidelines documented at [http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html].
* The SAN design and configuration must meet the Unified CVP IOPS and Performance numbers described in the [[Unified_Customer_Voice_Portal#Performance_Requirements|Performance Requirements]].
* The SAN design and configuration must meet the following VMware ESXi disk performance guidelines:
** Disk Command Latency – It should be 15 mSec or less. 15mSec latencies or greater indicates a possible over-utilized, mis-behaving, or mis-configured disk array.
'''Configuration Considerations'''
*For UCS B-series, Virtual Machines must be stored on and booted from the SAN.
** Kernel Disk Command Latency – It should be very small in comparison to the Physical Device Command Latency, and it should be close to zero. A high Kernel Command Latency indicates there is a lot of queuing in the ESXi kernel.
* The SAN design and configuration must meet the following Windows performance counters on Unified CVP VMs:
** AverageDiskQueueLength must remain less than (1.5 ∗ (the total number of disks in the array)).
** %Disktime must remain less than 60%.
* Any given SAN array must be designed to have an IOPS capacity exceeding the sum of the IOPS required for all resident UC applications. Unified CVP applications should be designed for the 95th percentile IOPS values published in this wiki. Refer to the Performance Requirements section below for additional information. For other UC applications, please follow their respective IOPS requirements and guidelines.
'''Storage/Size Considerations'''
*Unified CVP requires application storage to be on VMFS. Raw Device Mapping (RDM) is not supported.
* The total size of all Virtual Machines on a disk (total size = VM disk + RAM copy) must not exceed 90% of the capacity of a datastore.
'''Input/Output Operations per Second (IOPS) Considerations'''
* IOPS utilization should be monitored for each application to ensure that the aggregate IOPS is not exceeding the capacity of the array. Prolonged buffering of IOPS against an array may result in degraded system performance and delayed reporting data availability. Refer to the Performance Requirements section below for additional information.
'''Maintenance Considerations'''
* To help keep your system running most efficiently, schedule automatic database purging and database backups to run when your system is least busy.
'''Support Considerations'''
* The ESXi boot from SAN feature is not supported; it must be installed to internal storage.

== Steps for Installing Unified CVP Components on Virtual Machines ==
Follow the steps and references below to install or migrate the Unified CVP components on Virtual Machines.
# Install, setup, and configure the UCS Hardware.
# Configure the UCS Network. See reference at [[Unified_Contact_Center_Enterprise#UCS_Network_Configuration|UCS Network Configuration]].
# Install and Boot VMWare ESXi. Refer to the following installation guide: [http://www.cisco.com/en/US/docs/unified_computing/ucs/sw/b/os/vmware/install/bseries-vmware-install.html Cisco UCS B-Series Blade Servers VMware Installation Guide].
# Create the Unified CVP Virtual Machines from the OVA template. OVA templates are available [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y here ]
# Install Windows OS and Websphere Application Server (if using VXML Server with WAS) on the created Virtual Machines. (Note: Microsoft Windows Server 2003 ''Standard Edition'' should be used for virtual machine guests. See related information in the links below.)
#Install Unified CVP Software components on the configured Virtual Machines. See install reference for installing Unified CVP Components in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/cvp8_0/installation/guide/cvp_801_install.pdf Unified CVP Install and Upgrade guide].

== Unified CVP Component Capacities and VM Configuration Requirements ==

This section provides details associated with [[Unified_Communications_VMWare_Requirements|VM requirements]].

This table shows the supported Unified CVP components, their capacities, and the VM computing resource requirements.   You must use the OVA virtual machine templates to create the Unified CVP component VMs.

{| class="wikitable"
|-
! Unified CVP Component
! vCPU
! RAM (GB)
! vDisk (GB)
! vNIC
! Template Name

|-
| Unified CVP Call Server/VXML Server/co-located Call Server and VXML Server
| 4 vCPU
| 4 GB
| 146 GB
| 1 vNIC
| Cisco Unified CVP Call Server-VXML Server.ova

|-
| Unified CVP Reporting Server (Large)
| 4 vCPU
| 4 GB
| Disk 1 - 72 GB, Disk 2 - 438 GB
| 1 vNIC
| Cisco Unified CVP Reporting Server.ova

|-
| Unified CVP Operations Console
| 2 vCPU
| 2 GB RAM
| 20 GB
| 1 vNIC
| Cisco Unified CVP Operations Console.ova

|}

== Unified CVP Component Co-Residency ==

You can have one or more Unified CVP VMs co-resident on the same ESXi server.  However, you must follow the rules described below:
:* You can have any number of Unified CVP virtual machines and combination of co-residency of Unified CVP virtual machines on an ESXi server as long as the sum of all the virtual machine CPU and memory resource allocation is not over committed on the available ESXi server computing resources. 
:* You must not have CPU overcommitted on the ESXi server that is running Unified CVP application components .  The total number of vCPUs among all the virtual machines on an ESXi host must not greater than the total number of CPUs available on the ESXi server.  In the case of the Cisco UCS B-200 M1, the total number of CPUs available is 8.
:* You must not have memory overcommitted on the ESXi host that is running UC realtime applications.  You must allocate minimum 2GB of memory for the ESXi kernel.  For example, if an ESXi server on B-200 M1 hardware has 36GB of memory, after you allocate 2GB for the ESXi kernel, you have 34GB available for the virtual machines.  The total memory allocated for all the virtual machines on an ESXi server must not be greater than 34GB in this case.
:* VM co-residency with Unified Communications and third party applications were not tested on the same blade with Unified CVP products. '''

== Creating Virtual Machines from OVA VM Templates ==

Open Virtualization Format (OVF) is an open standard for packaging and distributing virtual appliances.  Files in this format have an extension of .ova. The naming convention for the template is PRODUCT_COMPONENT_USER COUNT_VERSION_VMVER.ova

Follow the instructions in the Downloading OVA Templates section below to download the OVA templates from cisco.com to a local datastore that vSphere Client can access.

=== Downloading OVA Templates ===
:*Proceed to the [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y Cisco Download Page for CVP].

:*To download a single OVA file, click the '''Download File''' button next to that file. To download multiple OVA files, click the '''Add to Cart''' button next to each file that you want to download, then click on the '''Download Cart''' link. A Download Cart page appears.

:*Click the '''Proceed with Download''' button on this page. A Software License Agreement page appears.

:*Read the Software License Agreement, then click the '''Agree''' button

:*On the next page, click on either the '''Download Manager''' link (requires Java) or the '''Non Java Download Option''' link. A new browser window appears.

:*If you selected Download Manager, a Select Location dialog box appears. Specify the location where you want to save the file, and click '''Open''' to save the file to your local machine.

:*If you selected Non Java Download Option, click the '''Download''' link on the new browser window. Specify the location and save the file to your local machine.

=== Creating Virtual Machines by Deploying the OVA Templates ===

In the vSphere client, perform the following steps to deploy the Virtual machines.

# Highlight the host or cluster to which you wish the VM to be deployed.
# Select '''File''' > '''Deploy OVF Template'''.
# Click the '''Deploy from File''' radio button and specify the name and location of the file you downloaded in the previous section '''or''' click the '''Deploy from URL''' radio button and specify the complete URL in the field, then click '''Next'''.
#Verify the details of the template, and click '''Next'''.
#Give the VM you are about to create a name, and choose an inventory location on your host, then click '''Next'''.
#Choose the datastore on which you would like the VM to reside - be sure there is sufficient free space to accommodate the new VM, then click '''Next'''.
#Choose a virtual network for the VM, then click '''Next'''.
#Verify the deployment settings, then click '''Finish'''.

=== Notes ===
:* VM CPU affinity is not supported. You do not need to set CPU affinity for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform.
:* VM resource Reservation - VM resource reservation is not supported for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform. The VM computing resources should have a default reservation setting, which is no resource reservations.
:* You cannot change the computing resource configuration of your VM at any time.
:* You can never go below the minimum VM computing resource requirements as defined in the OVA templates.
:* It is required that hyperthreading be enabled by default when running CVP on ESXi. ESXi Server hyperthread is enabled by default and this setting should not be modified. Please ensure all VM's with CVP servers has hyperthreading enabled.

== Remote Control of the Virtual Machines ==

For administrative tasks, you can use either Windows Remote Desktop or the VMware Infrastructure Client for remote control.

== Installing VMware Tools==

The VMware Tools must be installed on each of the VMs and all of the VMware Tools default settings should be used. Please refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware documentation] for instructions on installing or upgrading VMware Tools on the VM with Windows operating system.

== Installing Unified CVP Components on Virtual Machines ==
You can install the Unified CVP components after the configuration of the VMs. Installation of these Unified CVP components on a VM is the same as the installation of these components on physical hardware.

Refer to the Unified CVP documentation for the steps to install Unified CVP components. You can install the supported Virus Scan software, the Cisco Security Agent (CSA), or any other software in the same way as on physical hardware.

== Configuring the ESXi Data Store Block Size for Administration and Data Server ==

The creation of the virtual machine for the Unified CVP Reporting Server requires a large virtual disk size. You must follow the steps described below to configure the ESXi data store size to 438 GB for it to handle the Unified CVP Reporting Server data before you deploy the OVAs

Steps to configure the ESXi for CVP Reporting server to RAID10 found at [[ CVP Reporting Server Configuration ]]

== Performance Requirements ==

:* CPU usage (average) should not exceed 60% for the ESXi Server and for each of the individual processors, and for each VM.
:* Memory usage (average) should not exceed 80% for the ESXi Server and for each of the VMs.
:* VM snapshots are not supported in production since they have significant impact on system performance. 
:* The SAN must be able to handle the following Unified CVP application disk I/O characteristics.
:* Enable hyperthreading on all ESXi servers.

== Performance Numbers on B-Series ==

'''HTTP Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 900
|-
| VXML Standalone
| 900
|-
| VXML Standalone with Req ICM Label (VXML Server on Tomcat)
| 900
|-
| VXML Standalone on WAS
| 900
|-
| VXML Standalone with Req ICM Label on WAS
| 900
|}

'''HTTPS Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 275
|-
| VXML Standalone
| 275
|-
| VXML Standalone on WAS
| 275
|}

== VM IOPS Measurement ==

'''IOPS Summary: (Unit in Number, Data are Blade-based)'''
{| class="wikitable"
|-
!CVP Server
!Average
!MAX
!95th Percentile
|-
|CS/VXML Servers
|380
|1536
|797
|-
|Reporting Server
|692
|3403
|2024
|}

== Timekeeping Best Practices for Windows ==

You should follow the best practices outlined in the VMware Knowledge Base article [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1318 VMware KB: Timekeeping best practices for Windows].
* ESXi hosts and domain controllers should synchronize the time from the same NTP source.
* When Unified Unified CVP virtual machines join the domain, they synchronize the time with the domain controller automatically using w32time.
* Be sure that '''Time synchronization between the virtual machine and the host operating system''' in the VMware Tools tool box GUI of the Windows Server 2003 guest operating system remains deselected; this checkbox is deselected by default.

== System Performance Monitoring Using Windows Perfmon Counters ==

You must comply with the best practices described in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf SRND section System Performance Monitoring].

-----
Back to [http://docwiki-dev.cisco.com/wiki/Unified_Communications_Virtualization Unified Communications Virtualization main page]

Unified Customer Voice Portal

2010-10-06T19:53:47Z

Jbeaudry: /* Steps for Installing Unified CVP Components on Virtual Machines */

== Updates to this Page ==

The following is a list of significant updates to this page:

{| class="wikitable"

|-
! Date
! Update

|-
| September 24, 2010
| Distribution of Cisco UCS Unified CVP DocWiki for Tech review.
|-
| September 25, 2010
| Cleaned up IOPS tables, product naming conventions, section consistency with Unified CCE UCS wiki.
|-
| September 26, 2010
| Validated links, performed spell check, noted areas still requiring additional technical review.
|-
| September 27, 2010
| Updated feedback to the following areas: Information for Partners, VMWare and Application Software Requirements, UCS Network Configuration, Configuring ESXi datastore.
|-
|September 28, 2010
|Updated feedback to the following sections: Modified link to Information for Partners; Unified CVP 8.0(1) Support for Virtualization on the ESXi/UCS Platform (Modified bullet that referred to 'Distributed'; Coresidency (Deleted references to realtime; Modified last bullet regarding support on Blade.) '''
|-
|September 30, 2010
| Unified CVP Virtualization information posted to Unified Communications Virtualization Wiki.

|}

== Information for Partners about Cisco Unified CVP on UCS Deployment Certification and Ordering ==
'''It is important that partners who are planning to sell UCS products on Unified Cisco Customer Voice Portal, read the ''' '''[http://docwiki.cisco.com/wiki/Unified_Contact_Center_Enterprise Unified CCE DocWiki page].'''

This page contains essential information for partners about the following:

:* Partner Certification Requirements
:* UCS Server Ordering Information
:* Important Notes on Cisco UCS Service and Support

== Unified CVP 8.0(1) Support for Virtualization on the ESXi/UCS Platform ==
Starting with Release 8.0(1), virtualization of the following deployments and Unified CVP components on Cisco Unified Communications Systems (UCS) B-Series hardware is supported:
:* Unified CVP Call Server
:* Unified CVP VXML Server
:* Unified CVP Reporting Server
:* Unified CVP Ops Console

The following deployments and Unified CVP components have not been qualified and '''are not supported''' in virtualization:
:* H323 Call flow Deployment
:* Distributed VXML Server and Call Server deployment where each server runs in a separate VM
:* All in one lab deployment with small reporting server

The following VMware features are not supported with Unified CVP:
:* VMware Physical to Virtual migration
:* VMware Snapshots
:* VMware Consolidated Backup
:* VMware High Availability (HA)
:* VMware Site Recovery Manager
:* VMware vCenter Update Manager
:* VMware vCenter Converter

== UCS Hardware Requirements ==
Requirements for Cisco Unified Customer Voice Portal using UCS B200 M1 hardware are located [[Unified_Computing_System_Hardware#B-200_M1_Requirements|here]].

== VMware and Application Software Requirements ==

The following software requirements apply specifically to Unified Customer Voice Portal:

:* VMWare ESXi 4.0 only, minimum version 4.0U1. Versions of ESXi prior to 4.0U1 and all versions of ESX are unsupported.
:* The Windows, Informix, and other third party software requirements for the Unified CVP applications in the ESXi/UCS platform are the same as in the physical server. For such information, refer to the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/cvp8_0/installation/guide/cvp_801_install.pdf Hardware and System Software Specification for Cisco Unified Customer Voice Portal, Release 8.0(1)].

== UCS Network Configuration ==

'''IMPORTANT:''' For instructions on performing the network configuration needed to deploy Cisco Unified Customer Voice Portal (Unified CVP) on a virtualized platform, please see below.

'''1) TCP Setting modification on Reporting Server'''
It is highly recommended that customers modify the default "Number of Receive Buffers" setting on the Reporting server to maximize full reporting and call load on the virtualized platform. If this setting is not modified after installing the OS, messages will get backed up on the CallServer and Message Queues will fill up resulting in a sharp drop in cps rate.

* Set the "Number of Receive buffers" on the Reporting Server TCP settings to 4096 (max).
Instructions:
# On Reporting server, click on Control Panel->Network Connection.
# Right click on Network Connection.
# Click on advanced tab.
# Under property tab, select "Number of Receive Buffers".
# In the Value pulldown, enter 4096.
# Restart the Reporting Server.

'''2) Use TCP protocol over UDP for SIP Comprehensive call flow as a SIP Best Practice''' Use TCP for SIP Comprehensive call flows. Using UDP may cause call setup failures or may result in abnormally long calls under heavy load. Typically TCP should be set on all call legs, but it is a requirement on the ingress leg. This can be set on the POTS dialpeer by setting the session transport to tcp.

'''3) Cisco VLAN trunking to VMWare'''
For information on best practices for Cisco VLAN trunking to VMware, refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware website ].

=== Support for Unified Communications Manager Clustering Over the WAN with Unified CVP on UCS Hardware ===

You can deploy the Unified Communications Manager (Unified CM) Clustering Over the WAN deployment model with Unified CVP on UCS B-series hardware.

When you implement this deployment model, be sure to follow the best practices outlined in the section "Multiple Cisco Unified CM Clusters" in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf Cisco Unified CVP Solution Reference Network Design (SRND) ].

In addition, note the following expectation for UCS B-series hardware points of failure:

* Multiple points of failure on the Unified CVP UCS B-series HA deployment can cause catastrophic failure, such as ICM software failovers and interruption of service. If multiple points of failure occur, replace the failed redundant components and links immediately.

* '''B-Series Considerations'''
When deploying Clustering Over the WAN with B-Series hardware, use of the Cisco UCS M81KR Virtual Interface Card is mandatory.

New B-Series deployments using Clustering Over the WAN must use a Nexus 7000 Series / Nexus 5000 Series vPC infrastructure, or a Cisco Catalyst 6500 Series Virtual Switching Supervisor Engine 720-10G.

== Notes for Deploying Unified CVP Applications on UCS B-Series Hardware with SAN ==

In Storage Area Network (SAN) architecture, storage consists of a series of arrays of Redundant Array of Independent Disks (RAIDs). A Logical Unit Number (LUN) that represents a device identifier can be created on a RAID array. A LUN can occupy all or part of a single RAID array, or span multiple RAID arrays.

In a virtualized environment, datastores are created on LUNs. Virtual Machines (VMs) are installed on the SAN datastore.

Keep the following considerations in mind when deploying Unified CVP 
 applications on UCS B-series hardware with SAN:

'''Compliance Considerations'''
* A SAN RAID group must be dedicated to Unified CVP database components; these SAN RAID groups must not be shared by other applications. The SAN disk array must be configured as RAID 10, for added performance and fault tolerance. SAN solutions are typically deployed in a shared environment where multiple applications are contending for storage access. If the SAN storage deployment is identified as affecting the functions of the contact center solution, the customer will be required to deploy a direct attached storage solution instead. Moreover, if in the process of troubleshooting, the SAN itself is identified as the problem, the customer must contact the system integrator or the SAN vendor for resolution.

'''Design Considerations'''
* The SAN must be designed in accordance with the UCS High Availability guidelines documented at [http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html].
* The SAN design and configuration must meet the Unified CVP IOPS and Performance numbers described in the [[Unified_Customer_Voice_Portal#Performance_Requirements|Performance Requirements]].
* The SAN design and configuration must meet the following VMware ESXi disk performance guidelines:
** Disk Command Latency – It should be 15 mSec or less. 15mSec latencies or greater indicates a possible over-utilized, mis-behaving, or mis-configured disk array.
'''Configuration Considerations'''
*For UCS B-series, Virtual Machines must be stored on and booted from the SAN.
** Kernel Disk Command Latency – It should be very small in comparison to the Physical Device Command Latency, and it should be close to zero. A high Kernel Command Latency indicates there is a lot of queuing in the ESXi kernel.
* The SAN design and configuration must meet the following Windows performance counters on Unified CVP VMs:
** AverageDiskQueueLength must remain less than (1.5 ∗ (the total number of disks in the array)).
** %Disktime must remain less than 60%.
* Any given SAN array must be designed to have an IOPS capacity exceeding the sum of the IOPS required for all resident UC applications. Unified CVP applications should be designed for the 95th percentile IOPS values published in this wiki. Refer to the Performance Requirements section below for additional information. For other UC applications, please follow their respective IOPS requirements and guidelines.
'''Storage/Size Considerations'''
*Unified CVP requires application storage to be on VMFS. Raw Device Mapping (RDM) is not supported.
* The total size of all Virtual Machines on a disk (total size = VM disk + RAM copy) must not exceed 90% of the capacity of a datastore.
'''Input/Output Operations per Second (IOPS) Considerations'''
* IOPS utilization should be monitored for each application to ensure that the aggregate IOPS is not exceeding the capacity of the array. Prolonged buffering of IOPS against an array may result in degraded system performance and delayed reporting data availability. Refer to the Performance Requirements section below for additional information.
'''Maintenance Considerations'''
* To help keep your system running most efficiently, schedule automatic database purging and database backups to run when your system is least busy.
'''Support Considerations'''
* The ESXi boot from SAN feature is not supported; it must be installed to internal storage.

== Steps for Installing Unified CVP Components on Virtual Machines ==
Follow the steps and references below to install or migrate the Unified CVP components on Virtual Machines.
# Install, setup, and configure the UCS Hardware.
# Configure the UCS Network. See reference at [[Unified_Contact_Center_Enterprise#UCS_Network_Configuration|UCS Network Configuration]].
# Install and Boot VMWare ESXi. Refer to the following installation guide: [http://www.cisco.com/en/US/docs/unified_computing/ucs/sw/b/os/vmware/install/bseries-vmware-install.html Cisco UCS B-Series Blade Servers VMware Installation Guide].
# Create the Unified CVP Virtual Machines from the OVA template. OVA templates are available [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y here ]
# Install Windows OS and Websphere Application Server (if using VXML Server with WAS) on the created Virtual Machines. (Note: Microsoft Windows Server 2003 ''Standard Edition'' should be used for virtual machine guests. See related information in the links below.)
#Install Unified CVP Software components on the configured Virtual Machines. See install reference for installing Unified CVP Components in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/cvp8_0/installation/guide/cvp_801_install.pdf Unified CVP Install and Upgrade guide].

== Unified CVP Component Capacities and VM Configuration Requirements ==

This section provides details associated with VM requirements. http://docwiki-dev.cisco.com/wiki/Unified_Communications_VMWare_Requirements

This table shows the supported Unified CVP components, their capacities, and the VM computing resource requirements.   You must use the OVA virtual machine templates to create the Unified CVP component VMs.

{| class="wikitable"
|-
! Unified CVP Component
! vCPU
! RAM (GB)
! vDisk (GB)
! vNIC
! Template Name

|-
| Unified CVP Call Server/VXML Server/co-located Call Server and VXML Server
| 4 vCPU
| 4 GB
| 146 GB
| 1 vNIC
| Cisco Unified CVP Call Server-VXML Server.ova

|-
| Unified CVP Reporting Server (Large)
| 4 vCPU
| 4 GB
| Disk 1 - 72 GB, Disk 2 - 438 GB
| 1 vNIC
| Cisco Unified CVP Reporting Server.ova

|-
| Unified CVP Operations Console
| 2 vCPU
| 2 GB RAM
| 20 GB
| 1 vNIC
| Cisco Unified CVP Operations Console.ova

|}

== Unified CVP Component Co-Residency ==

You can have one or more Unified CVP VMs co-resident on the same ESXi server.  However, you must follow the rules described below:
:* You can have any number of Unified CVP virtual machines and combination of co-residency of Unified CVP virtual machines on an ESXi server as long as the sum of all the virtual machine CPU and memory resource allocation is not over committed on the available ESXi server computing resources. 
:* You must not have CPU overcommitted on the ESXi server that is running Unified CVP application components .  The total number of vCPUs among all the virtual machines on an ESXi host must not greater than the total number of CPUs available on the ESXi server.  In the case of the Cisco UCS B-200 M1, the total number of CPUs available is 8.
:* You must not have memory overcommitted on the ESXi host that is running UC realtime applications.  You must allocate minimum 2GB of memory for the ESXi kernel.  For example, if an ESXi server on B-200 M1 hardware has 36GB of memory, after you allocate 2GB for the ESXi kernel, you have 34GB available for the virtual machines.  The total memory allocated for all the virtual machines on an ESXi server must not be greater than 34GB in this case.
:* VM co-residency with Unified Communications and third party applications were not tested on the same blade with Unified CVP products. '''

== Creating Virtual Machines from OVA VM Templates ==

Open Virtualization Format (OVF) is an open standard for packaging and distributing virtual appliances.  Files in this format have an extension of .ova. The naming convention for the template is PRODUCT_COMPONENT_USER COUNT_VERSION_VMVER.ova

Follow the instructions in the Downloading OVA Templates section below to download the OVA templates from cisco.com to a local datastore that vSphere Client can access.

=== Downloading OVA Templates ===
:*Proceed to the [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y Cisco Download Page for CVP].

:*To download a single OVA file, click the '''Download File''' button next to that file. To download multiple OVA files, click the '''Add to Cart''' button next to each file that you want to download, then click on the '''Download Cart''' link. A Download Cart page appears.

:*Click the '''Proceed with Download''' button on this page. A Software License Agreement page appears.

:*Read the Software License Agreement, then click the '''Agree''' button

:*On the next page, click on either the '''Download Manager''' link (requires Java) or the '''Non Java Download Option''' link. A new browser window appears.

:*If you selected Download Manager, a Select Location dialog box appears. Specify the location where you want to save the file, and click '''Open''' to save the file to your local machine.

:*If you selected Non Java Download Option, click the '''Download''' link on the new browser window. Specify the location and save the file to your local machine.

=== Creating Virtual Machines by Deploying the OVA Templates ===

In the vSphere client, perform the following steps to deploy the Virtual machines.

# Highlight the host or cluster to which you wish the VM to be deployed.
# Select '''File''' > '''Deploy OVF Template'''.
# Click the '''Deploy from File''' radio button and specify the name and location of the file you downloaded in the previous section '''or''' click the '''Deploy from URL''' radio button and specify the complete URL in the field, then click '''Next'''.
#Verify the details of the template, and click '''Next'''.
#Give the VM you are about to create a name, and choose an inventory location on your host, then click '''Next'''.
#Choose the datastore on which you would like the VM to reside - be sure there is sufficient free space to accommodate the new VM, then click '''Next'''.
#Choose a virtual network for the VM, then click '''Next'''.
#Verify the deployment settings, then click '''Finish'''.

=== Notes ===
:* VM CPU affinity is not supported. You do not need to set CPU affinity for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform.
:* VM resource Reservation - VM resource reservation is not supported for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform. The VM computing resources should have a default reservation setting, which is no resource reservations.
:* You cannot change the computing resource configuration of your VM at any time.
:* You can never go below the minimum VM computing resource requirements as defined in the OVA templates.
:* It is required that hyperthreading be enabled by default when running CVP on ESXi. ESXi Server hyperthread is enabled by default and this setting should not be modified. Please ensure all VM's with CVP servers has hyperthreading enabled.

== Remote Control of the Virtual Machines ==

For administrative tasks, you can use either Windows Remote Desktop or the VMware Infrastructure Client for remote control.

== Installing VMware Tools==

The VMware Tools must be installed on each of the VMs and all of the VMware Tools default settings should be used. Please refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware documentation] for instructions on installing or upgrading VMware Tools on the VM with Windows operating system.

== Installing Unified CVP Components on Virtual Machines ==
You can install the Unified CVP components after the configuration of the VMs. Installation of these Unified CVP components on a VM is the same as the installation of these components on physical hardware.

Refer to the Unified CVP documentation for the steps to install Unified CVP components. You can install the supported Virus Scan software, the Cisco Security Agent (CSA), or any other software in the same way as on physical hardware.

== Configuring the ESXi Data Store Block Size for Administration and Data Server ==

The creation of the virtual machine for the Unified CVP Reporting Server requires a large virtual disk size. You must follow the steps described below to configure the ESXi data store size to 438 GB for it to handle the Unified CVP Reporting Server data before you deploy the OVAs

Steps to configure the ESXi for CVP Reporting server to RAID10 found at [[ CVP Reporting Server Configuration ]]

== Performance Requirements ==

:* CPU usage (average) should not exceed 60% for the ESXi Server and for each of the individual processors, and for each VM.
:* Memory usage (average) should not exceed 80% for the ESXi Server and for each of the VMs.
:* VM snapshots are not supported in production since they have significant impact on system performance. 
:* The SAN must be able to handle the following Unified CVP application disk I/O characteristics.
:* Enable hyperthreading on all ESXi servers.

== Performance Numbers on B-Series ==

'''HTTP Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 900
|-
| VXML Standalone
| 900
|-
| VXML Standalone with Req ICM Label (VXML Server on Tomcat)
| 900
|-
| VXML Standalone on WAS
| 900
|-
| VXML Standalone with Req ICM Label on WAS
| 900
|}

'''HTTPS Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 275
|-
| VXML Standalone
| 275
|-
| VXML Standalone on WAS
| 275
|}

== VM IOPS Measurement ==

'''IOPS Summary: (Unit in Number, Data are Blade-based)'''
{| class="wikitable"
|-
!CVP Server
!Average
!MAX
!95th Percentile
|-
|CS/VXML Servers
|380
|1536
|797
|-
|Reporting Server
|692
|3403
|2024
|}

== Timekeeping Best Practices for Windows ==

You should follow the best practices outlined in the VMware Knowledge Base article [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1318 VMware KB: Timekeeping best practices for Windows].
* ESXi hosts and domain controllers should synchronize the time from the same NTP source.
* When Unified Unified CVP virtual machines join the domain, they synchronize the time with the domain controller automatically using w32time.
* Be sure that '''Time synchronization between the virtual machine and the host operating system''' in the VMware Tools tool box GUI of the Windows Server 2003 guest operating system remains deselected; this checkbox is deselected by default.

== System Performance Monitoring Using Windows Perfmon Counters ==

You must comply with the best practices described in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf SRND section System Performance Monitoring].

-----
Back to [http://docwiki-dev.cisco.com/wiki/Unified_Communications_Virtualization Unified Communications Virtualization main page]

Unified Customer Voice Portal

2010-10-06T19:52:28Z

Jbeaudry: /* Notes for Deploying Unified CVP Applications on UCS B-Series Hardware with SAN */

== Updates to this Page ==

The following is a list of significant updates to this page:

{| class="wikitable"

|-
! Date
! Update

|-
| September 24, 2010
| Distribution of Cisco UCS Unified CVP DocWiki for Tech review.
|-
| September 25, 2010
| Cleaned up IOPS tables, product naming conventions, section consistency with Unified CCE UCS wiki.
|-
| September 26, 2010
| Validated links, performed spell check, noted areas still requiring additional technical review.
|-
| September 27, 2010
| Updated feedback to the following areas: Information for Partners, VMWare and Application Software Requirements, UCS Network Configuration, Configuring ESXi datastore.
|-
|September 28, 2010
|Updated feedback to the following sections: Modified link to Information for Partners; Unified CVP 8.0(1) Support for Virtualization on the ESXi/UCS Platform (Modified bullet that referred to 'Distributed'; Coresidency (Deleted references to realtime; Modified last bullet regarding support on Blade.) '''
|-
|September 30, 2010
| Unified CVP Virtualization information posted to Unified Communications Virtualization Wiki.

|}

== Information for Partners about Cisco Unified CVP on UCS Deployment Certification and Ordering ==
'''It is important that partners who are planning to sell UCS products on Unified Cisco Customer Voice Portal, read the ''' '''[http://docwiki.cisco.com/wiki/Unified_Contact_Center_Enterprise Unified CCE DocWiki page].'''

This page contains essential information for partners about the following:

:* Partner Certification Requirements
:* UCS Server Ordering Information
:* Important Notes on Cisco UCS Service and Support

== Unified CVP 8.0(1) Support for Virtualization on the ESXi/UCS Platform ==
Starting with Release 8.0(1), virtualization of the following deployments and Unified CVP components on Cisco Unified Communications Systems (UCS) B-Series hardware is supported:
:* Unified CVP Call Server
:* Unified CVP VXML Server
:* Unified CVP Reporting Server
:* Unified CVP Ops Console

The following deployments and Unified CVP components have not been qualified and '''are not supported''' in virtualization:
:* H323 Call flow Deployment
:* Distributed VXML Server and Call Server deployment where each server runs in a separate VM
:* All in one lab deployment with small reporting server

The following VMware features are not supported with Unified CVP:
:* VMware Physical to Virtual migration
:* VMware Snapshots
:* VMware Consolidated Backup
:* VMware High Availability (HA)
:* VMware Site Recovery Manager
:* VMware vCenter Update Manager
:* VMware vCenter Converter

== UCS Hardware Requirements ==
Requirements for Cisco Unified Customer Voice Portal using UCS B200 M1 hardware are located [[Unified_Computing_System_Hardware#B-200_M1_Requirements|here]].

== VMware and Application Software Requirements ==

The following software requirements apply specifically to Unified Customer Voice Portal:

:* VMWare ESXi 4.0 only, minimum version 4.0U1. Versions of ESXi prior to 4.0U1 and all versions of ESX are unsupported.
:* The Windows, Informix, and other third party software requirements for the Unified CVP applications in the ESXi/UCS platform are the same as in the physical server. For such information, refer to the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/cvp8_0/installation/guide/cvp_801_install.pdf Hardware and System Software Specification for Cisco Unified Customer Voice Portal, Release 8.0(1)].

== UCS Network Configuration ==

'''IMPORTANT:''' For instructions on performing the network configuration needed to deploy Cisco Unified Customer Voice Portal (Unified CVP) on a virtualized platform, please see below.

'''1) TCP Setting modification on Reporting Server'''
It is highly recommended that customers modify the default "Number of Receive Buffers" setting on the Reporting server to maximize full reporting and call load on the virtualized platform. If this setting is not modified after installing the OS, messages will get backed up on the CallServer and Message Queues will fill up resulting in a sharp drop in cps rate.

* Set the "Number of Receive buffers" on the Reporting Server TCP settings to 4096 (max).
Instructions:
# On Reporting server, click on Control Panel->Network Connection.
# Right click on Network Connection.
# Click on advanced tab.
# Under property tab, select "Number of Receive Buffers".
# In the Value pulldown, enter 4096.
# Restart the Reporting Server.

'''2) Use TCP protocol over UDP for SIP Comprehensive call flow as a SIP Best Practice''' Use TCP for SIP Comprehensive call flows. Using UDP may cause call setup failures or may result in abnormally long calls under heavy load. Typically TCP should be set on all call legs, but it is a requirement on the ingress leg. This can be set on the POTS dialpeer by setting the session transport to tcp.

'''3) Cisco VLAN trunking to VMWare'''
For information on best practices for Cisco VLAN trunking to VMware, refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware website ].

=== Support for Unified Communications Manager Clustering Over the WAN with Unified CVP on UCS Hardware ===

You can deploy the Unified Communications Manager (Unified CM) Clustering Over the WAN deployment model with Unified CVP on UCS B-series hardware.

When you implement this deployment model, be sure to follow the best practices outlined in the section "Multiple Cisco Unified CM Clusters" in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf Cisco Unified CVP Solution Reference Network Design (SRND) ].

In addition, note the following expectation for UCS B-series hardware points of failure:

* Multiple points of failure on the Unified CVP UCS B-series HA deployment can cause catastrophic failure, such as ICM software failovers and interruption of service. If multiple points of failure occur, replace the failed redundant components and links immediately.

* '''B-Series Considerations'''
When deploying Clustering Over the WAN with B-Series hardware, use of the Cisco UCS M81KR Virtual Interface Card is mandatory.

New B-Series deployments using Clustering Over the WAN must use a Nexus 7000 Series / Nexus 5000 Series vPC infrastructure, or a Cisco Catalyst 6500 Series Virtual Switching Supervisor Engine 720-10G.

== Notes for Deploying Unified CVP Applications on UCS B-Series Hardware with SAN ==

In Storage Area Network (SAN) architecture, storage consists of a series of arrays of Redundant Array of Independent Disks (RAIDs). A Logical Unit Number (LUN) that represents a device identifier can be created on a RAID array. A LUN can occupy all or part of a single RAID array, or span multiple RAID arrays.

In a virtualized environment, datastores are created on LUNs. Virtual Machines (VMs) are installed on the SAN datastore.

Keep the following considerations in mind when deploying Unified CVP 
 applications on UCS B-series hardware with SAN:

'''Compliance Considerations'''
* A SAN RAID group must be dedicated to Unified CVP database components; these SAN RAID groups must not be shared by other applications. The SAN disk array must be configured as RAID 10, for added performance and fault tolerance. SAN solutions are typically deployed in a shared environment where multiple applications are contending for storage access. If the SAN storage deployment is identified as affecting the functions of the contact center solution, the customer will be required to deploy a direct attached storage solution instead. Moreover, if in the process of troubleshooting, the SAN itself is identified as the problem, the customer must contact the system integrator or the SAN vendor for resolution.

'''Design Considerations'''
* The SAN must be designed in accordance with the UCS High Availability guidelines documented at [http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html].
* The SAN design and configuration must meet the Unified CVP IOPS and Performance numbers described in the [[Unified_Customer_Voice_Portal#Performance_Requirements|Performance Requirements]].
* The SAN design and configuration must meet the following VMware ESXi disk performance guidelines:
** Disk Command Latency – It should be 15 mSec or less. 15mSec latencies or greater indicates a possible over-utilized, mis-behaving, or mis-configured disk array.
'''Configuration Considerations'''
*For UCS B-series, Virtual Machines must be stored on and booted from the SAN.
** Kernel Disk Command Latency – It should be very small in comparison to the Physical Device Command Latency, and it should be close to zero. A high Kernel Command Latency indicates there is a lot of queuing in the ESXi kernel.
* The SAN design and configuration must meet the following Windows performance counters on Unified CVP VMs:
** AverageDiskQueueLength must remain less than (1.5 ∗ (the total number of disks in the array)).
** %Disktime must remain less than 60%.
* Any given SAN array must be designed to have an IOPS capacity exceeding the sum of the IOPS required for all resident UC applications. Unified CVP applications should be designed for the 95th percentile IOPS values published in this wiki. Refer to the Performance Requirements section below for additional information. For other UC applications, please follow their respective IOPS requirements and guidelines.
'''Storage/Size Considerations'''
*Unified CVP requires application storage to be on VMFS. Raw Device Mapping (RDM) is not supported.
* The total size of all Virtual Machines on a disk (total size = VM disk + RAM copy) must not exceed 90% of the capacity of a datastore.
'''Input/Output Operations per Second (IOPS) Considerations'''
* IOPS utilization should be monitored for each application to ensure that the aggregate IOPS is not exceeding the capacity of the array. Prolonged buffering of IOPS against an array may result in degraded system performance and delayed reporting data availability. Refer to the Performance Requirements section below for additional information.
'''Maintenance Considerations'''
* To help keep your system running most efficiently, schedule automatic database purging and database backups to run when your system is least busy.
'''Support Considerations'''
* The ESXi boot from SAN feature is not supported; it must be installed to internal storage.

== Steps for Installing Unified CVP Components on Virtual Machines ==
Follow the steps and references below to install or migrate the Unified CVP components on Virtual Machines.
# Install, setup, and configure the UCS Hardware.
# Configure the UCS Network. See reference at [http://docwiki-dev.cisco.com/wiki/Unified_Contact_Center_Enterprise#UCS_Network_Configuration UCS Network Configuration].
# Install and Boot VMWare ESXi. Refer to the following installation guide: [http://www.cisco.com/en/US/docs/unified_computing/ucs/sw/b/os/vmware/install/bseries-vmware-install.html Cisco UCS B-Series Blade Servers VMware Installation Guide].
# Create the Unified CVP Virtual Machines from the OVA template. OVA templates are available [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y here ]
# Install Windows OS and Websphere Application Server (if using VXML Server with WAS) on the created Virtual Machines. (Note: Microsoft Windows Server 2003 ''Standard Edition'' should be used for virtual machine guests. See related information in the links below.)
#Install Unified CVP Software components on the configured Virtual Machines. See install reference for installing Unified CVP Components in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/cvp8_0/installation/guide/cvp_801_install.pdf Unified CVP Install and Upgrade guide].

== Unified CVP Component Capacities and VM Configuration Requirements ==

This section provides details associated with VM requirements. http://docwiki-dev.cisco.com/wiki/Unified_Communications_VMWare_Requirements

This table shows the supported Unified CVP components, their capacities, and the VM computing resource requirements.   You must use the OVA virtual machine templates to create the Unified CVP component VMs.

{| class="wikitable"
|-
! Unified CVP Component
! vCPU
! RAM (GB)
! vDisk (GB)
! vNIC
! Template Name

|-
| Unified CVP Call Server/VXML Server/co-located Call Server and VXML Server
| 4 vCPU
| 4 GB
| 146 GB
| 1 vNIC
| Cisco Unified CVP Call Server-VXML Server.ova

|-
| Unified CVP Reporting Server (Large)
| 4 vCPU
| 4 GB
| Disk 1 - 72 GB, Disk 2 - 438 GB
| 1 vNIC
| Cisco Unified CVP Reporting Server.ova

|-
| Unified CVP Operations Console
| 2 vCPU
| 2 GB RAM
| 20 GB
| 1 vNIC
| Cisco Unified CVP Operations Console.ova

|}

== Unified CVP Component Co-Residency ==

You can have one or more Unified CVP VMs co-resident on the same ESXi server.  However, you must follow the rules described below:
:* You can have any number of Unified CVP virtual machines and combination of co-residency of Unified CVP virtual machines on an ESXi server as long as the sum of all the virtual machine CPU and memory resource allocation is not over committed on the available ESXi server computing resources. 
:* You must not have CPU overcommitted on the ESXi server that is running Unified CVP application components .  The total number of vCPUs among all the virtual machines on an ESXi host must not greater than the total number of CPUs available on the ESXi server.  In the case of the Cisco UCS B-200 M1, the total number of CPUs available is 8.
:* You must not have memory overcommitted on the ESXi host that is running UC realtime applications.  You must allocate minimum 2GB of memory for the ESXi kernel.  For example, if an ESXi server on B-200 M1 hardware has 36GB of memory, after you allocate 2GB for the ESXi kernel, you have 34GB available for the virtual machines.  The total memory allocated for all the virtual machines on an ESXi server must not be greater than 34GB in this case.
:* VM co-residency with Unified Communications and third party applications were not tested on the same blade with Unified CVP products. '''

== Creating Virtual Machines from OVA VM Templates ==

Open Virtualization Format (OVF) is an open standard for packaging and distributing virtual appliances.  Files in this format have an extension of .ova. The naming convention for the template is PRODUCT_COMPONENT_USER COUNT_VERSION_VMVER.ova

Follow the instructions in the Downloading OVA Templates section below to download the OVA templates from cisco.com to a local datastore that vSphere Client can access.

=== Downloading OVA Templates ===
:*Proceed to the [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y Cisco Download Page for CVP].

:*To download a single OVA file, click the '''Download File''' button next to that file. To download multiple OVA files, click the '''Add to Cart''' button next to each file that you want to download, then click on the '''Download Cart''' link. A Download Cart page appears.

:*Click the '''Proceed with Download''' button on this page. A Software License Agreement page appears.

:*Read the Software License Agreement, then click the '''Agree''' button

:*On the next page, click on either the '''Download Manager''' link (requires Java) or the '''Non Java Download Option''' link. A new browser window appears.

:*If you selected Download Manager, a Select Location dialog box appears. Specify the location where you want to save the file, and click '''Open''' to save the file to your local machine.

:*If you selected Non Java Download Option, click the '''Download''' link on the new browser window. Specify the location and save the file to your local machine.

=== Creating Virtual Machines by Deploying the OVA Templates ===

In the vSphere client, perform the following steps to deploy the Virtual machines.

# Highlight the host or cluster to which you wish the VM to be deployed.
# Select '''File''' > '''Deploy OVF Template'''.
# Click the '''Deploy from File''' radio button and specify the name and location of the file you downloaded in the previous section '''or''' click the '''Deploy from URL''' radio button and specify the complete URL in the field, then click '''Next'''.
#Verify the details of the template, and click '''Next'''.
#Give the VM you are about to create a name, and choose an inventory location on your host, then click '''Next'''.
#Choose the datastore on which you would like the VM to reside - be sure there is sufficient free space to accommodate the new VM, then click '''Next'''.
#Choose a virtual network for the VM, then click '''Next'''.
#Verify the deployment settings, then click '''Finish'''.

=== Notes ===
:* VM CPU affinity is not supported. You do not need to set CPU affinity for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform.
:* VM resource Reservation - VM resource reservation is not supported for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform. The VM computing resources should have a default reservation setting, which is no resource reservations.
:* You cannot change the computing resource configuration of your VM at any time.
:* You can never go below the minimum VM computing resource requirements as defined in the OVA templates.
:* It is required that hyperthreading be enabled by default when running CVP on ESXi. ESXi Server hyperthread is enabled by default and this setting should not be modified. Please ensure all VM's with CVP servers has hyperthreading enabled.

== Remote Control of the Virtual Machines ==

For administrative tasks, you can use either Windows Remote Desktop or the VMware Infrastructure Client for remote control.

== Installing VMware Tools==

The VMware Tools must be installed on each of the VMs and all of the VMware Tools default settings should be used. Please refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware documentation] for instructions on installing or upgrading VMware Tools on the VM with Windows operating system.

== Installing Unified CVP Components on Virtual Machines ==
You can install the Unified CVP components after the configuration of the VMs. Installation of these Unified CVP components on a VM is the same as the installation of these components on physical hardware.

Refer to the Unified CVP documentation for the steps to install Unified CVP components. You can install the supported Virus Scan software, the Cisco Security Agent (CSA), or any other software in the same way as on physical hardware.

== Configuring the ESXi Data Store Block Size for Administration and Data Server ==

The creation of the virtual machine for the Unified CVP Reporting Server requires a large virtual disk size. You must follow the steps described below to configure the ESXi data store size to 438 GB for it to handle the Unified CVP Reporting Server data before you deploy the OVAs

Steps to configure the ESXi for CVP Reporting server to RAID10 found at [[ CVP Reporting Server Configuration ]]

== Performance Requirements ==

:* CPU usage (average) should not exceed 60% for the ESXi Server and for each of the individual processors, and for each VM.
:* Memory usage (average) should not exceed 80% for the ESXi Server and for each of the VMs.
:* VM snapshots are not supported in production since they have significant impact on system performance. 
:* The SAN must be able to handle the following Unified CVP application disk I/O characteristics.
:* Enable hyperthreading on all ESXi servers.

== Performance Numbers on B-Series ==

'''HTTP Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 900
|-
| VXML Standalone
| 900
|-
| VXML Standalone with Req ICM Label (VXML Server on Tomcat)
| 900
|-
| VXML Standalone on WAS
| 900
|-
| VXML Standalone with Req ICM Label on WAS
| 900
|}

'''HTTPS Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 275
|-
| VXML Standalone
| 275
|-
| VXML Standalone on WAS
| 275
|}

== VM IOPS Measurement ==

'''IOPS Summary: (Unit in Number, Data are Blade-based)'''
{| class="wikitable"
|-
!CVP Server
!Average
!MAX
!95th Percentile
|-
|CS/VXML Servers
|380
|1536
|797
|-
|Reporting Server
|692
|3403
|2024
|}

== Timekeeping Best Practices for Windows ==

You should follow the best practices outlined in the VMware Knowledge Base article [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1318 VMware KB: Timekeeping best practices for Windows].
* ESXi hosts and domain controllers should synchronize the time from the same NTP source.
* When Unified Unified CVP virtual machines join the domain, they synchronize the time with the domain controller automatically using w32time.
* Be sure that '''Time synchronization between the virtual machine and the host operating system''' in the VMware Tools tool box GUI of the Windows Server 2003 guest operating system remains deselected; this checkbox is deselected by default.

== System Performance Monitoring Using Windows Perfmon Counters ==

You must comply with the best practices described in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf SRND section System Performance Monitoring].

-----
Back to [http://docwiki-dev.cisco.com/wiki/Unified_Communications_Virtualization Unified Communications Virtualization main page]

Unified Customer Voice Portal

2010-10-06T19:47:20Z

Jbeaudry: /* UCS Hardware Requirements */

== Updates to this Page ==

The following is a list of significant updates to this page:

{| class="wikitable"

|-
! Date
! Update

|-
| September 24, 2010
| Distribution of Cisco UCS Unified CVP DocWiki for Tech review.
|-
| September 25, 2010
| Cleaned up IOPS tables, product naming conventions, section consistency with Unified CCE UCS wiki.
|-
| September 26, 2010
| Validated links, performed spell check, noted areas still requiring additional technical review.
|-
| September 27, 2010
| Updated feedback to the following areas: Information for Partners, VMWare and Application Software Requirements, UCS Network Configuration, Configuring ESXi datastore.
|-
|September 28, 2010
|Updated feedback to the following sections: Modified link to Information for Partners; Unified CVP 8.0(1) Support for Virtualization on the ESXi/UCS Platform (Modified bullet that referred to 'Distributed'; Coresidency (Deleted references to realtime; Modified last bullet regarding support on Blade.) '''
|-
|September 30, 2010
| Unified CVP Virtualization information posted to Unified Communications Virtualization Wiki.

|}

== Information for Partners about Cisco Unified CVP on UCS Deployment Certification and Ordering ==
'''It is important that partners who are planning to sell UCS products on Unified Cisco Customer Voice Portal, read the ''' '''[http://docwiki.cisco.com/wiki/Unified_Contact_Center_Enterprise Unified CCE DocWiki page].'''

This page contains essential information for partners about the following:

:* Partner Certification Requirements
:* UCS Server Ordering Information
:* Important Notes on Cisco UCS Service and Support

== Unified CVP 8.0(1) Support for Virtualization on the ESXi/UCS Platform ==
Starting with Release 8.0(1), virtualization of the following deployments and Unified CVP components on Cisco Unified Communications Systems (UCS) B-Series hardware is supported:
:* Unified CVP Call Server
:* Unified CVP VXML Server
:* Unified CVP Reporting Server
:* Unified CVP Ops Console

The following deployments and Unified CVP components have not been qualified and '''are not supported''' in virtualization:
:* H323 Call flow Deployment
:* Distributed VXML Server and Call Server deployment where each server runs in a separate VM
:* All in one lab deployment with small reporting server

The following VMware features are not supported with Unified CVP:
:* VMware Physical to Virtual migration
:* VMware Snapshots
:* VMware Consolidated Backup
:* VMware High Availability (HA)
:* VMware Site Recovery Manager
:* VMware vCenter Update Manager
:* VMware vCenter Converter

== UCS Hardware Requirements ==
Requirements for Cisco Unified Customer Voice Portal using UCS B200 M1 hardware are located [[Unified_Computing_System_Hardware#B-200_M1_Requirements|here]].

== VMware and Application Software Requirements ==

The following software requirements apply specifically to Unified Customer Voice Portal:

:* VMWare ESXi 4.0 only, minimum version 4.0U1. Versions of ESXi prior to 4.0U1 and all versions of ESX are unsupported.
:* The Windows, Informix, and other third party software requirements for the Unified CVP applications in the ESXi/UCS platform are the same as in the physical server. For such information, refer to the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/cvp8_0/installation/guide/cvp_801_install.pdf Hardware and System Software Specification for Cisco Unified Customer Voice Portal, Release 8.0(1)].

== UCS Network Configuration ==

'''IMPORTANT:''' For instructions on performing the network configuration needed to deploy Cisco Unified Customer Voice Portal (Unified CVP) on a virtualized platform, please see below.

'''1) TCP Setting modification on Reporting Server'''
It is highly recommended that customers modify the default "Number of Receive Buffers" setting on the Reporting server to maximize full reporting and call load on the virtualized platform. If this setting is not modified after installing the OS, messages will get backed up on the CallServer and Message Queues will fill up resulting in a sharp drop in cps rate.

* Set the "Number of Receive buffers" on the Reporting Server TCP settings to 4096 (max).
Instructions:
# On Reporting server, click on Control Panel->Network Connection.
# Right click on Network Connection.
# Click on advanced tab.
# Under property tab, select "Number of Receive Buffers".
# In the Value pulldown, enter 4096.
# Restart the Reporting Server.

'''2) Use TCP protocol over UDP for SIP Comprehensive call flow as a SIP Best Practice''' Use TCP for SIP Comprehensive call flows. Using UDP may cause call setup failures or may result in abnormally long calls under heavy load. Typically TCP should be set on all call legs, but it is a requirement on the ingress leg. This can be set on the POTS dialpeer by setting the session transport to tcp.

'''3) Cisco VLAN trunking to VMWare'''
For information on best practices for Cisco VLAN trunking to VMware, refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware website ].

=== Support for Unified Communications Manager Clustering Over the WAN with Unified CVP on UCS Hardware ===

You can deploy the Unified Communications Manager (Unified CM) Clustering Over the WAN deployment model with Unified CVP on UCS B-series hardware.

When you implement this deployment model, be sure to follow the best practices outlined in the section "Multiple Cisco Unified CM Clusters" in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf Cisco Unified CVP Solution Reference Network Design (SRND) ].

In addition, note the following expectation for UCS B-series hardware points of failure:

* Multiple points of failure on the Unified CVP UCS B-series HA deployment can cause catastrophic failure, such as ICM software failovers and interruption of service. If multiple points of failure occur, replace the failed redundant components and links immediately.

* '''B-Series Considerations'''
When deploying Clustering Over the WAN with B-Series hardware, use of the Cisco UCS M81KR Virtual Interface Card is mandatory.

New B-Series deployments using Clustering Over the WAN must use a Nexus 7000 Series / Nexus 5000 Series vPC infrastructure, or a Cisco Catalyst 6500 Series Virtual Switching Supervisor Engine 720-10G.

== Notes for Deploying Unified CVP Applications on UCS B-Series Hardware with SAN ==

In Storage Area Network (SAN) architecture, storage consists of a series of arrays of Redundant Array of Independent Disks (RAIDs). A Logical Unit Number (LUN) that represents a device identifier can be created on a RAID array. A LUN can occupy all or part of a single RAID array, or span multiple RAID arrays.

In a virtualized environment, datastores are created on LUNs. Virtual Machines (VMs) are installed on the SAN datastore.

Keep the following considerations in mind when deploying Unified CVP 
 applications on UCS B-series hardware with SAN:

'''Compliance Considerations'''
* A SAN RAID group must be dedicated to Unified CVP database components; these SAN RAID groups must not be shared by other applications. The SAN disk array must be configured as RAID 10, for added performance and fault tolerance. SAN solutions are typically deployed in a shared environment where multiple applications are contending for storage access. If the SAN storage deployment is identified as affecting the functions of the contact center solution, the customer will be required to deploy a direct attached storage solution instead. Moreover, if in the process of troubleshooting, the SAN itself is identified as the problem, the customer must contact the system integrator or the SAN vendor for resolution.

'''Design Considerations'''
* The SAN must be designed in accordance with the UCS High Availability guidelines documented at [http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html].
* The SAN design and configuration must meet the Unified CVP IOPS and Performance numbers described in the [http://docwiki-dev.cisco.com/wiki/Cisco_Voice_Portal#Performance_Requirements Performance Requirements].
* The SAN design and configuration must meet the following VMware ESXi disk performance guidelines:
** Disk Command Latency – It should be 15 mSec or less. 15mSec latencies or greater indicates a possible over-utilized, mis-behaving, or mis-configured disk array.
'''Configuration Considerations'''
*For UCS B-series, Virtual Machines must be stored on and booted from the SAN.
** Kernel Disk Command Latency – It should be very small in comparison to the Physical Device Command Latency, and it should be close to zero. A high Kernel Command Latency indicates there is a lot of queuing in the ESXi kernel.
* The SAN design and configuration must meet the following Windows performance counters on Unified CVP VMs:
** AverageDiskQueueLength must remain less than (1.5 ∗ (the total number of disks in the array)).
** %Disktime must remain less than 60%.
* Any given SAN array must be designed to have an IOPS capacity exceeding the sum of the IOPS required for all resident UC applications. Unified CVP applications should be designed for the 95th percentile IOPS values published in this wiki. Refer to the Performance Requirements section below for additional information. For other UC applications, please follow their respective IOPS requirements and guidelines.
'''Storage/Size Considerations'''
*Unified CVP requires application storage to be on VMFS. Raw Device Mapping (RDM) is not supported.
* The total size of all Virtual Machines on a disk (total size = VM disk + RAM copy) must not exceed 90% of the capacity of a datastore.
'''Input/Output Operations per Second (IOPS) Considerations'''
* IOPS utilization should be monitored for each application to ensure that the aggregate IOPS is not exceeding the capacity of the array. Prolonged buffering of IOPS against an array may result in degraded system performance and delayed reporting data availability. Refer to the Performance Requirements section below for additional information.
'''Maintenance Considerations'''
* To help keep your system running most efficiently, schedule automatic database purging and database backups to run when your system is least busy.
'''Support Considerations'''
* The ESXi boot from SAN feature is not supported; it must be installed to internal storage.

== Steps for Installing Unified CVP Components on Virtual Machines ==
Follow the steps and references below to install or migrate the Unified CVP components on Virtual Machines.
# Install, setup, and configure the UCS Hardware.
# Configure the UCS Network. See reference at [http://docwiki-dev.cisco.com/wiki/Unified_Contact_Center_Enterprise#UCS_Network_Configuration UCS Network Configuration].
# Install and Boot VMWare ESXi. Refer to the following installation guide: [http://www.cisco.com/en/US/docs/unified_computing/ucs/sw/b/os/vmware/install/bseries-vmware-install.html Cisco UCS B-Series Blade Servers VMware Installation Guide].
# Create the Unified CVP Virtual Machines from the OVA template. OVA templates are available [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y here ]
# Install Windows OS and Websphere Application Server (if using VXML Server with WAS) on the created Virtual Machines. (Note: Microsoft Windows Server 2003 ''Standard Edition'' should be used for virtual machine guests. See related information in the links below.)
#Install Unified CVP Software components on the configured Virtual Machines. See install reference for installing Unified CVP Components in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/cvp8_0/installation/guide/cvp_801_install.pdf Unified CVP Install and Upgrade guide].

== Unified CVP Component Capacities and VM Configuration Requirements ==

This section provides details associated with VM requirements. http://docwiki-dev.cisco.com/wiki/Unified_Communications_VMWare_Requirements

This table shows the supported Unified CVP components, their capacities, and the VM computing resource requirements.   You must use the OVA virtual machine templates to create the Unified CVP component VMs.

{| class="wikitable"
|-
! Unified CVP Component
! vCPU
! RAM (GB)
! vDisk (GB)
! vNIC
! Template Name

|-
| Unified CVP Call Server/VXML Server/co-located Call Server and VXML Server
| 4 vCPU
| 4 GB
| 146 GB
| 1 vNIC
| Cisco Unified CVP Call Server-VXML Server.ova

|-
| Unified CVP Reporting Server (Large)
| 4 vCPU
| 4 GB
| Disk 1 - 72 GB, Disk 2 - 438 GB
| 1 vNIC
| Cisco Unified CVP Reporting Server.ova

|-
| Unified CVP Operations Console
| 2 vCPU
| 2 GB RAM
| 20 GB
| 1 vNIC
| Cisco Unified CVP Operations Console.ova

|}

== Unified CVP Component Co-Residency ==

You can have one or more Unified CVP VMs co-resident on the same ESXi server.  However, you must follow the rules described below:
:* You can have any number of Unified CVP virtual machines and combination of co-residency of Unified CVP virtual machines on an ESXi server as long as the sum of all the virtual machine CPU and memory resource allocation is not over committed on the available ESXi server computing resources. 
:* You must not have CPU overcommitted on the ESXi server that is running Unified CVP application components .  The total number of vCPUs among all the virtual machines on an ESXi host must not greater than the total number of CPUs available on the ESXi server.  In the case of the Cisco UCS B-200 M1, the total number of CPUs available is 8.
:* You must not have memory overcommitted on the ESXi host that is running UC realtime applications.  You must allocate minimum 2GB of memory for the ESXi kernel.  For example, if an ESXi server on B-200 M1 hardware has 36GB of memory, after you allocate 2GB for the ESXi kernel, you have 34GB available for the virtual machines.  The total memory allocated for all the virtual machines on an ESXi server must not be greater than 34GB in this case.
:* VM co-residency with Unified Communications and third party applications were not tested on the same blade with Unified CVP products. '''

== Creating Virtual Machines from OVA VM Templates ==

Open Virtualization Format (OVF) is an open standard for packaging and distributing virtual appliances.  Files in this format have an extension of .ova. The naming convention for the template is PRODUCT_COMPONENT_USER COUNT_VERSION_VMVER.ova

Follow the instructions in the Downloading OVA Templates section below to download the OVA templates from cisco.com to a local datastore that vSphere Client can access.

=== Downloading OVA Templates ===
:*Proceed to the [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y Cisco Download Page for CVP].

:*To download a single OVA file, click the '''Download File''' button next to that file. To download multiple OVA files, click the '''Add to Cart''' button next to each file that you want to download, then click on the '''Download Cart''' link. A Download Cart page appears.

:*Click the '''Proceed with Download''' button on this page. A Software License Agreement page appears.

:*Read the Software License Agreement, then click the '''Agree''' button

:*On the next page, click on either the '''Download Manager''' link (requires Java) or the '''Non Java Download Option''' link. A new browser window appears.

:*If you selected Download Manager, a Select Location dialog box appears. Specify the location where you want to save the file, and click '''Open''' to save the file to your local machine.

:*If you selected Non Java Download Option, click the '''Download''' link on the new browser window. Specify the location and save the file to your local machine.

=== Creating Virtual Machines by Deploying the OVA Templates ===

In the vSphere client, perform the following steps to deploy the Virtual machines.

# Highlight the host or cluster to which you wish the VM to be deployed.
# Select '''File''' > '''Deploy OVF Template'''.
# Click the '''Deploy from File''' radio button and specify the name and location of the file you downloaded in the previous section '''or''' click the '''Deploy from URL''' radio button and specify the complete URL in the field, then click '''Next'''.
#Verify the details of the template, and click '''Next'''.
#Give the VM you are about to create a name, and choose an inventory location on your host, then click '''Next'''.
#Choose the datastore on which you would like the VM to reside - be sure there is sufficient free space to accommodate the new VM, then click '''Next'''.
#Choose a virtual network for the VM, then click '''Next'''.
#Verify the deployment settings, then click '''Finish'''.

=== Notes ===
:* VM CPU affinity is not supported. You do not need to set CPU affinity for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform.
:* VM resource Reservation - VM resource reservation is not supported for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform. The VM computing resources should have a default reservation setting, which is no resource reservations.
:* You cannot change the computing resource configuration of your VM at any time.
:* You can never go below the minimum VM computing resource requirements as defined in the OVA templates.
:* It is required that hyperthreading be enabled by default when running CVP on ESXi. ESXi Server hyperthread is enabled by default and this setting should not be modified. Please ensure all VM's with CVP servers has hyperthreading enabled.

== Remote Control of the Virtual Machines ==

For administrative tasks, you can use either Windows Remote Desktop or the VMware Infrastructure Client for remote control.

== Installing VMware Tools==

The VMware Tools must be installed on each of the VMs and all of the VMware Tools default settings should be used. Please refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware documentation] for instructions on installing or upgrading VMware Tools on the VM with Windows operating system.

== Installing Unified CVP Components on Virtual Machines ==
You can install the Unified CVP components after the configuration of the VMs. Installation of these Unified CVP components on a VM is the same as the installation of these components on physical hardware.

Refer to the Unified CVP documentation for the steps to install Unified CVP components. You can install the supported Virus Scan software, the Cisco Security Agent (CSA), or any other software in the same way as on physical hardware.

== Configuring the ESXi Data Store Block Size for Administration and Data Server ==

The creation of the virtual machine for the Unified CVP Reporting Server requires a large virtual disk size. You must follow the steps described below to configure the ESXi data store size to 438 GB for it to handle the Unified CVP Reporting Server data before you deploy the OVAs

Steps to configure the ESXi for CVP Reporting server to RAID10 found at [[ CVP Reporting Server Configuration ]]

== Performance Requirements ==

:* CPU usage (average) should not exceed 60% for the ESXi Server and for each of the individual processors, and for each VM.
:* Memory usage (average) should not exceed 80% for the ESXi Server and for each of the VMs.
:* VM snapshots are not supported in production since they have significant impact on system performance. 
:* The SAN must be able to handle the following Unified CVP application disk I/O characteristics.
:* Enable hyperthreading on all ESXi servers.

== Performance Numbers on B-Series ==

'''HTTP Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 900
|-
| VXML Standalone
| 900
|-
| VXML Standalone with Req ICM Label (VXML Server on Tomcat)
| 900
|-
| VXML Standalone on WAS
| 900
|-
| VXML Standalone with Req ICM Label on WAS
| 900
|}

'''HTTPS Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 275
|-
| VXML Standalone
| 275
|-
| VXML Standalone on WAS
| 275
|}

== VM IOPS Measurement ==

'''IOPS Summary: (Unit in Number, Data are Blade-based)'''
{| class="wikitable"
|-
!CVP Server
!Average
!MAX
!95th Percentile
|-
|CS/VXML Servers
|380
|1536
|797
|-
|Reporting Server
|692
|3403
|2024
|}

== Timekeeping Best Practices for Windows ==

You should follow the best practices outlined in the VMware Knowledge Base article [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1318 VMware KB: Timekeeping best practices for Windows].
* ESXi hosts and domain controllers should synchronize the time from the same NTP source.
* When Unified Unified CVP virtual machines join the domain, they synchronize the time with the domain controller automatically using w32time.
* Be sure that '''Time synchronization between the virtual machine and the host operating system''' in the VMware Tools tool box GUI of the Windows Server 2003 guest operating system remains deselected; this checkbox is deselected by default.

== System Performance Monitoring Using Windows Perfmon Counters ==

You must comply with the best practices described in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf SRND section System Performance Monitoring].

-----
Back to [http://docwiki-dev.cisco.com/wiki/Unified_Communications_Virtualization Unified Communications Virtualization main page]

Unified Customer Voice Portal

2010-10-06T19:42:44Z

Jbeaudry: /* Information for Partners about Cisco Unified CVP on UCS Deployment Certification and Ordering */

== Updates to this Page ==

The following is a list of significant updates to this page:

{| class="wikitable"

|-
! Date
! Update

|-
| September 24, 2010
| Distribution of Cisco UCS Unified CVP DocWiki for Tech review.
|-
| September 25, 2010
| Cleaned up IOPS tables, product naming conventions, section consistency with Unified CCE UCS wiki.
|-
| September 26, 2010
| Validated links, performed spell check, noted areas still requiring additional technical review.
|-
| September 27, 2010
| Updated feedback to the following areas: Information for Partners, VMWare and Application Software Requirements, UCS Network Configuration, Configuring ESXi datastore.
|-
|September 28, 2010
|Updated feedback to the following sections: Modified link to Information for Partners; Unified CVP 8.0(1) Support for Virtualization on the ESXi/UCS Platform (Modified bullet that referred to 'Distributed'; Coresidency (Deleted references to realtime; Modified last bullet regarding support on Blade.) '''
|-
|September 30, 2010
| Unified CVP Virtualization information posted to Unified Communications Virtualization Wiki.

|}

== Information for Partners about Cisco Unified CVP on UCS Deployment Certification and Ordering ==
'''It is important that partners who are planning to sell UCS products on Unified Cisco Customer Voice Portal, read the ''' '''[http://docwiki.cisco.com/wiki/Unified_Contact_Center_Enterprise Unified CCE DocWiki page].'''

This page contains essential information for partners about the following:

:* Partner Certification Requirements
:* UCS Server Ordering Information
:* Important Notes on Cisco UCS Service and Support

== Unified CVP 8.0(1) Support for Virtualization on the ESXi/UCS Platform ==
Starting with Release 8.0(1), virtualization of the following deployments and Unified CVP components on Cisco Unified Communications Systems (UCS) B-Series hardware is supported:
:* Unified CVP Call Server
:* Unified CVP VXML Server
:* Unified CVP Reporting Server
:* Unified CVP Ops Console

The following deployments and Unified CVP components have not been qualified and '''are not supported''' in virtualization:
:* H323 Call flow Deployment
:* Distributed VXML Server and Call Server deployment where each server runs in a separate VM
:* All in one lab deployment with small reporting server

The following VMware features are not supported with Unified CVP:
:* VMware Physical to Virtual migration
:* VMware Snapshots
:* VMware Consolidated Backup
:* VMware High Availability (HA)
:* VMware Site Recovery Manager
:* VMware vCenter Update Manager
:* VMware vCenter Converter

== UCS Hardware Requirements ==
Requirements for Cisco Unified Customer Voice Portal using UCS B200 M1 hardware are located [http://docwiki-dev.cisco.com/wiki/Unified_Computing_System_Hardware#B-200_M1_Requirements here].

== VMware and Application Software Requirements ==

The following software requirements apply specifically to Unified Customer Voice Portal:

:* VMWare ESXi 4.0 only, minimum version 4.0U1. Versions of ESXi prior to 4.0U1 and all versions of ESX are unsupported.
:* The Windows, Informix, and other third party software requirements for the Unified CVP applications in the ESXi/UCS platform are the same as in the physical server. For such information, refer to the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/cvp8_0/installation/guide/cvp_801_install.pdf Hardware and System Software Specification for Cisco Unified Customer Voice Portal, Release 8.0(1)].

== UCS Network Configuration ==

'''IMPORTANT:''' For instructions on performing the network configuration needed to deploy Cisco Unified Customer Voice Portal (Unified CVP) on a virtualized platform, please see below.

'''1) TCP Setting modification on Reporting Server'''
It is highly recommended that customers modify the default "Number of Receive Buffers" setting on the Reporting server to maximize full reporting and call load on the virtualized platform. If this setting is not modified after installing the OS, messages will get backed up on the CallServer and Message Queues will fill up resulting in a sharp drop in cps rate.

* Set the "Number of Receive buffers" on the Reporting Server TCP settings to 4096 (max).
Instructions:
# On Reporting server, click on Control Panel->Network Connection.
# Right click on Network Connection.
# Click on advanced tab.
# Under property tab, select "Number of Receive Buffers".
# In the Value pulldown, enter 4096.
# Restart the Reporting Server.

'''2) Use TCP protocol over UDP for SIP Comprehensive call flow as a SIP Best Practice''' Use TCP for SIP Comprehensive call flows. Using UDP may cause call setup failures or may result in abnormally long calls under heavy load. Typically TCP should be set on all call legs, but it is a requirement on the ingress leg. This can be set on the POTS dialpeer by setting the session transport to tcp.

'''3) Cisco VLAN trunking to VMWare'''
For information on best practices for Cisco VLAN trunking to VMware, refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware website ].

=== Support for Unified Communications Manager Clustering Over the WAN with Unified CVP on UCS Hardware ===

You can deploy the Unified Communications Manager (Unified CM) Clustering Over the WAN deployment model with Unified CVP on UCS B-series hardware.

When you implement this deployment model, be sure to follow the best practices outlined in the section "Multiple Cisco Unified CM Clusters" in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf Cisco Unified CVP Solution Reference Network Design (SRND) ].

In addition, note the following expectation for UCS B-series hardware points of failure:

* Multiple points of failure on the Unified CVP UCS B-series HA deployment can cause catastrophic failure, such as ICM software failovers and interruption of service. If multiple points of failure occur, replace the failed redundant components and links immediately.

* '''B-Series Considerations'''
When deploying Clustering Over the WAN with B-Series hardware, use of the Cisco UCS M81KR Virtual Interface Card is mandatory.

New B-Series deployments using Clustering Over the WAN must use a Nexus 7000 Series / Nexus 5000 Series vPC infrastructure, or a Cisco Catalyst 6500 Series Virtual Switching Supervisor Engine 720-10G.

== Notes for Deploying Unified CVP Applications on UCS B-Series Hardware with SAN ==

In Storage Area Network (SAN) architecture, storage consists of a series of arrays of Redundant Array of Independent Disks (RAIDs). A Logical Unit Number (LUN) that represents a device identifier can be created on a RAID array. A LUN can occupy all or part of a single RAID array, or span multiple RAID arrays.

In a virtualized environment, datastores are created on LUNs. Virtual Machines (VMs) are installed on the SAN datastore.

Keep the following considerations in mind when deploying Unified CVP 
 applications on UCS B-series hardware with SAN:

'''Compliance Considerations'''
* A SAN RAID group must be dedicated to Unified CVP database components; these SAN RAID groups must not be shared by other applications. The SAN disk array must be configured as RAID 10, for added performance and fault tolerance. SAN solutions are typically deployed in a shared environment where multiple applications are contending for storage access. If the SAN storage deployment is identified as affecting the functions of the contact center solution, the customer will be required to deploy a direct attached storage solution instead. Moreover, if in the process of troubleshooting, the SAN itself is identified as the problem, the customer must contact the system integrator or the SAN vendor for resolution.

'''Design Considerations'''
* The SAN must be designed in accordance with the UCS High Availability guidelines documented at [http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html].
* The SAN design and configuration must meet the Unified CVP IOPS and Performance numbers described in the [http://docwiki-dev.cisco.com/wiki/Cisco_Voice_Portal#Performance_Requirements Performance Requirements].
* The SAN design and configuration must meet the following VMware ESXi disk performance guidelines:
** Disk Command Latency – It should be 15 mSec or less. 15mSec latencies or greater indicates a possible over-utilized, mis-behaving, or mis-configured disk array.
'''Configuration Considerations'''
*For UCS B-series, Virtual Machines must be stored on and booted from the SAN.
** Kernel Disk Command Latency – It should be very small in comparison to the Physical Device Command Latency, and it should be close to zero. A high Kernel Command Latency indicates there is a lot of queuing in the ESXi kernel.
* The SAN design and configuration must meet the following Windows performance counters on Unified CVP VMs:
** AverageDiskQueueLength must remain less than (1.5 ∗ (the total number of disks in the array)).
** %Disktime must remain less than 60%.
* Any given SAN array must be designed to have an IOPS capacity exceeding the sum of the IOPS required for all resident UC applications. Unified CVP applications should be designed for the 95th percentile IOPS values published in this wiki. Refer to the Performance Requirements section below for additional information. For other UC applications, please follow their respective IOPS requirements and guidelines.
'''Storage/Size Considerations'''
*Unified CVP requires application storage to be on VMFS. Raw Device Mapping (RDM) is not supported.
* The total size of all Virtual Machines on a disk (total size = VM disk + RAM copy) must not exceed 90% of the capacity of a datastore.
'''Input/Output Operations per Second (IOPS) Considerations'''
* IOPS utilization should be monitored for each application to ensure that the aggregate IOPS is not exceeding the capacity of the array. Prolonged buffering of IOPS against an array may result in degraded system performance and delayed reporting data availability. Refer to the Performance Requirements section below for additional information.
'''Maintenance Considerations'''
* To help keep your system running most efficiently, schedule automatic database purging and database backups to run when your system is least busy.
'''Support Considerations'''
* The ESXi boot from SAN feature is not supported; it must be installed to internal storage.

== Steps for Installing Unified CVP Components on Virtual Machines ==
Follow the steps and references below to install or migrate the Unified CVP components on Virtual Machines.
# Install, setup, and configure the UCS Hardware.
# Configure the UCS Network. See reference at [http://docwiki-dev.cisco.com/wiki/Unified_Contact_Center_Enterprise#UCS_Network_Configuration UCS Network Configuration].
# Install and Boot VMWare ESXi. Refer to the following installation guide: [http://www.cisco.com/en/US/docs/unified_computing/ucs/sw/b/os/vmware/install/bseries-vmware-install.html Cisco UCS B-Series Blade Servers VMware Installation Guide].
# Create the Unified CVP Virtual Machines from the OVA template. OVA templates are available [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y here ]
# Install Windows OS and Websphere Application Server (if using VXML Server with WAS) on the created Virtual Machines. (Note: Microsoft Windows Server 2003 ''Standard Edition'' should be used for virtual machine guests. See related information in the links below.)
#Install Unified CVP Software components on the configured Virtual Machines. See install reference for installing Unified CVP Components in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/cvp8_0/installation/guide/cvp_801_install.pdf Unified CVP Install and Upgrade guide].

== Unified CVP Component Capacities and VM Configuration Requirements ==

This section provides details associated with VM requirements. http://docwiki-dev.cisco.com/wiki/Unified_Communications_VMWare_Requirements

This table shows the supported Unified CVP components, their capacities, and the VM computing resource requirements.   You must use the OVA virtual machine templates to create the Unified CVP component VMs.

{| class="wikitable"
|-
! Unified CVP Component
! vCPU
! RAM (GB)
! vDisk (GB)
! vNIC
! Template Name

|-
| Unified CVP Call Server/VXML Server/co-located Call Server and VXML Server
| 4 vCPU
| 4 GB
| 146 GB
| 1 vNIC
| Cisco Unified CVP Call Server-VXML Server.ova

|-
| Unified CVP Reporting Server (Large)
| 4 vCPU
| 4 GB
| Disk 1 - 72 GB, Disk 2 - 438 GB
| 1 vNIC
| Cisco Unified CVP Reporting Server.ova

|-
| Unified CVP Operations Console
| 2 vCPU
| 2 GB RAM
| 20 GB
| 1 vNIC
| Cisco Unified CVP Operations Console.ova

|}

== Unified CVP Component Co-Residency ==

You can have one or more Unified CVP VMs co-resident on the same ESXi server.  However, you must follow the rules described below:
:* You can have any number of Unified CVP virtual machines and combination of co-residency of Unified CVP virtual machines on an ESXi server as long as the sum of all the virtual machine CPU and memory resource allocation is not over committed on the available ESXi server computing resources. 
:* You must not have CPU overcommitted on the ESXi server that is running Unified CVP application components .  The total number of vCPUs among all the virtual machines on an ESXi host must not greater than the total number of CPUs available on the ESXi server.  In the case of the Cisco UCS B-200 M1, the total number of CPUs available is 8.
:* You must not have memory overcommitted on the ESXi host that is running UC realtime applications.  You must allocate minimum 2GB of memory for the ESXi kernel.  For example, if an ESXi server on B-200 M1 hardware has 36GB of memory, after you allocate 2GB for the ESXi kernel, you have 34GB available for the virtual machines.  The total memory allocated for all the virtual machines on an ESXi server must not be greater than 34GB in this case.
:* VM co-residency with Unified Communications and third party applications were not tested on the same blade with Unified CVP products. '''

== Creating Virtual Machines from OVA VM Templates ==

Open Virtualization Format (OVF) is an open standard for packaging and distributing virtual appliances.  Files in this format have an extension of .ova. The naming convention for the template is PRODUCT_COMPONENT_USER COUNT_VERSION_VMVER.ova

Follow the instructions in the Downloading OVA Templates section below to download the OVA templates from cisco.com to a local datastore that vSphere Client can access.

=== Downloading OVA Templates ===
:*Proceed to the [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y Cisco Download Page for CVP].

:*To download a single OVA file, click the '''Download File''' button next to that file. To download multiple OVA files, click the '''Add to Cart''' button next to each file that you want to download, then click on the '''Download Cart''' link. A Download Cart page appears.

:*Click the '''Proceed with Download''' button on this page. A Software License Agreement page appears.

:*Read the Software License Agreement, then click the '''Agree''' button

:*On the next page, click on either the '''Download Manager''' link (requires Java) or the '''Non Java Download Option''' link. A new browser window appears.

:*If you selected Download Manager, a Select Location dialog box appears. Specify the location where you want to save the file, and click '''Open''' to save the file to your local machine.

:*If you selected Non Java Download Option, click the '''Download''' link on the new browser window. Specify the location and save the file to your local machine.

=== Creating Virtual Machines by Deploying the OVA Templates ===

In the vSphere client, perform the following steps to deploy the Virtual machines.

# Highlight the host or cluster to which you wish the VM to be deployed.
# Select '''File''' > '''Deploy OVF Template'''.
# Click the '''Deploy from File''' radio button and specify the name and location of the file you downloaded in the previous section '''or''' click the '''Deploy from URL''' radio button and specify the complete URL in the field, then click '''Next'''.
#Verify the details of the template, and click '''Next'''.
#Give the VM you are about to create a name, and choose an inventory location on your host, then click '''Next'''.
#Choose the datastore on which you would like the VM to reside - be sure there is sufficient free space to accommodate the new VM, then click '''Next'''.
#Choose a virtual network for the VM, then click '''Next'''.
#Verify the deployment settings, then click '''Finish'''.

=== Notes ===
:* VM CPU affinity is not supported. You do not need to set CPU affinity for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform.
:* VM resource Reservation - VM resource reservation is not supported for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform. The VM computing resources should have a default reservation setting, which is no resource reservations.
:* You cannot change the computing resource configuration of your VM at any time.
:* You can never go below the minimum VM computing resource requirements as defined in the OVA templates.
:* It is required that hyperthreading be enabled by default when running CVP on ESXi. ESXi Server hyperthread is enabled by default and this setting should not be modified. Please ensure all VM's with CVP servers has hyperthreading enabled.

== Remote Control of the Virtual Machines ==

For administrative tasks, you can use either Windows Remote Desktop or the VMware Infrastructure Client for remote control.

== Installing VMware Tools==

The VMware Tools must be installed on each of the VMs and all of the VMware Tools default settings should be used. Please refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware documentation] for instructions on installing or upgrading VMware Tools on the VM with Windows operating system.

== Installing Unified CVP Components on Virtual Machines ==
You can install the Unified CVP components after the configuration of the VMs. Installation of these Unified CVP components on a VM is the same as the installation of these components on physical hardware.

Refer to the Unified CVP documentation for the steps to install Unified CVP components. You can install the supported Virus Scan software, the Cisco Security Agent (CSA), or any other software in the same way as on physical hardware.

== Configuring the ESXi Data Store Block Size for Administration and Data Server ==

The creation of the virtual machine for the Unified CVP Reporting Server requires a large virtual disk size. You must follow the steps described below to configure the ESXi data store size to 438 GB for it to handle the Unified CVP Reporting Server data before you deploy the OVAs

Steps to configure the ESXi for CVP Reporting server to RAID10 found at [[ CVP Reporting Server Configuration ]]

== Performance Requirements ==

:* CPU usage (average) should not exceed 60% for the ESXi Server and for each of the individual processors, and for each VM.
:* Memory usage (average) should not exceed 80% for the ESXi Server and for each of the VMs.
:* VM snapshots are not supported in production since they have significant impact on system performance. 
:* The SAN must be able to handle the following Unified CVP application disk I/O characteristics.
:* Enable hyperthreading on all ESXi servers.

== Performance Numbers on B-Series ==

'''HTTP Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 900
|-
| VXML Standalone
| 900
|-
| VXML Standalone with Req ICM Label (VXML Server on Tomcat)
| 900
|-
| VXML Standalone on WAS
| 900
|-
| VXML Standalone with Req ICM Label on WAS
| 900
|}

'''HTTPS Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 275
|-
| VXML Standalone
| 275
|-
| VXML Standalone on WAS
| 275
|}

== VM IOPS Measurement ==

'''IOPS Summary: (Unit in Number, Data are Blade-based)'''
{| class="wikitable"
|-
!CVP Server
!Average
!MAX
!95th Percentile
|-
|CS/VXML Servers
|380
|1536
|797
|-
|Reporting Server
|692
|3403
|2024
|}

== Timekeeping Best Practices for Windows ==

You should follow the best practices outlined in the VMware Knowledge Base article [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1318 VMware KB: Timekeeping best practices for Windows].
* ESXi hosts and domain controllers should synchronize the time from the same NTP source.
* When Unified Unified CVP virtual machines join the domain, they synchronize the time with the domain controller automatically using w32time.
* Be sure that '''Time synchronization between the virtual machine and the host operating system''' in the VMware Tools tool box GUI of the Windows Server 2003 guest operating system remains deselected; this checkbox is deselected by default.

== System Performance Monitoring Using Windows Perfmon Counters ==

You must comply with the best practices described in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf SRND section System Performance Monitoring].

-----
Back to [http://docwiki-dev.cisco.com/wiki/Unified_Communications_Virtualization Unified Communications Virtualization main page]

Unified Customer Voice Portal

2010-10-06T14:49:11Z

Jbeaudry: /* Updates to this Page */

== Updates to this Page ==

The following is a list of significant updates to this page:

{| class="wikitable"

|-
! Date
! Update

|-
| October 1, 2010
| Initial version.
|-
|
|
|-

|}

== Information for Partners about Cisco Unified CVP on UCS Deployment Certification and Ordering ==
'''It is important that partners who are planning to sell UCS products on Unified Cisco Customer Voice Portal, read the ''' '''[http://docwiki-dev.cisco.com/wiki/Unified_Contact_Center_Enterprise Unified CCE DocWiki page].'''

This page contains essential information for partners about the following:

:* Partner Certification Requirements
:* UCS Server Ordering Information
:* Important Notes on Cisco UCS Service and Support

== Unified CVP 8.0(1) Support for Virtualization on the ESXi/UCS Platform ==
Starting with Release 8.0(1), virtualization of the following deployments and Unified CVP components on Cisco Unified Communications Systems (UCS) B-Series hardware is supported:
:* Unified CVP Call Server
:* Unified CVP VXML Server
:* Unified CVP Reporting Server
:* Unified CVP Ops Console

The following deployments and Unified CVP components have not been qualified and '''are not supported''' in virtualization:
:* H323 Call flow Deployment
:* Distributed VXML Server and Call Server deployment where each server runs in a separate VM
:* All in one lab deployment with small reporting server

The following VMware features are not supported with Unified CVP:
:* VMware Physical to Virtual migration
:* VMware Snapshots
:* VMware Consolidated Backup
:* VMware High Availability (HA)
:* VMware Site Recovery Manager
:* VMware vCenter Update Manager
:* VMware vCenter Converter

== UCS Hardware Requirements ==
Requirements for Cisco Unified Customer Voice Portal using UCS B200 M1 hardware are located [http://docwiki-dev.cisco.com/wiki/Unified_Computing_System_Hardware#B-200_M1_Requirements here].

== VMware and Application Software Requirements ==

The following software requirements apply specifically to Unified Customer Voice Portal:

:* VMWare ESXi 4.0 only, minimum version 4.0U1. Versions of ESXi prior to 4.0U1 and all versions of ESX are unsupported.
:* The Windows, Informix, and other third party software requirements for the Unified CVP applications in the ESXi/UCS platform are the same as in the physical server. For such information, refer to the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf Hardware and System Software Specification for Cisco Unified Customer Voice Portal, Release 8.0(1)].

== UCS Network Configuration ==

'''IMPORTANT:''' For instructions on performing the network configuration needed to deploy Cisco Unified Customer Voice Portal (Unified CVP) on a virtualized platform, please see below.

'''1) TCP Setting modification on Reporting Server'''
It is highly recommended that customers modify the default "Number of Receive Buffers" setting on the Reporting server to maximize full reporting and call load on the virtualized platform. If this setting is not modified after installing the OS, messages will get backed up on the CallServer and Message Queues will fill up resulting in a sharp drop in cps rate.

* Set the "Number of Receive buffers" on the Reporting Server TCP settings to 4096 (max).
Instructions:
# On Reporting server, click on Control Panel->Network Connection.
# Right click on Network Connection.
# Click on advanced tab.
# Under property tab, select "Number of Receive Buffers".
# In the Value pulldown, enter 4096.
# Restart the Reporting Server.

'''2) Use TCP protocol over UDP for SIP Comprehensive call flow as a SIP Best Practice''' Use TCP for SIP Comprehensive call flows. Using UDP may cause call setup failures or may result in abnormally long calls under heavy load. Typically TCP should be set on all call legs, but it is a requirement on the ingress leg. This can be set on the POTS dialpeer by setting the session transport to tcp.

'''3) Cisco VLAN trunking to VMWare'''
For information on best practices for Cisco VLAN trunking to VMware, refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware website ].

=== Support for Unified Communications Manager Clustering Over the WAN with Unified CVP on UCS Hardware ===

You can deploy the Unified Communications Manager (Unified CM) Clustering Over the WAN deployment model with Unified CVP on UCS B-series hardware.

When you implement this deployment model, be sure to follow the best practices outlined in the section "Multiple Cisco Unified CM Clusters" in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf Cisco Unified CVP Solution Reference Network Design (SRND) ].

In addition, note the following expectation for UCS B-series hardware points of failure:

* Multiple points of failure on the Unified CVP UCS B-series HA deployment can cause catastrophic failure, such as ICM software failovers and interruption of service. If multiple points of failure occur, replace the failed redundant components and links immediately.

* '''B-Series Considerations'''
When deploying Clustering Over the WAN with B-Series hardware, use of the Cisco UCS M81KR Virtual Interface Card is mandatory.

New B-Series deployments using Clustering Over the WAN must use a Nexus 7000 Series / Nexus 5000 Series vPC infrastructure, or a Cisco Catalyst 6500 Series Virtual Switching Supervisor Engine 720-10G.

== Notes for Deploying Unified CVP Applications on UCS B-Series Hardware with SAN ==

In Storage Area Network (SAN) architecture, storage consists of a series of arrays of Redundant Array of Independent Disks (RAIDs). A Logical Unit Number (LUN) that represents a device identifier can be created on a RAID array. A LUN can occupy all or part of a single RAID array, or span multiple RAID arrays.

In a virtualized environment, datastores are created on LUNs. Virtual Machines (VMs) are installed on the SAN datastore.

Keep the following considerations in mind when deploying Unified CVP 
 applications on UCS B-series hardware with SAN:

'''Compliance Considerations'''
* A SAN RAID group must be dedicated to Unified CVP database components; these SAN RAID groups must not be shared by other applications. The SAN disk array must be configured as RAID 10, for added performance and fault tolerance. SAN solutions are typically deployed in a shared environment where multiple applications are contending for storage access. If the SAN storage deployment is identified as affecting the functions of the contact center solution, the customer will be required to deploy a direct attached storage solution instead. Moreover, if in the process of troubleshooting, the SAN itself is identified as the problem, the customer must contact the system integrator or the SAN vendor for resolution.

'''Design Considerations'''
* The SAN must be designed in accordance with the UCS High Availability guidelines documented at [http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns224/ns944/white_paper_c11-553711.html].
* The SAN design and configuration must meet the Unified CVP IOPS and Performance numbers described in the [http://docwiki-dev.cisco.com/wiki/Cisco_Voice_Portal#Performance_Requirements Performance Requirements].
* The SAN design and configuration must meet the following VMware ESXi disk performance guidelines:
** Disk Command Latency – It should be 15 mSec or less. 15mSec latencies or greater indicates a possible over-utilized, mis-behaving, or mis-configured disk array.
'''Configuration Considerations'''
*For UCS B-series, Virtual Machines must be stored on and booted from the SAN.
** Kernel Disk Command Latency – It should be very small '''(>>>DACHEW to provide specific number)''' in comparison to the Physical Device Command Latency, and it should be close to zero. A high Kernel Command Latency indicates there is a lot of queuing in the ESXi kernel.
* The SAN design and configuration must meet the following Windows performance counters on Unified CVP VMs:
** AverageDiskQueueLength must remain less than (1.5 ∗ (the total number of disks in the array)).
** %Disktime must remain less than 60%.
* Any given SAN array must be designed to have an IOPS capacity exceeding the sum of the IOPS required for all resident UC applications. Unified CVP applications should be designed for the 95th percentile IOPS values published in this wiki. Refer to the Performance Requirements section below for additional information. For other UC applications, please follow their respective IOPS requirements and guidelines.
'''Storage/Size Considerations'''
*Unified CVP requires application storage to be on VMFS. Raw Device Mapping (RDM) is not supported.
* The total size of all Virtual Machines on a disk (total size = VM disk + RAM copy) must not exceed 90% of the capacity of a datastore.
'''Input/Output Operations per Second (IOPS) Considerations'''
* IOPS utilization should be monitored for each application to ensure that the aggregate IOPS is not exceeding the capacity of the array. Prolonged buffering of IOPS against an array may result in degraded system performance and delayed reporting data availability. Refer to the Performance Requirements section below for additional information.
'''Maintenance Considerations'''
* To help keep your system running most efficiently, schedule automatic database purging and database backups to run when your system is least busy.
'''Support Considerations'''
* The ESXi boot from SAN feature is not supported; it must be installed to internal storage.

== Steps for Installing Unified CVP Components on Virtual Machines ==
Follow the steps and references below to install or migrate the Unified CVP components on Virtual Machines.
# Install, setup, and configure the UCS Hardware.
# Configure the UCS Network. See reference at [http://docwiki-dev.cisco.com/wiki/Unified_Contact_Center_Enterprise#UCS_Network_Configuration UCS Network Configuration].
# Install and Boot VMWare ESXi. Refer to the following installation guide: [http://www.cisco.com/en/US/docs/unified_computing/ucs/sw/b/os/vmware/install/bseries-vmware-install.html Cisco UCS B-Series Blade Servers VMware Installation Guide].
# Create the Unified CVP Virtual Machines from the OVA template. OVA templates are available [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y here ]
# Install Windows OS and Websphere Application Server (if using VXML Server with WAS) on the created Virtual Machines. (Note: Microsoft Windows Server 2003 ''Standard Edition'' should be used for virtual machine guests. See related information in the links below.)
#Install Unified CVP Software components on the configured Virtual Machines. See install reference for installing Unified CVP Components in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/cvp8_0/installation/guide/cvp_801_install.pdf Unified CVP Install and Upgrade guide].

== Unified CVP Component Capacities and VM Configuration Requirements ==

This section provides details associated with VM requirements. http://docwiki-dev.cisco.com/wiki/Unified_Communications_VMWare_Requirements

This table shows the supported Unified CVP components, their capacities, and the VM computing resource requirements.   You must use the OVA virtual machine templates to create the Unified CVP component VMs.

{| class="wikitable"
|-
! Unified CVP Component
! vCPU
! RAM (GB)
! vDisk (GB)
! vNIC
! Template Name

|-
| Unified CVP Call Server/VXML Server/co-located Call Server and VXML Server
| 4 vCPU
| 4 GB
| 146 GB
| 1 vNIC
| Cisco Unified CVP Call Server-VXML Server.ova

|-
| Unified CVP Reporting Server (Large)
| 4 vCPU
| 4 GB
| Disk 1 - 72 GB, Disk 2 - 438 GB
| 1 vNIC
| Cisco Unified CVP Reporting Server.ova

|-
| Unified CVP Operations Console
| 2 vCPU
| 2 GB RAM
| 20 GB
| 1 vNIC
| Cisco Unified CVP Operations Console.ova

|}

== Unified CVP Component Co-Residency ==

You can have one or more Unified CVP VMs co-resident on the same ESXi server.  However, you must follow the rules described below:
:* You can have any number of Unified CVP virtual machines and combination of co-residency of Unified CVP virtual machines on an ESXi server as long as the sum of all the virtual machine CPU and memory resource allocation is not over committed on the available ESXi server computing resources. 
:* You must not have CPU overcommitted on the ESXi server that is running Unified CVP application components .  The total number of vCPUs among all the virtual machines on an ESXi host must not greater than the total number of CPUs available on the ESXi server.  In the case of the Cisco UCS B-200 M1, the total number of CPUs available is 8.
:* You must not have memory overcommitted on the ESXi host that is running UC realtime applications.  You must allocate minimum 2GB of memory for the ESXi kernel.  For example, if an ESXi server on B-200 M1 hardware has 36GB of memory, after you allocate 2GB for the ESXi kernel, you have 34GB available for the virtual machines.  The total memory allocated for all the virtual machines on an ESXi server must not be greater than 34GB in this case.
:* VM co-residency with Unified Communications and third party applications were not tested on the same blade with Unified CVP products. '''

== Creating Virtual Machines from OVA VM Templates ==

Open Virtualization Format (OVF) is an open standard for packaging and distributing virtual appliances.  Files in this format have an extension of .ova. The naming convention for the template is PRODUCT_COMPONENT_USER COUNT_VERSION_VMVER.ova

Follow the instructions in the Downloading OVA Templates section below to download the OVA templates from cisco.com to a local datastore that vSphere Client can access.

=== Downloading OVA Templates ===
:*Proceed to the [http://tools.cisco.com/support/downloads/go/ImageList.x?relVer=8.0%281%29&mdfid=270563413&sftType=Cisco+Customer+Voice+Portal+Software+Releases&optPlat=&nodecount=2&edesignator=null&modelName=Cisco+Unified+Customer+Voice+Portal&treeMdfId=278875240&treeName=Voice+and+Unified+Communications&modifmdfid=null&imname=&hybrid=Y&imst=N&lr=Y Cisco Download Page for CVP].

:*To download a single OVA file, click the '''Download File''' button next to that file. To download multiple OVA files, click the '''Add to Cart''' button next to each file that you want to download, then click on the '''Download Cart''' link. A Download Cart page appears.

:*Click the '''Proceed with Download''' button on this page. A Software License Agreement page appears.

:*Read the Software License Agreement, then click the '''Agree''' button

:*On the next page, click on either the '''Download Manager''' link (requires Java) or the '''Non Java Download Option''' link. A new browser window appears.

:*If you selected Download Manager, a Select Location dialog box appears. Specify the location where you want to save the file, and click '''Open''' to save the file to your local machine.

:*If you selected Non Java Download Option, click the '''Download''' link on the new browser window. Specify the location and save the file to your local machine.

=== Creating Virtual Machines by Deploying the OVA Templates ===

In the vSphere client, perform the following steps to deploy the Virtual machines.

# Highlight the host or cluster to which you wish the VM to be deployed.
# Select '''File''' > '''Deploy OVF Template'''.
# Click the '''Deploy from File''' radio button and specify the name and location of the file you downloaded in the previous section '''or''' click the '''Deploy from URL''' radio button and specify the complete URL in the field, then click '''Next'''.
#Verify the details of the template, and click '''Next'''.
#Give the VM you are about to create a name, and choose an inventory location on your host, then click '''Next'''.
#Choose the datastore on which you would like the VM to reside - be sure there is sufficient free space to accommodate the new VM, then click '''Next'''.
#Choose a virtual network for the VM, then click '''Next'''.
#Verify the deployment settings, then click '''Finish'''.

=== Notes ===
:* VM CPU affinity is not supported. You do not need to set CPU affinity for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform.
:* VM resource Reservation - VM resource reservation is not supported for the VMs that are running Unified CVP applications on the VMware ESXi on UCS platform. The VM computing resources should have a default reservation setting, which is no resource reservations.
:* You cannot change the computing resource configuration of your VM at any time.
:* You can never go below the minimum VM computing resource requirements as defined in the OVA templates.
:* It is required that hyperthreading be enabled by default when running CVP on ESXi. ESXi Server hyperthread is enabled by default and this setting should not be modified. Please ensure all VM's with CVP servers has hyperthreading enabled.

== Remote Control of the Virtual Machines ==

For administrative tasks, you can use either Windows Remote Desktop or the VMware Infrastructure Client for remote control.

== Installing VMware Tools==

The VMware Tools must be installed on each of the VMs and all of the VMware Tools default settings should be used. Please refer to the [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806|http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003806 VMware documentation] for instructions on installing or upgrading VMware Tools on the VM with Windows operating system.

== Installing Unified CVP Components on Virtual Machines ==
You can install the Unified CVP components after the configuration of the VMs. Installation of these Unified CVP components on a VM is the same as the installation of these components on physical hardware.

Refer to the Unified CVP documentation for the steps to install Unified CVP components. You can install the supported Virus Scan software, the Cisco Security Agent (CSA), or any other software in the same way as on physical hardware.

== Configuring the ESXi Data Store Block Size for Administration and Data Server ==

The creation of the virtual machine for the Unified CVP Reporting Server requires a large virtual disk size. You must follow the steps described below to configure the ESXi data store size to 438 GB for it to handle the Unified CVP Reporting Server data before you deploy the OVAs

Steps to configure the ESXi for CVP Reporting server to RAID10

[[CVP Reporting Server Configuration]]

== Performance Requirements ==

:* CPU usage (average) should not exceed 60% for the ESXi Server and for each of the individual processors, and for each VM.
:* Memory usage (average) should not exceed 80% for the ESXi Server and for each of the VMs.
:* VM snapshots are not supported in production since they have significant impact on system performance. 
:* The SAN must be able to handle the following Unified CVP application disk I/O characteristics.
:* Enable hyperthreading on all ESXi servers.

== Performance Numbers on B-Series ==

'''HTTP Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 900
|-
| VXML Standalone
| 900
|-
| VXML Standalone with Req ICM Label (VXML Server on Tomcat)
| 900
|-
| VXML Standalone on WAS
| 900
|-
| VXML Standalone with Req ICM Label on WAS
| 900
|}

'''HTTPS Performance Metrics'''
* The following metrics are measured with full reporting

{| class="wikitable"
|-
!Call flow
!Simultaneous Calls Supported
|-
| SIP Comprehensive
| 275
|-
| VXML Standalone
| 275
|-
| VXML Standalone on WAS
| 275
|}

== VM IOPS Measurement ==

'''IOPS Summary: (Unit in Number, Data are Blade-based)'''
{| class="wikitable"
|-
!CVP Server
!Average
!MAX
!95th Percentile
|-
|CS/VXML Servers
|380
|1536
|797
|-
|Reporting Server
|692
|3403
|2024
|}

== Timekeeping Best Practices for Windows ==

You should follow the best practices outlined in the VMware Knowledge Base article [http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1318 VMware KB: Timekeeping best practices for Windows].
* ESXi hosts and domain controllers should synchronize the time from the same NTP source.
* When Unified Unified CVP virtual machines join the domain, they synchronize the time with the domain controller automatically using w32time.
* Be sure that '''Time synchronization between the virtual machine and the host operating system''' in the VMware Tools tool box GUI of the Windows Server 2003 guest operating system remains deselected; this checkbox is deselected by default.

== System Performance Monitoring Using ESXi Counters ==
Not available at this time.

== System Performance Monitoring Using Windows Perfmon Counters ==

You must comply with the best practices described in the [http://www.cisco.com/en/US/docs/voice_ip_comm/cust_contact/contact_center/customer_voice_portal/srnd/8x/cvp8xsrnd.pdf SRND section System Performance Monitoring].

-----
Back to [http://docwiki-dev.cisco.com/wiki/Unified_Communications_Virtualization Unified Communications Virtualization main page]

Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace

2008-06-23T22:02:18Z

Jbeaudry: /* To Uninstall Cisco Security Agent for Cisco Security Agent for Cisco Unified MeetingPlace */

[[Cisco Unified MeetingPlace, Release 6.x ]]

<pre>
Questions about content on this page have been added to the Discussion page.

To view, discuss, or answer the questions, or to post your own,

click the Discussion tab at the top of this page.
</pre>

Cisco Security Agent for Cisco Unified MeetingPlace is a standalone Cisco Security Agent that is provided free of charge by Cisco Systems for use with Cisco Unified MeetingPlace installations that meet the requirements specified below. This information is for Cisco Security Agent for Cisco Unified MeetingPlace Release 6.0(7).

* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Introduction|Introduction]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Requirements and Supported Software|Requirements and Supported Software]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installation and Upgrade Information|Installation and Upgrade Information]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace|Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace]]
* [http://www.cisco.com/en/US/docs/voice_ip_comm/meetingplace/6x/security_agent/release/notes/601mpcsarn.html Release Notes]

== Introduction ==

Cisco Security Agent for Cisco Unified MeetingPlace is supported for use with certain Cisco Unified MeetingPlace components. (See the list at [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Requirements and Supported Software|Requirements and Supported Software]].)

The standalone Cisco Security Agent provides:
* Intrusion detection and prevention for Cisco Unified MeetingPlace software.
* Defense against previously unknown attacks because it does not require signatures, as antivirus software does.
* Reduced downtime, attack propagation, and cleanup costs.

The agent provides Microsoft Windows platform security (host intrusion detection and prevention) that is based on a tested set of security rules known as a policy. The policy allows or denies specific system actions before system resources are accessed, based on the following criteria:
* The resources being accessed.
* The operation being invoked.
* The process invoking the action.

This occurs transparently and does not greatly hinder overall system performance.

Version 6.0(7) of the standalone Cisco Security Agent for Cisco Unified MeetingPlace is compiled with [http://www.cisco.com/en/US/products/ps6786/index.html Cisco Security Agent version 5.0.0], build 205.

'''Caution! ''' Do not view Cisco Security Agent for Cisco Unified MeetingPlace as providing complete security for Cisco Unified MeetingPlace installations. Instead, view it as an additional line of defense that, when used correctly with other standard defenses such as antivirus software and firewalls, provides enhanced security. Cisco Security Agent for Cisco Unified MeetingPlace provides enhanced defense for many different Cisco Unified MeetingPlace installations and configurations, and therefore cannot enforce network access control rules, which block outbound or inbound network traffic, or act as a host-based firewall.

The best starting point for references to security and voice products is http://www.cisco.com/go/ipcsecurity. We recommend the ''IP Telephony Security Operations Guide to Best Practices''.

== Requirements and Supported Software ==

* Microsoft Windows Server 2003 in English. Other language versions are not supported.
* One or more of the following supported software versions:

{| border = 1
|-
|

Cisco Unified MeetingPlace Directory Services
|

5.4(104)
|-
|

Cisco Unified MeetingPlace for Lotus Notes
|

6.0(15.0)
|-
|

Cisco Unified MeetingPlace for Office Communicator
|

6.0(11.0)
|-
|

Cisco Unified MeetingPlace for Outlook
|

6.0(14.0)
|-
|

Cisco Unified MeetingPlace H.323/SIP Gateway
|

5.3(1.8)
|-
|

Cisco Unified MeetingPlace SMTP E-Mail Gateway
|

5.4(108)
|-
|

Cisco Unified MeetingPlace Video Integration
|

5.4(107.0)
|-
|

Cisco Unified MeetingPlace Web Conferencing
|

6.0(171.0)
|}

== Installation and Upgrade Information ==
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)|Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)|Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installation and Upgrade Notes|Installation and Upgrade Notes]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace|Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace]]

=== Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) ===

'''Note: ''' If Cisco Unified MeetingPlace Web Conferencing Release 6.0(171.0) is installed on the server, the Web Conferencing installer places a copy of the Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) installation executable in the C:\Program Files\Cisco Systems\MPWeb directory. The file name is CiscoUnifiedMeetingPlaceCSA-K9.exe.

===== To Download Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) =====

# Confirm that the computer you are using has up to 20 MB of hard-disk space for the download file and the installed files.
# On a computer with a high-speed Internet connection, go to the Cisco Unified MeetingPlace Crypto Software Download page at http://www.cisco.com/cgi-bin/tablebuild.pl/meetingplace-3d.
#: '''Note: ''' To access the software download page, you must be logged on to Cisco.com as a registered user.
# Because of export controls on strong encryption, the first time you download Cisco Security Agent for Cisco Unified MeetingPlace, you need to fill out a brief questionnaire. Follow the on-screen prompts.
# Click '''CiscoMeetingPlaceWebConfCSA607-K9.exe'''.
# Follow the on-screen prompts to complete the download.
# If you plan to install Cisco Security Agent for Cisco Unified MeetingPlace from a compact disc, burn the CD.

=== Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) ===

We recommend that you install Cisco Security Agent for Cisco Unified MeetingPlace after regular business hours because the installation process will affect Cisco Unified MeetingPlace performance. In addition, when the installation completes, you must restart the Cisco Unified MeetingPlace server for Cisco Security Agent for Cisco Unified MeetingPlace to start working.

'''Note''' Install Cisco Security Agent for Cisco Unified MeetingPlace ''after'' you have installed other software on the server.

'''Caution! ''' Do not install Cisco Security Agent for Cisco Unified MeetingPlace by using Windows Terminal Services, or the installation will fail. 

===== To Install Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) =====

# Log on to the server by using an account that is a member of the Administrators group or the Local Administrators group.
# Confirm that the server has at least 20 MB of hard-disk space available for the download file and the installed files.
# If another intrusion-detection application is installed on the server, uninstall the application before installing Cisco Security Agent for Cisco Unified MeetingPlace. Refer to the applicable documentation.
# If Windows Automatic Update is configured to automatically download updates from the Microsoft website, disable it.
# If antivirus software is installed on the server, disable and stop the scanning services:
## On the Windows Start menu, click '''Programs > Administrative Tools > Services'''.
## In the right pane, double-click the name of the first virus-scanning service.
## On the General tab, in the Startup Type list, click '''Disabled'''. This prevents the service from starting when you restart the server.
## Click '''Stop '''to stop the service immediately.
## Click '''OK''' to close the Properties dialog box.
## Repeat Step 2 through Step 5 for each of the remaining virus-scanning services.
## When the services have been disabled, close the Services MMC.
# If Cisco Unified MeetingPlace Web Conferencing is not installed on the server (for example, you are installing Cisco Security Agent for Cisco Unified MeetingPlace on a standalone H.323/SIP Gateway server), perform the following sub-steps to add a key to the registry to allow the installer to proceed:
## On the Windows Start menu, click '''Run'''. Enter '''regedit''' and click '''OK'''.
## Expand the key HKEY_LOCAL_MACHINE\Software\Latitude.
## On the Edit menu, click '''New''' > '''Key'''.
## Name the new key '''MeetingPlace WebPublisher'''.
## Click the new MeetingPlace WebPublisher key, then click '''Edit''' > '''New''' > '''Key'''.
## Name the new key '''General'''.
## Click the new General key, then click '''Edit''' > '''New''' > '''String Value'''.
## Name the new string value '''Version'''.
## Right-click '''Version''' and click '''Modify'''.
## For Value Data, enter '''6.0.0.0''' and click '''OK'''.
## Close the registry editor.
# In Windows Explorer, browse to the directory to which you downloaded the Cisco Security Agent for Cisco Unified MeetingPlace file, and double-click '''CiscoMeetingPlaceWebConfCSA607-K9.exe'''.
# Follow the on-screen prompts.
# When the installation completes, click '''Yes, I Want to Restart My Computer Now''', and click '''Finish'''.

Cisco Security Agent for Cisco Unified MeetingPlace begins to work as soon as you restart the server. You do not need to configure the application.
# If antivirus software is installed on the server, re-enable and start the virus-scanning services:
## On the Windows Start menu, click '''Programs > Administrative Tools > Services'''.
## In the right pane, double-click the name of the first scanning service.
## On the General tab, in the Startup Type list, click '''Automatic''' to re-enable the service.
## Click '''Start '''to start the service.
## Click '''OK''' to close the Properties dialog box.
## Repeat Step b through Step e for each of the remaining virus-scanning services.
## When the services have been disabled, close the Services MMC.

=== Installation and Upgrade Notes ===

==== Disabling and Re-enabling the Cisco Security Agent Service ====

The Cisco Security Agent service must be stopped and disabled before you install or upgrade any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed.

(For information on other situations in which you must disable the Cisco Security Agent service, see the [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Cisco Security Agent Service Must Be Disabled for Specific Tasks|Cisco Security Agent Service Must Be Disabled for Specific Tasks]].)

This section contains two procedures:
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#To Stop and Disable the Cisco Security Agent Service|To Stop and Disable the Cisco Security Agent Service]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#To Re-enable and Start the Cisco Security Agent Service|To Re-enable and Start the Cisco Security Agent Service]]

When you stop and disable the Cisco Security Agent service, you must re-enable and start it before it can monitor the server again.

===== To Stop and Disable the Cisco Security Agent Service =====

# On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
# In the right pane, double-click '''Cisco Security Agent'''.
# On the General tab, click '''Stop''' to stop the service immediately.
# In the Startup Type list, click '''Disabled'''. This prevents the service from starting when you restart the server.
# Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# When the service has been disabled, close the Services MMC.

===== To Re-enable and Start the Cisco Security Agent Service =====

# On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
# In the right pane, double-click '''Cisco Security Agent'''.
# On the General tab, in the Startup Type list, click '''Automatic''' to re-enable the service.
# Click '''Start''' to start the service.
# Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# When the service has been re-enabled, close the Services MMC.

=== Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace ===

===== To Uninstall Cisco Security Agent for Cisco Security Agent for Cisco Unified MeetingPlace =====

# Stop the Cisco Security Agent service:
## On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
## In the right pane, double-click '''Cisco Security Agent'''.
## On the General tab, click '''Stop''' to stop the service immediately.
## Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# On the Windows Start menu, click '''Programs''' > '''Cisco Systems''' > '''Uninstall Cisco Security Agent'''.
# Click '''Yes''' to confirm that you want to uninstall Cisco Security Agent for Cisco Unified MeetingPlace.
# Click '''Yes''' again to restart the server.

Note that CSA tends to re-enable the built-in Windows firewall when it is uninstalled (see CSA defect CSCsm51740), even if the firewall had been disabled by hand prior to the installation of CSA. This is the expected behavior but may result in network connections such as Remote Desktop being denied while the firewall is enabled.

== Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace ==

The following sections contain information on using Cisco Security Agent for Cisco Unified MeetingPlace:
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Cisco Security Agent Service Must Be Disabled for Specific Tasks|Cisco Security Agent Service Must Be Disabled for Specific Tasks]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Locations in Which Cisco Security Agent Logs Events|Locations in Which Cisco Security Agent Logs Events]]

=== Cisco Security Agent Service Must Be Disabled for Specific Tasks ===

The Cisco Security Agent service must be disabled and stopped in the following situations:
* Before you install any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed.
* Before you upgrade any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed. This also applies to automatic upgrades (for example, installing service packs by using group policy objects or custom scripts). Cisco Security Agent for Cisco Unified MeetingPlace allows supported antivirus applications to automatically download and install upgrades to antivirus components.
* Before you add, change, or delete values in the Windows registry.
* Before you change Windows system or boot files.

When you disable and stop the Cisco Security Agent service, you must re-enable and start it before it can monitor the server again.

For instructions on disabling and re-enabling the service, see the [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Disabling and Re-enabling the Cisco Security Agent Service|Disabling and Re-enabling the Cisco Security Agent Service]].

=== Locations in Which Cisco Security Agent Logs Events ===

Cisco Security Agent logs events in the following three locations:

{| border = 1
|-
|
''' Windows application event log'''
|

Events that are generated by Cisco Security Agent have an event source of CSAgent.
|-
|
''' Securitylog.txt'''
|

Cisco Security Agent logs one event per line. The data in the file is in comma-separated-value format. In general, there should not be many entries in the file, so you should be able to read it in a text editor, for example, Notepad. (You might want to turn off word wrap.) If there are a lot of entries, you can view the data more easily if you copy the file to a computer on which a spreadsheet application is installed, change the file-name extension from .txt to .csv, and open the file in the spreadsheet application.

To view the log, double-click the Cisco Security Agent taskbar icon. In the tree control on the left of the Cisco Security Agent Panel, click '''Messages'''. Then click '''View Log'''. (The log appears in the Program Files\Cisco Systems\CSAgent\Log directory.)
|-
|
''' Current messages'''
|

To display events that have occurred since you logged on to Windows, double-click the Cisco Security Agent taskbar icon. In the Cisco Security Agent Panel, click '''Messages'''.
|}

[[Category:Unified MeetingPlace 6.0]]

Talk:Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace

2008-03-28T19:04:38Z

Jbeaudry:

As a docwiki reader, how would I indicate a potentially missing section? In this particular case, what if I was interested in a managed agent for MeetingPlace? I'd expect to see something about where to get the policy (export) file and perhaps a cross-reference pointer to the CSA MC on cisco.com.

Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace

2008-03-28T16:39:58Z

Jbeaudry: /* Introduction */

[[Cisco Unified MeetingPlace, Release 6.x ]]

Cisco Security Agent for Cisco Unified MeetingPlace is a standalone Cisco Security Agent that is provided free of charge by Cisco Systems for use with Cisco Unified MeetingPlace installations that meet the requirements specified below. This information is for Cisco Security Agent for Cisco Unified MeetingPlace Release 6.0(7).

* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Introduction|Introduction]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Requirements and Supported Software|Requirements and Supported Software]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installation and Upgrade Information|Installation and Upgrade Information]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace|Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace]]
* [http://www.cisco.com/en/US/docs/voice_ip_comm/meetingplace/6x/security_agent/release/notes/601mpcsarn.html Release Notes]

== Introduction ==

Cisco Security Agent for Cisco Unified MeetingPlace is supported for use with certain Cisco Unified MeetingPlace components. (See the list at [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Requirements and Supported Software|Requirements and Supported Software]].)

The standalone Cisco Security Agent provides:
* Intrusion detection and prevention for Cisco Unified MeetingPlace software.
* Defense against previously unknown attacks because it does not require signatures, as antivirus software does.
* Reduced downtime, attack propagation, and cleanup costs.

The agent provides Microsoft Windows platform security (host intrusion detection and prevention) that is based on a tested set of security rules known as a policy. The policy allows or denies specific system actions before system resources are accessed, based on the following criteria:
* The resources being accessed.
* The operation being invoked.
* The process invoking the action.

This occurs transparently and does not greatly hinder overall system performance.

Version 6.0(7) of the standalone Cisco Security Agent for Cisco Unified MeetingPlace is compiled with [http://www.cisco.com/en/US/products/ps6786/index.html Cisco Security Agent version 5.0.0], build 205.

'''Caution! ''' Do not view Cisco Security Agent for Cisco Unified MeetingPlace as providing complete security for Cisco Unified MeetingPlace installations. Instead, view it as an additional line of defense that, when used correctly with other standard defenses such as antivirus software and firewalls, provides enhanced security. Cisco Security Agent for Cisco Unified MeetingPlace provides enhanced defense for many different Cisco Unified MeetingPlace installations and configurations, and therefore cannot enforce network access control rules, which block outbound or inbound network traffic, or act as a host-based firewall.

The best starting point for references to security and voice products is http://www.cisco.com/go/ipcsecurity. We recommend the ''IP Telephony Security Operations Guide to Best Practices''.

== Requirements and Supported Software ==

* Microsoft Windows Server 2003 in English. Other language versions are not supported.
* One or more of the following supported software versions:

{| border = 1
|-
|

Cisco Unified MeetingPlace Directory Services
|

5.4(104)
|-
|

Cisco Unified MeetingPlace for Lotus Notes
|

6.0(15.0)
|-
|

Cisco Unified MeetingPlace for Office Communicator
|

6.0(11.0)
|-
|

Cisco Unified MeetingPlace for Outlook
|

6.0(14.0)
|-
|

Cisco Unified MeetingPlace H.323/SIP Gateway
|

5.3(1.8)
|-
|

Cisco Unified MeetingPlace SMTP E-Mail Gateway
|

5.4(108)
|-
|

Cisco Unified MeetingPlace Video Integration
|

5.4(107.0)
|-
|

Cisco Unified MeetingPlace Web Conferencing
|

6.0(171.0)
|}

== Installation and Upgrade Information ==
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)|Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)|Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installation and Upgrade Notes|Installation and Upgrade Notes]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace|Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace]]

=== Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) ===

'''Note: ''' If Cisco Unified MeetingPlace Web Conferencing Release 6.0(171.0) is installed on the server, the Web Conferencing installer places a copy of the Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) installation executable in the C:\Program Files\Cisco Systems\MPWeb directory. The file name is CiscoUnifiedMeetingPlaceCSA-K9.exe.

===== To Download Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) =====

# Confirm that the computer you are using has up to 20 MB of hard-disk space for the download file and the installed files.
# On a computer with a high-speed Internet connection, go to the Cisco Unified MeetingPlace Crypto Software Download page at http://www.cisco.com/cgi-bin/tablebuild.pl/meetingplace-3d.
#: '''Note: ''' To access the software download page, you must be logged on to Cisco.com as a registered user.
# Because of export controls on strong encryption, the first time you download Cisco Security Agent for Cisco Unified MeetingPlace, you need to fill out a brief questionnaire. Follow the on-screen prompts.
# Click '''CiscoMeetingPlaceWebConfCSA607-K9.exe'''.
# Follow the on-screen prompts to complete the download.
# If you plan to install Cisco Security Agent for Cisco Unified MeetingPlace from a compact disc, burn the CD.

=== Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) ===

We recommend that you install Cisco Security Agent for Cisco Unified MeetingPlace after regular business hours because the installation process will affect Cisco Unified MeetingPlace performance. In addition, when the installation completes, you must restart the Cisco Unified MeetingPlace server for Cisco Security Agent for Cisco Unified MeetingPlace to start working.

'''Note''' Install Cisco Security Agent for Cisco Unified MeetingPlace ''after'' you have installed other software on the server.

'''Caution! ''' Do not install Cisco Security Agent for Cisco Unified MeetingPlace by using Windows Terminal Services, or the installation will fail. 

===== To Install Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) =====

# Log on to the server by using an account that is a member of the Administrators group or the Local Administrators group.
# Confirm that the server has at least 20 MB of hard-disk space available for the download file and the installed files.
# If another intrusion-detection application is installed on the server, uninstall the application before installing Cisco Security Agent for Cisco Unified MeetingPlace. Refer to the applicable documentation.
# If Windows Automatic Update is configured to automatically download updates from the Microsoft website, disable it.
# If antivirus software is installed on the server, disable and stop the scanning services:
## On the Windows Start menu, click '''Programs > Administrative Tools > Services'''.
## In the right pane, double-click the name of the first virus-scanning service.
## On the General tab, in the Startup Type list, click '''Disabled'''. This prevents the service from starting when you restart the server.
## Click '''Stop '''to stop the service immediately.
## Click '''OK''' to close the Properties dialog box.
## Repeat Step 2 through Step 5 for each of the remaining virus-scanning services.
## When the services have been disabled, close the Services MMC.
# If Cisco Unified MeetingPlace Web Conferencing is not installed on the server (for example, you are installing Cisco Security Agent for Cisco Unified MeetingPlace on a standalone H.323/SIP Gateway server), perform the following sub-steps to add a key to the registry to allow the installer to proceed:
## On the Windows Start menu, click '''Run'''. Enter '''regedit''' and click '''OK'''.
## Expand the key HKEY_LOCAL_MACHINE\Software\Latitude.
## On the Edit menu, click '''New''' > '''Key'''.
## Name the new key '''MeetingPlace WebPublisher'''.
## Click the new MeetingPlace WebPublisher key, then click '''Edit''' > '''New''' > '''Key'''.
## Name the new key '''General'''.
## Click the new General key, then click '''Edit''' > '''New''' > '''String Value'''.
## Name the new string value '''Version'''.
## Right-click '''Version''' and click '''Modify'''.
## For Value Data, enter '''6.0.0.0''' and click '''OK'''.
## Close the registry editor.
# In Windows Explorer, browse to the directory to which you downloaded the Cisco Security Agent for Cisco Unified MeetingPlace file, and double-click '''CiscoMeetingPlaceWebConfCSA607-K9.exe'''.
# Follow the on-screen prompts.
# When the installation completes, click '''Yes, I Want to Restart My Computer Now''', and click '''Finish'''.

Cisco Security Agent for Cisco Unified MeetingPlace begins to work as soon as you restart the server. You do not need to configure the application.
# If antivirus software is installed on the server, re-enable and start the virus-scanning services:
## On the Windows Start menu, click '''Programs > Administrative Tools > Services'''.
## In the right pane, double-click the name of the first scanning service.
## On the General tab, in the Startup Type list, click '''Automatic''' to re-enable the service.
## Click '''Start '''to start the service.
## Click '''OK''' to close the Properties dialog box.
## Repeat Step b through Step e for each of the remaining virus-scanning services.
## When the services have been disabled, close the Services MMC.

=== Installation and Upgrade Notes ===

==== Disabling and Re-enabling the Cisco Security Agent Service ====

The Cisco Security Agent service must be stopped and disabled before you install or upgrade any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed.

(For information on other situations in which you must disable the Cisco Security Agent service, see the [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Cisco Security Agent Service Must Be Disabled for Specific Tasks|Cisco Security Agent Service Must Be Disabled for Specific Tasks]].)

This section contains two procedures:
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#To Stop and Disable the Cisco Security Agent Service|To Stop and Disable the Cisco Security Agent Service]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#To Re-enable and Start the Cisco Security Agent Service|To Re-enable and Start the Cisco Security Agent Service]]

When you stop and disable the Cisco Security Agent service, you must re-enable and start it before it can monitor the server again.

===== To Stop and Disable the Cisco Security Agent Service =====

# On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
# In the right pane, double-click '''Cisco Security Agent'''.
# On the General tab, click '''Stop''' to stop the service immediately.
# In the Startup Type list, click '''Disabled'''. This prevents the service from starting when you restart the server.
# Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# When the service has been disabled, close the Services MMC.

===== To Re-enable and Start the Cisco Security Agent Service =====

# On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
# In the right pane, double-click '''Cisco Security Agent'''.
# On the General tab, in the Startup Type list, click '''Automatic''' to re-enable the service.
# Click '''Start''' to start the service.
# Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# When the service has been re-enabled, close the Services MMC.

=== Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace ===

===== To Uninstall Cisco Security Agent for Cisco Security Agent for Cisco Unified MeetingPlace =====

# Stop the Cisco Security Agent service:
## On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
## In the right pane, double-click '''Cisco Security Agent'''.
## On the General tab, click '''Stop''' to stop the service immediately.
## Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# On the Windows Start menu, click '''Programs''' > '''Cisco Systems''' > '''Uninstall Cisco Security Agent'''.
# Click '''Yes''' to confirm that you want to uninstall Cisco Security Agent for Cisco Unified MeetingPlace.
# Click '''Yes''' again to restart the server.

== Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace ==

The following sections contain information on using Cisco Security Agent for Cisco Unified MeetingPlace:
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Cisco Security Agent Service Must Be Disabled for Specific Tasks|Cisco Security Agent Service Must Be Disabled for Specific Tasks]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Locations in Which Cisco Security Agent Logs Events|Locations in Which Cisco Security Agent Logs Events]]

=== Cisco Security Agent Service Must Be Disabled for Specific Tasks ===

The Cisco Security Agent service must be disabled and stopped in the following situations:
* Before you install any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed.
* Before you upgrade any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed. This also applies to automatic upgrades (for example, installing service packs by using group policy objects or custom scripts). Cisco Security Agent for Cisco Unified MeetingPlace allows supported antivirus applications to automatically download and install upgrades to antivirus components.
* Before you add, change, or delete values in the Windows registry.
* Before you change Windows system or boot files.

When you disable and stop the Cisco Security Agent service, you must re-enable and start it before it can monitor the server again.

For instructions on disabling and re-enabling the service, see the [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Disabling and Re-enabling the Cisco Security Agent Service|Disabling and Re-enabling the Cisco Security Agent Service]].

=== Locations in Which Cisco Security Agent Logs Events ===

Cisco Security Agent logs events in the following three locations:

{| border = 1
|-
|
''' Windows application event log'''
|

Events that are generated by Cisco Security Agent have an event source of CSAgent.
|-
|
''' Securitylog.txt'''
|

Cisco Security Agent logs one event per line. The data in the file is in comma-separated-value format. In general, there should not be many entries in the file, so you should be able to read it in a text editor, for example, Notepad. (You might want to turn off word wrap.) If there are a lot of entries, you can view the data more easily if you copy the file to a computer on which a spreadsheet application is installed, change the file-name extension from .txt to .csv, and open the file in the spreadsheet application.

To view the log, double-click the Cisco Security Agent taskbar icon. In the tree control on the left of the Cisco Security Agent Panel, click '''Messages'''. Then click '''View Log'''. (The log appears in the Program Files\Cisco Systems\CSAgent\Log directory.)
|-
|
''' Current messages'''
|

To display events that have occurred since you logged on to Windows, double-click the Cisco Security Agent taskbar icon. In the Cisco Security Agent Panel, click '''Messages'''.
|}

Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace

2008-03-28T16:39:00Z

Jbeaudry: /* Introduction */

[[Cisco Unified MeetingPlace, Release 6.x ]]

Cisco Security Agent for Cisco Unified MeetingPlace is a standalone Cisco Security Agent that is provided free of charge by Cisco Systems for use with Cisco Unified MeetingPlace installations that meet the requirements specified below. This information is for Cisco Security Agent for Cisco Unified MeetingPlace Release 6.0(7).

* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Introduction|Introduction]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Requirements and Supported Software|Requirements and Supported Software]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installation and Upgrade Information|Installation and Upgrade Information]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace|Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace]]
* [http://www.cisco.com/en/US/docs/voice_ip_comm/meetingplace/6x/security_agent/release/notes/601mpcsarn.html Release Notes]

== Introduction ==

Cisco Security Agent for Cisco Unified MeetingPlace is supported for use with certain Cisco Unified MeetingPlace components. (See the list at [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Requirements and Supported Software|Requirements and Supported Software]].)

The standalone Cisco Security Agent provides:
* Intrusion detection and prevention for Cisco Unified MeetingPlace software.
* Defense against previously unknown attacks because it does not require signatures, as antivirus software does.
* Reduced downtime, attack propagation, and cleanup costs.

The agent provides Microsoft Windows platform security (host intrusion detection and prevention) that is based on a tested set of security rules known as a policy. The policy allows or denies specific system actions before system resources are accessed, based on the following criteria:
* The resources being accessed.
* The operation being invoked.
* The process invoking the action.

This occurs transparently and does not greatly hinder overall system performance.

Version 6.0(7) of the standalone Cisco Security Agent for Cisco Unified MeetingPlace is compiled with [http://www.cisco.com/en/US/products/ps6786/index.html | Cisco Security Agent version 5.0.0], build 205.

'''Caution! ''' Do not view Cisco Security Agent for Cisco Unified MeetingPlace as providing complete security for Cisco Unified MeetingPlace installations. Instead, view it as an additional line of defense that, when used correctly with other standard defenses such as antivirus software and firewalls, provides enhanced security. Cisco Security Agent for Cisco Unified MeetingPlace provides enhanced defense for many different Cisco Unified MeetingPlace installations and configurations, and therefore cannot enforce network access control rules, which block outbound or inbound network traffic, or act as a host-based firewall.

The best starting point for references to security and voice products is http://www.cisco.com/go/ipcsecurity. We recommend the ''IP Telephony Security Operations Guide to Best Practices''.

== Requirements and Supported Software ==

* Microsoft Windows Server 2003 in English. Other language versions are not supported.
* One or more of the following supported software versions:

{| border = 1
|-
|

Cisco Unified MeetingPlace Directory Services
|

5.4(104)
|-
|

Cisco Unified MeetingPlace for Lotus Notes
|

6.0(15.0)
|-
|

Cisco Unified MeetingPlace for Office Communicator
|

6.0(11.0)
|-
|

Cisco Unified MeetingPlace for Outlook
|

6.0(14.0)
|-
|

Cisco Unified MeetingPlace H.323/SIP Gateway
|

5.3(1.8)
|-
|

Cisco Unified MeetingPlace SMTP E-Mail Gateway
|

5.4(108)
|-
|

Cisco Unified MeetingPlace Video Integration
|

5.4(107.0)
|-
|

Cisco Unified MeetingPlace Web Conferencing
|

6.0(171.0)
|}

== Installation and Upgrade Information ==
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)|Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)|Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installation and Upgrade Notes|Installation and Upgrade Notes]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace|Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace]]

=== Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) ===

'''Note: ''' If Cisco Unified MeetingPlace Web Conferencing Release 6.0(171.0) is installed on the server, the Web Conferencing installer places a copy of the Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) installation executable in the C:\Program Files\Cisco Systems\MPWeb directory. The file name is CiscoUnifiedMeetingPlaceCSA-K9.exe.

===== To Download Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) =====

# Confirm that the computer you are using has up to 20 MB of hard-disk space for the download file and the installed files.
# On a computer with a high-speed Internet connection, go to the Cisco Unified MeetingPlace Crypto Software Download page at http://www.cisco.com/cgi-bin/tablebuild.pl/meetingplace-3d.
#: '''Note: ''' To access the software download page, you must be logged on to Cisco.com as a registered user.
# Because of export controls on strong encryption, the first time you download Cisco Security Agent for Cisco Unified MeetingPlace, you need to fill out a brief questionnaire. Follow the on-screen prompts.
# Click '''CiscoMeetingPlaceWebConfCSA607-K9.exe'''.
# Follow the on-screen prompts to complete the download.
# If you plan to install Cisco Security Agent for Cisco Unified MeetingPlace from a compact disc, burn the CD.

=== Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) ===

We recommend that you install Cisco Security Agent for Cisco Unified MeetingPlace after regular business hours because the installation process will affect Cisco Unified MeetingPlace performance. In addition, when the installation completes, you must restart the Cisco Unified MeetingPlace server for Cisco Security Agent for Cisco Unified MeetingPlace to start working.

'''Note''' Install Cisco Security Agent for Cisco Unified MeetingPlace ''after'' you have installed other software on the server.

'''Caution! ''' Do not install Cisco Security Agent for Cisco Unified MeetingPlace by using Windows Terminal Services, or the installation will fail. 

===== To Install Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) =====

# Log on to the server by using an account that is a member of the Administrators group or the Local Administrators group.
# Confirm that the server has at least 20 MB of hard-disk space available for the download file and the installed files.
# If another intrusion-detection application is installed on the server, uninstall the application before installing Cisco Security Agent for Cisco Unified MeetingPlace. Refer to the applicable documentation.
# If Windows Automatic Update is configured to automatically download updates from the Microsoft website, disable it.
# If antivirus software is installed on the server, disable and stop the scanning services:
## On the Windows Start menu, click '''Programs > Administrative Tools > Services'''.
## In the right pane, double-click the name of the first virus-scanning service.
## On the General tab, in the Startup Type list, click '''Disabled'''. This prevents the service from starting when you restart the server.
## Click '''Stop '''to stop the service immediately.
## Click '''OK''' to close the Properties dialog box.
## Repeat Step 2 through Step 5 for each of the remaining virus-scanning services.
## When the services have been disabled, close the Services MMC.
# If Cisco Unified MeetingPlace Web Conferencing is not installed on the server (for example, you are installing Cisco Security Agent for Cisco Unified MeetingPlace on a standalone H.323/SIP Gateway server), perform the following sub-steps to add a key to the registry to allow the installer to proceed:
## On the Windows Start menu, click '''Run'''. Enter '''regedit''' and click '''OK'''.
## Expand the key HKEY_LOCAL_MACHINE\Software\Latitude.
## On the Edit menu, click '''New''' > '''Key'''.
## Name the new key '''MeetingPlace WebPublisher'''.
## Click the new MeetingPlace WebPublisher key, then click '''Edit''' > '''New''' > '''Key'''.
## Name the new key '''General'''.
## Click the new General key, then click '''Edit''' > '''New''' > '''String Value'''.
## Name the new string value '''Version'''.
## Right-click '''Version''' and click '''Modify'''.
## For Value Data, enter '''6.0.0.0''' and click '''OK'''.
## Close the registry editor.
# In Windows Explorer, browse to the directory to which you downloaded the Cisco Security Agent for Cisco Unified MeetingPlace file, and double-click '''CiscoMeetingPlaceWebConfCSA607-K9.exe'''.
# Follow the on-screen prompts.
# When the installation completes, click '''Yes, I Want to Restart My Computer Now''', and click '''Finish'''.

Cisco Security Agent for Cisco Unified MeetingPlace begins to work as soon as you restart the server. You do not need to configure the application.
# If antivirus software is installed on the server, re-enable and start the virus-scanning services:
## On the Windows Start menu, click '''Programs > Administrative Tools > Services'''.
## In the right pane, double-click the name of the first scanning service.
## On the General tab, in the Startup Type list, click '''Automatic''' to re-enable the service.
## Click '''Start '''to start the service.
## Click '''OK''' to close the Properties dialog box.
## Repeat Step b through Step e for each of the remaining virus-scanning services.
## When the services have been disabled, close the Services MMC.

=== Installation and Upgrade Notes ===

==== Disabling and Re-enabling the Cisco Security Agent Service ====

The Cisco Security Agent service must be stopped and disabled before you install or upgrade any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed.

(For information on other situations in which you must disable the Cisco Security Agent service, see the [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Cisco Security Agent Service Must Be Disabled for Specific Tasks|Cisco Security Agent Service Must Be Disabled for Specific Tasks]].)

This section contains two procedures:
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#To Stop and Disable the Cisco Security Agent Service|To Stop and Disable the Cisco Security Agent Service]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#To Re-enable and Start the Cisco Security Agent Service|To Re-enable and Start the Cisco Security Agent Service]]

When you stop and disable the Cisco Security Agent service, you must re-enable and start it before it can monitor the server again.

===== To Stop and Disable the Cisco Security Agent Service =====

# On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
# In the right pane, double-click '''Cisco Security Agent'''.
# On the General tab, click '''Stop''' to stop the service immediately.
# In the Startup Type list, click '''Disabled'''. This prevents the service from starting when you restart the server.
# Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# When the service has been disabled, close the Services MMC.

===== To Re-enable and Start the Cisco Security Agent Service =====

# On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
# In the right pane, double-click '''Cisco Security Agent'''.
# On the General tab, in the Startup Type list, click '''Automatic''' to re-enable the service.
# Click '''Start''' to start the service.
# Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# When the service has been re-enabled, close the Services MMC.

=== Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace ===

===== To Uninstall Cisco Security Agent for Cisco Security Agent for Cisco Unified MeetingPlace =====

# Stop the Cisco Security Agent service:
## On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
## In the right pane, double-click '''Cisco Security Agent'''.
## On the General tab, click '''Stop''' to stop the service immediately.
## Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# On the Windows Start menu, click '''Programs''' > '''Cisco Systems''' > '''Uninstall Cisco Security Agent'''.
# Click '''Yes''' to confirm that you want to uninstall Cisco Security Agent for Cisco Unified MeetingPlace.
# Click '''Yes''' again to restart the server.

== Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace ==

The following sections contain information on using Cisco Security Agent for Cisco Unified MeetingPlace:
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Cisco Security Agent Service Must Be Disabled for Specific Tasks|Cisco Security Agent Service Must Be Disabled for Specific Tasks]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Locations in Which Cisco Security Agent Logs Events|Locations in Which Cisco Security Agent Logs Events]]

=== Cisco Security Agent Service Must Be Disabled for Specific Tasks ===

The Cisco Security Agent service must be disabled and stopped in the following situations:
* Before you install any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed.
* Before you upgrade any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed. This also applies to automatic upgrades (for example, installing service packs by using group policy objects or custom scripts). Cisco Security Agent for Cisco Unified MeetingPlace allows supported antivirus applications to automatically download and install upgrades to antivirus components.
* Before you add, change, or delete values in the Windows registry.
* Before you change Windows system or boot files.

When you disable and stop the Cisco Security Agent service, you must re-enable and start it before it can monitor the server again.

For instructions on disabling and re-enabling the service, see the [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Disabling and Re-enabling the Cisco Security Agent Service|Disabling and Re-enabling the Cisco Security Agent Service]].

=== Locations in Which Cisco Security Agent Logs Events ===

Cisco Security Agent logs events in the following three locations:

{| border = 1
|-
|
''' Windows application event log'''
|

Events that are generated by Cisco Security Agent have an event source of CSAgent.
|-
|
''' Securitylog.txt'''
|

Cisco Security Agent logs one event per line. The data in the file is in comma-separated-value format. In general, there should not be many entries in the file, so you should be able to read it in a text editor, for example, Notepad. (You might want to turn off word wrap.) If there are a lot of entries, you can view the data more easily if you copy the file to a computer on which a spreadsheet application is installed, change the file-name extension from .txt to .csv, and open the file in the spreadsheet application.

To view the log, double-click the Cisco Security Agent taskbar icon. In the tree control on the left of the Cisco Security Agent Panel, click '''Messages'''. Then click '''View Log'''. (The log appears in the Program Files\Cisco Systems\CSAgent\Log directory.)
|-
|
''' Current messages'''
|

To display events that have occurred since you logged on to Windows, double-click the Cisco Security Agent taskbar icon. In the Cisco Security Agent Panel, click '''Messages'''.
|}

Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace

2008-03-28T14:25:16Z

Jbeaudry: /* Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) */

[[Cisco Unified MeetingPlace, Release 6.x ]]

Cisco Security Agent for Cisco Unified MeetingPlace is a standalone Cisco Security Agent that is provided free of charge by Cisco Systems for use with Cisco Unified MeetingPlace installations that meet the requirements specified below. This information is for Cisco Security Agent for Cisco Unified MeetingPlace Release 6.0(7).

* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Introduction|Introduction]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Requirements and Supported Software|Requirements and Supported Software]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installation and Upgrade Information|Installation and Upgrade Information]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace|Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace]]
* [http://www.cisco.com/en/US/docs/voice_ip_comm/meetingplace/6x/security_agent/release/notes/601mpcsarn.html Release Notes]

== Introduction ==

Cisco Security Agent for Cisco Unified MeetingPlace is supported for use with certain Cisco Unified MeetingPlace components. (See the list at [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Requirements and Supported Software|Requirements and Supported Software]].)

The standalone Cisco Security Agent provides:
* Intrusion detection and prevention for Cisco Unified MeetingPlace software.
* Defense against previously unknown attacks because it does not require signatures, as antivirus software does.
* Reduced downtime, attack propagation, and cleanup costs.

The agent provides Microsoft Windows platform security (host intrusion detection and prevention) that is based on a tested set of security rules known as a policy. The policy allows or denies specific system actions before system resources are accessed, based on the following criteria:
* The resources being accessed.
* The operation being invoked.
* The process invoking the action.

This occurs transparently and does not greatly hinder overall system performance.

Version 6.0(7) of the standalone Cisco Security Agent for Cisco Unified MeetingPlace is compiled with [http://www.cisco.com/en/US/products/ps6786/index.html| Cisco Security Agent version 5.0.0], build 205.

'''Caution! ''' Do not view Cisco Security Agent for Cisco Unified MeetingPlace as providing complete security for Cisco Unified MeetingPlace installations. Instead, view it as an additional line of defense that, when used correctly with other standard defenses such as antivirus software and firewalls, provides enhanced security. Cisco Security Agent for Cisco Unified MeetingPlace provides enhanced defense for many different Cisco Unified MeetingPlace installations and configurations, and therefore cannot enforce network access control rules, which block outbound or inbound network traffic, or act as a host-based firewall.

The best starting point for references to security and voice products is http://www.cisco.com/go/ipcsecurity. We recommend the ''IP Telephony Security Operations Guide to Best Practices''.

== Requirements and Supported Software ==

* Microsoft Windows Server 2003 in English. Other language versions are not supported.
* One or more of the following supported software versions:

{| border = 1
|-
|

Cisco Unified MeetingPlace Directory Services
|

5.4(104)
|-
|

Cisco Unified MeetingPlace for Lotus Notes
|

6.0(15.0)
|-
|

Cisco Unified MeetingPlace for Office Communicator
|

6.0(11.0)
|-
|

Cisco Unified MeetingPlace for Outlook
|

6.0(14.0)
|-
|

Cisco Unified MeetingPlace H.323/SIP Gateway
|

5.3(1.8)
|-
|

Cisco Unified MeetingPlace SMTP E-Mail Gateway
|

5.4(108)
|-
|

Cisco Unified MeetingPlace Video Integration
|

5.4(107.0)
|-
|

Cisco Unified MeetingPlace Web Conferencing
|

6.0(171.0)
|}

== Installation and Upgrade Information ==
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)|Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)|Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installation and Upgrade Notes|Installation and Upgrade Notes]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace|Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace]]

=== Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) ===

'''Note: ''' If Cisco Unified MeetingPlace Web Conferencing Release 6.0(171.0) is installed on the server, the Web Conferencing installer places a copy of the Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) installation executable in the C:\Program Files\Cisco Systems\MPWeb directory. The file name is CiscoUnifiedMeetingPlaceCSA-K9.exe.

===== To Download Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) =====

# Confirm that the computer you are using has up to 20 MB of hard-disk space for the download file and the installed files.
# On a computer with a high-speed Internet connection, go to the Cisco Unified MeetingPlace Crypto Software Download page at http://www.cisco.com/cgi-bin/tablebuild.pl/meetingplace-3d.
#: '''Note: ''' To access the software download page, you must be logged on to Cisco.com as a registered user.
# Because of export controls on strong encryption, the first time you download Cisco Security Agent for Cisco Unified MeetingPlace, you need to fill out a brief questionnaire. Follow the on-screen prompts.
# Click '''CiscoMeetingPlaceWebConfCSA607-K9.exe'''.
# Follow the on-screen prompts to complete the download.
# If you plan to install Cisco Security Agent for Cisco Unified MeetingPlace from a compact disc, burn the CD.

=== Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) ===

We recommend that you install Cisco Security Agent for Cisco Unified MeetingPlace after regular business hours because the installation process will affect Cisco Unified MeetingPlace performance. In addition, when the installation completes, you must restart the Cisco Unified MeetingPlace server for Cisco Security Agent for Cisco Unified MeetingPlace to start working.

'''Note''' Install Cisco Security Agent for Cisco Unified MeetingPlace ''after'' you have installed other software on the server.

'''Caution! ''' Do not install Cisco Security Agent for Cisco Unified MeetingPlace by using Windows Terminal Services, or the installation will fail. 

===== To Install Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) =====

# Log on to the server by using an account that is a member of the Administrators group or the Local Administrators group.
# Confirm that the server has at least 20 MB of hard-disk space available for the download file and the installed files.
# If another intrusion-detection application is installed on the server, uninstall the application before installing Cisco Security Agent for Cisco Unified MeetingPlace. Refer to the applicable documentation.
# If Windows Automatic Update is configured to automatically download updates from the Microsoft website, disable it.
# If antivirus software is installed on the server, disable and stop the scanning services:
## On the Windows Start menu, click '''Programs > Administrative Tools > Services'''.
## In the right pane, double-click the name of the first virus-scanning service.
## On the General tab, in the Startup Type list, click '''Disabled'''. This prevents the service from starting when you restart the server.
## Click '''Stop '''to stop the service immediately.
## Click '''OK''' to close the Properties dialog box.
## Repeat Step b through Step e for each of the remaining virus-scanning services.
## When the services have been disabled, close the Services MMC.
# If Cisco Unified MeetingPlace Web Conferencing is not installed on the server (for example, you are installing Cisco Security Agent for Cisco Unified MeetingPlace on a standalone H.323/SIP Gateway server), perform the following sub-steps to add a key to the registry to allow the installer to proceed:
## On the Windows Start menu, click '''Run'''. Enter '''regedit''' and click '''OK'''.
## Expand the key HKEY_LOCAL_MACHINE\Software\Latitude.
## On the Edit menu, click '''New''' > '''Key'''.
## Name the new key '''MeetingPlace WebPublisher'''.
## Click the new MeetingPlace WebPublisher key, then click '''Edit''' > '''New''' > '''Key'''.
## Name the new key '''General'''.
## Click the new General key, then click '''Edit''' > '''New''' > '''String Value'''.
## Name the new string value '''Version'''.
## Right-click '''Version''' and click '''Modify'''.
## For Value Data, enter '''6.0.0.0''' and click '''OK'''.
## Close the registry editor.
# In Windows Explorer, browse to the directory to which you downloaded the Cisco Security Agent for Cisco Unified MeetingPlace file, and double-click '''CiscoMeetingPlaceWebConfCSA607-K9.exe'''.
# Follow the on-screen prompts.
# When the installation completes, click '''Yes, I Want to Restart My Computer Now''', and click '''Finish'''.

Cisco Security Agent for Cisco Unified MeetingPlace begins to work as soon as you restart the server. You do not need to configure the application.
# If antivirus software is installed on the server, re-enable and start the virus-scanning services:
## On the Windows Start menu, click '''Programs > Administrative Tools > Services'''.
## In the right pane, double-click the name of the first scanning service.
## On the General tab, in the Startup Type list, click '''Automatic''' to re-enable the service.
## Click '''Start '''to start the service.
## Click '''OK''' to close the Properties dialog box.
## Repeat Step b through Step e for each of the remaining virus-scanning services.
## When the services have been disabled, close the Services MMC.

=== Installation and Upgrade Notes ===

==== Disabling and Re-enabling the Cisco Security Agent Service ====

The Cisco Security Agent service must be stopped and disabled before you install or upgrade any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed.

(For information on other situations in which you must disable the Cisco Security Agent service, see the [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Cisco Security Agent Service Must Be Disabled for Specific Tasks|Cisco Security Agent Service Must Be Disabled for Specific Tasks]].)

This section contains two procedures:
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#To Stop and Disable the Cisco Security Agent Service|To Stop and Disable the Cisco Security Agent Service]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#To Re-enable and Start the Cisco Security Agent Service|To Re-enable and Start the Cisco Security Agent Service]]

When you stop and disable the Cisco Security Agent service, you must re-enable and start it before it can monitor the server again.

===== To Stop and Disable the Cisco Security Agent Service =====

# On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
# In the right pane, double-click '''Cisco Security Agent'''.
# On the General tab, click '''Stop''' to stop the service immediately.
# In the Startup Type list, click '''Disabled'''. This prevents the service from starting when you restart the server.
# Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# When the service has been disabled, close the Services MMC.

===== To Re-enable and Start the Cisco Security Agent Service =====

# On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
# In the right pane, double-click '''Cisco Security Agent'''.
# On the General tab, in the Startup Type list, click '''Automatic''' to re-enable the service.
# Click '''Start''' to start the service.
# Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# When the service has been re-enabled, close the Services MMC.

=== Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace ===

===== To Uninstall Cisco Security Agent for Cisco Security Agent for Cisco Unified MeetingPlace =====

# Stop the Cisco Security Agent service:
## On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
## In the right pane, double-click '''Cisco Security Agent'''.
## On the General tab, click '''Stop''' to stop the service immediately.
## Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# On the Windows Start menu, click '''Programs''' > '''Cisco Systems''' > '''Uninstall Cisco Security Agent'''.
# Click '''Yes''' to confirm that you want to uninstall Cisco Security Agent for Cisco Unified MeetingPlace.
# Click '''Yes''' again to restart the server.

== Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace ==

The following sections contain information on using Cisco Security Agent for Cisco Unified MeetingPlace:
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Cisco Security Agent Service Must Be Disabled for Specific Tasks|Cisco Security Agent Service Must Be Disabled for Specific Tasks]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Locations in Which Cisco Security Agent Logs Events|Locations in Which Cisco Security Agent Logs Events]]

=== Cisco Security Agent Service Must Be Disabled for Specific Tasks ===

The Cisco Security Agent service must be disabled and stopped in the following situations:
* Before you install any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed.
* Before you upgrade any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed. This also applies to automatic upgrades (for example, installing service packs by using group policy objects or custom scripts). Cisco Security Agent for Cisco Unified MeetingPlace allows supported antivirus applications to automatically download and install upgrades to antivirus components.
* Before you add, change, or delete values in the Windows registry.
* Before you change Windows system or boot files.

When you disable and stop the Cisco Security Agent service, you must re-enable and start it before it can monitor the server again.

For instructions on disabling and re-enabling the service, see the [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Disabling and Re-enabling the Cisco Security Agent Service|Disabling and Re-enabling the Cisco Security Agent Service]].

=== Locations in Which Cisco Security Agent Logs Events ===

Cisco Security Agent logs events in the following three locations:

{| border = 1
|-
|
''' Windows application event log'''
|

Events that are generated by Cisco Security Agent have an event source of CSAgent.
|-
|
''' Securitylog.txt'''
|

Cisco Security Agent logs one event per line. The data in the file is in comma-separated-value format. In general, there should not be many entries in the file, so you should be able to read it in a text editor, for example, Notepad. (You might want to turn off word wrap.) If there are a lot of entries, you can view the data more easily if you copy the file to a computer on which a spreadsheet application is installed, change the file-name extension from .txt to .csv, and open the file in the spreadsheet application.

To view the log, double-click the Cisco Security Agent taskbar icon. In the tree control on the left of the Cisco Security Agent Panel, click '''Messages'''. Then click '''View Log'''. (The log appears in the Program Files\Cisco Systems\CSAgent\Log directory.)
|-
|
''' Current messages'''
|

To display events that have occurred since you logged on to Windows, double-click the Cisco Security Agent taskbar icon. In the Cisco Security Agent Panel, click '''Messages'''.
|}

Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace

2008-03-28T14:20:44Z

Jbeaudry: /* Introduction */

[[Cisco Unified MeetingPlace, Release 6.x ]]

Cisco Security Agent for Cisco Unified MeetingPlace is a standalone Cisco Security Agent that is provided free of charge by Cisco Systems for use with Cisco Unified MeetingPlace installations that meet the requirements specified below. This information is for Cisco Security Agent for Cisco Unified MeetingPlace Release 6.0(7).

* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Introduction|Introduction]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Requirements and Supported Software|Requirements and Supported Software]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installation and Upgrade Information|Installation and Upgrade Information]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace|Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace]]
* [http://www.cisco.com/en/US/docs/voice_ip_comm/meetingplace/6x/security_agent/release/notes/601mpcsarn.html Release Notes]

== Introduction ==

Cisco Security Agent for Cisco Unified MeetingPlace is supported for use with certain Cisco Unified MeetingPlace components. (See the list at [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Requirements and Supported Software|Requirements and Supported Software]].)

The standalone Cisco Security Agent provides:
* Intrusion detection and prevention for Cisco Unified MeetingPlace software.
* Defense against previously unknown attacks because it does not require signatures, as antivirus software does.
* Reduced downtime, attack propagation, and cleanup costs.

The agent provides Microsoft Windows platform security (host intrusion detection and prevention) that is based on a tested set of security rules known as a policy. The policy allows or denies specific system actions before system resources are accessed, based on the following criteria:
* The resources being accessed.
* The operation being invoked.
* The process invoking the action.

This occurs transparently and does not greatly hinder overall system performance.

Version 6.0(7) of the standalone Cisco Security Agent for Cisco Unified MeetingPlace is compiled with [http://www.cisco.com/en/US/products/ps6786/index.html| Cisco Security Agent version 5.0.0], build 205.

'''Caution! ''' Do not view Cisco Security Agent for Cisco Unified MeetingPlace as providing complete security for Cisco Unified MeetingPlace installations. Instead, view it as an additional line of defense that, when used correctly with other standard defenses such as antivirus software and firewalls, provides enhanced security. Cisco Security Agent for Cisco Unified MeetingPlace provides enhanced defense for many different Cisco Unified MeetingPlace installations and configurations, and therefore cannot enforce network access control rules, which block outbound or inbound network traffic, or act as a host-based firewall.

The best starting point for references to security and voice products is http://www.cisco.com/go/ipcsecurity. We recommend the ''IP Telephony Security Operations Guide to Best Practices''.

== Requirements and Supported Software ==

* Microsoft Windows Server 2003 in English. Other language versions are not supported.
* One or more of the following supported software versions:

{| border = 1
|-
|

Cisco Unified MeetingPlace Directory Services
|

5.4(104)
|-
|

Cisco Unified MeetingPlace for Lotus Notes
|

6.0(15.0)
|-
|

Cisco Unified MeetingPlace for Office Communicator
|

6.0(11.0)
|-
|

Cisco Unified MeetingPlace for Outlook
|

6.0(14.0)
|-
|

Cisco Unified MeetingPlace H.323/SIP Gateway
|

5.3(1.8)
|-
|

Cisco Unified MeetingPlace SMTP E-Mail Gateway
|

5.4(108)
|-
|

Cisco Unified MeetingPlace Video Integration
|

5.4(107.0)
|-
|

Cisco Unified MeetingPlace Web Conferencing
|

6.0(171.0)
|}

== Installation and Upgrade Information ==
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)|Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)|Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7)]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Installation and Upgrade Notes|Installation and Upgrade Notes]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace|Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace]]

=== Downloading Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) ===

'''Note: ''' If Cisco Unified MeetingPlace Web Conferencing Release 6.0(171.0) is installed on the server, the Web Conferencing installer places a copy of the Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) installation executable in the C:\Program Files\Cisco Systems\MPWeb directory. The file name is CiscoUnifiedMeetingPlaceCSA-K9.exe.

===== To Download Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) =====

# Confirm that the computer you are using has up to 20 MB of hard-disk space for the download file and the installed files.
# On a computer with a high-speed Internet connection, go to the Cisco Unified MeetingPlace Crypto Software Download page at http://www.cisco.com/cgi-bin/tablebuild.pl/meetingplace-3d.
#: '''Note: ''' To access the software download page, you must be logged on to Cisco.com as a registered user.
# Because of export controls on strong encryption, the first time you download Cisco Security Agent for Cisco Unified MeetingPlace, you need to fill out a brief questionnaire. Follow the on-screen prompts.
# Click '''CiscoMeetingPlaceWebConfCSA607-K9.exe'''.
# Follow the on-screen prompts to complete the download.
# If you plan to install Cisco Security Agent for Cisco Unified MeetingPlace from a compact disc, burn the CD.

=== Installing Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) ===

We recommend that you install Cisco Security Agent for Cisco Unified MeetingPlace after regular business hours because the installation process will affect Cisco Unified MeetingPlace performance. In addition, when the installation completes, you must restart the Cisco Unified MeetingPlace server for Cisco Security Agent for Cisco Unified MeetingPlace to start working.

'''Note''' Install Cisco Security Agent for Cisco Unified MeetingPlace ''after'' you have installed other software on the server.

'''Caution! ''' Do not install Cisco Security Agent for Cisco Unified MeetingPlace by using Windows Terminal Services, or the installation will fail.

===== To Install Cisco Security Agent for Cisco Unified MeetingPlace 6.0(7) =====

# Log on to the server by using an account that is a member of the Administrators group or the Local Administrators group.
# Confirm that the server has at least 20 MB of hard-disk space available for the download file and the installed files.
# If another intrusion-detection application is installed on the server, uninstall the application before installing Cisco Security Agent for Cisco Unified MeetingPlace. Refer to the applicable documentation.
# If Windows Automatic Update is configured to automatically download updates from the Microsoft website, disable it.
# If antivirus software is installed on the server, disable and stop the scanning services:
## On the Windows Start menu, click '''Programs > Administrative Tools > Services'''.
## In the right pane, double-click the name of the first virus-scanning service.
## On the General tab, in the Startup Type list, click '''Disabled'''. This prevents the service from starting when you restart the server.
## Click '''Stop '''to stop the service immediately.
## Click '''OK''' to close the Properties dialog box.
## Repeat Step b through Step e for each of the remaining virus-scanning services.
## When the services have been disabled, close the Services MMC.
# If Cisco Unified MeetingPlace Web Conferencing is not installed on the server (for example, you are installing Cisco Security Agent for Cisco Unified MeetingPlace on a standalone H.323/SIP Gateway server), perform the following sub-steps to add a key to the registry to allow the installer to proceed:
## On the Windows Start menu, click '''Run'''. Enter '''regedit''' and click '''OK'''.
## Expand the key HKEY_LOCAL_MACHINE\Software\Latitude.
## On the Edit menu, click '''New''' > '''Key'''.
## Name the new key '''MeetingPlace WebPublisher'''.
## Click the new MeetingPlace WebPublisher key, then click '''Edit''' > '''New''' > '''Key'''.
## Name the new key '''General'''.
## Click the new General key, then click '''Edit''' > '''New''' > '''String Value'''.
## Name the new string value '''Version'''.
## Right-click '''Version''' and click '''Modify'''.
## For Value Data, enter '''6.0.0.0''' and click '''OK'''.
## Close the registry editor.
# In Windows Explorer, browse to the directory to which you downloaded the Cisco Security Agent for Cisco Unified MeetingPlace file, and double-click '''CiscoMeetingPlaceWebConfCSA607-K9.exe'''.
# Follow the on-screen prompts.
# When the installation completes, click '''Yes, I Want to Restart My Computer Now''', and click '''Finish'''.

Cisco Security Agent for Cisco Unified MeetingPlace begins to work as soon as you restart the server. You do not need to configure the application.
# If antivirus software is installed on the server, re-enable and start the virus-scanning services:
## On the Windows Start menu, click '''Programs > Administrative Tools > Services'''.
## In the right pane, double-click the name of the first scanning service.
## On the General tab, in the Startup Type list, click '''Automatic''' to re-enable the service.
## Click '''Start '''to start the service.
## Click '''OK''' to close the Properties dialog box.
## Repeat Step b through Step e for each of the remaining virus-scanning services.
## When the services have been disabled, close the Services MMC.

=== Installation and Upgrade Notes ===

==== Disabling and Re-enabling the Cisco Security Agent Service ====

The Cisco Security Agent service must be stopped and disabled before you install or upgrade any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed.

(For information on other situations in which you must disable the Cisco Security Agent service, see the [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Cisco Security Agent Service Must Be Disabled for Specific Tasks|Cisco Security Agent Service Must Be Disabled for Specific Tasks]].)

This section contains two procedures:
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#To Stop and Disable the Cisco Security Agent Service|To Stop and Disable the Cisco Security Agent Service]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#To Re-enable and Start the Cisco Security Agent Service|To Re-enable and Start the Cisco Security Agent Service]]

When you stop and disable the Cisco Security Agent service, you must re-enable and start it before it can monitor the server again.

===== To Stop and Disable the Cisco Security Agent Service =====

# On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
# In the right pane, double-click '''Cisco Security Agent'''.
# On the General tab, click '''Stop''' to stop the service immediately.
# In the Startup Type list, click '''Disabled'''. This prevents the service from starting when you restart the server.
# Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# When the service has been disabled, close the Services MMC.

===== To Re-enable and Start the Cisco Security Agent Service =====

# On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
# In the right pane, double-click '''Cisco Security Agent'''.
# On the General tab, in the Startup Type list, click '''Automatic''' to re-enable the service.
# Click '''Start''' to start the service.
# Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# When the service has been re-enabled, close the Services MMC.

=== Uninstalling Cisco Security Agent for Cisco Unified MeetingPlace ===

===== To Uninstall Cisco Security Agent for Cisco Security Agent for Cisco Unified MeetingPlace =====

# Stop the Cisco Security Agent service:
## On the Windows Start menu, click '''Programs''' > '''Administrative Tools''' > '''Services'''.
## In the right pane, double-click '''Cisco Security Agent'''.
## On the General tab, click '''Stop''' to stop the service immediately.
## Click '''OK''' to close the Cisco Security Agent Properties dialog box.
# On the Windows Start menu, click '''Programs''' > '''Cisco Systems''' > '''Uninstall Cisco Security Agent'''.
# Click '''Yes''' to confirm that you want to uninstall Cisco Security Agent for Cisco Unified MeetingPlace.
# Click '''Yes''' again to restart the server.

== Important Notes on Using Cisco Security Agent for Cisco Unified MeetingPlace ==

The following sections contain information on using Cisco Security Agent for Cisco Unified MeetingPlace:
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Cisco Security Agent Service Must Be Disabled for Specific Tasks|Cisco Security Agent Service Must Be Disabled for Specific Tasks]]
* [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Locations in Which Cisco Security Agent Logs Events|Locations in Which Cisco Security Agent Logs Events]]

=== Cisco Security Agent Service Must Be Disabled for Specific Tasks ===

The Cisco Security Agent service must be disabled and stopped in the following situations:
* Before you install any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed.
* Before you upgrade any software on a server on which Cisco Security Agent for Cisco Unified MeetingPlace is installed. This also applies to automatic upgrades (for example, installing service packs by using group policy objects or custom scripts). Cisco Security Agent for Cisco Unified MeetingPlace allows supported antivirus applications to automatically download and install upgrades to antivirus components.
* Before you add, change, or delete values in the Windows registry.
* Before you change Windows system or boot files.

When you disable and stop the Cisco Security Agent service, you must re-enable and start it before it can monitor the server again.

For instructions on disabling and re-enabling the service, see the [[Cisco Unified MeetingPlace, Release 6.x -- Cisco Security Agent for Cisco Unified MeetingPlace#Disabling and Re-enabling the Cisco Security Agent Service|Disabling and Re-enabling the Cisco Security Agent Service]].

=== Locations in Which Cisco Security Agent Logs Events ===

Cisco Security Agent logs events in the following three locations:

{| border = 1
|-
|
''' Windows application event log'''
|

Events that are generated by Cisco Security Agent have an event source of CSAgent.
|-
|
''' Securitylog.txt'''
|

Cisco Security Agent logs one event per line. The data in the file is in comma-separated-value format. In general, there should not be many entries in the file, so you should be able to read it in a text editor, for example, Notepad. (You might want to turn off word wrap.) If there are a lot of entries, you can view the data more easily if you copy the file to a computer on which a spreadsheet application is installed, change the file-name extension from .txt to .csv, and open the file in the spreadsheet application.

To view the log, double-click the Cisco Security Agent taskbar icon. In the tree control on the left of the Cisco Security Agent Panel, click '''Messages'''. Then click '''View Log'''. (The log appears in the Program Files\Cisco Systems\CSAgent\Log directory.)
|-
|
''' Current messages'''
|

To display events that have occurred since you logged on to Windows, double-click the Cisco Security Agent taskbar icon. In the Cisco Security Agent Panel, click '''Messages'''.
|}