The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Before you plan the initial system requirements and planned growth for the Cisco Hosted Collaboration Solution (HCS). To make sure you have seen the Collaboration Sizing Tool at tools.cisco.com/cucst
You should also review the following documents:
Use VMware's Distributed Resource Scheduler and high availability features to improve the resiliency of HCM-F nodes. For more information, see www.vmware.com.
Note | VMware's Distributed Resource Scheduler is not supported for UC applications. |
Service Inventory is a Cisco HCM-F service that queries Cisco Unified Communications Domain Manager 10.6(1) daily and reports detailed configurations of customers, subscribers, and devices for all Unified Communications Manager and Cisco Unity Connection application instances. The Service Inventory report also provides a summary of all customers, UC clusters, users, and end devices deployed within HCS.
Note | For deployments of both Cisco Unified Communications Domain Manager 8.x and Cisco Unified Communications Domain Manager 10.x, Service Inventory pulls customer information from both and generates a report file (or files) for all customers. |
Complete the following steps when planning service inventory:
HCS License Manager is an HCM-F service that provides centralized license management for HCS. HCS License Manager extends the functionality of Prime License Manager (formerly Enterprise Licence Manager) beyond the scope of one enterprise for use by service providers. HCS License Manager is used to assign each cluster to an Prime License Manager. HCS License Manager aggregates license usage by each cluster from each Prime License Manager into a License Summary report.
Consider the steps in the following procedure for HCS License Manager planning:
Prime License Manager manages licensing for Unified Communications Manager clusters, and Cisco Unity Connection servers for multiple customers deployed in HCS. Typically, multiple customers are assigned to the same Prime License Manager server. HCS License Manager allows a customer's clusters to be assigned to different Prime License Managers.
HCS licenses are registered to and loaded and activated onto the Prime License Managers deployed in HCS. The Prime License Managers deploy the HCS licenses to the UCM clusters and Unity Connection servers that are assigned.
Take the following actions for Prime License Manager planning:
Step 1 | Determine if you need multiple instances of Prime License Manager, which would be the case in either of the following scenarios: |
Step 2 | Install the Prime License Manager on the same management network as HCM-F so that Prime License Manager can access all Unified Communications application clusters. |
Step 3 | Install standalone Prime License Managers in the HCS Management domain. Set up each customer domain firewall to allow Prime License Manager to connect to UCM and Unity Connection through the HTTPS port 443 from the HCS management domain. |
Step 4 | Plan for
appropriate usage of the Prime License Manager web interface:
|
Platform Manager is a Cisco Hosted Collaboration Mediation Fulfillment service that allows you to schedule and monitor the automated installation, upgrade, restart and backup of multiple application instances across customers for the following applications:
Take the following actions for Platform Manager planning as you onboard each customer or cluster:
For details on Platform Manager, see the Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide, Release 10.6(1).
Tip | Cisco Prime Collaboration Deployment does not delete the source cluster VMs after migration is complete. You can fail over to the source VMs if there is a problem with the new VMs. When you are satisfied with the migration, you can manually delete the source VMs. |
Fresh install a new release 10.x UC cluster
Change IP addresses or hostnames in release 10.x clusters (for a network migration).
Cisco Prime Collaboration Deployment supports simple migration and network migration. Changing IP addresses or hostnames is not required for a simple migration. For more information, see the Cisco Prime Collaboration Deployment Administration Guide.
The following tables identify the functions supported by Cisco Prime Collaboration Deployment, Platform Manager, and Infrastructure Platform Automation. Each table identifies the UC applications and versions that the functions support. Support for UC applications and their versions is irrespective of Cisco HCS releases.
Product and Functions |
Cluster Discovery |
Migration to 10.x Cluster |
Upgrade Task (Upgrade Application Server or Install COP Files) |
Restart Task |
Switch Version Task |
Fresh Install a New 10.x Cluster |
Readdress Task (Change Hostname or IP Addresses for One or More Nodes in a Cluster) |
---|---|---|---|---|---|---|---|
Cisco Unified Communications Manager |
6.1(5), 7.1(3), 7.1(5), 8.0(1), 8.0(2), 8.0(3), 8.5(1), 8.6(1), 8.6(2), 9.0.(1), 9.1(1), 9.1(2), 10.0(1), 10.5(1), 10.5(2) |
6.1(5), 7.1(3), 7.1(5), 8.0(1), 8.0(2), 8.0(3), 8.5(1), 8.6(1), 8.6(2), 9.0.(1), 9.1(1), 9.1(2), 10.0(1), 10.5(1), 10.5(2) |
8.6(1), 8.6(2), 9.0.(1), 9.1(1), 9.1(2), 10.0(1), 10.5(1), 10.5(2) |
8.6(1), 8.6(2), 9.0.(1), 9.1(1), 9.1(2), 10.0(1), 10.5(1), 10.5(2) |
8.6(1), 8.6(2), 9.0.(1), 9.1(1), 9.1(2), 10.0(x), 10.5(1), 10.5(2) |
10.x, 10.5(1), 10.5(2) |
10.x |
Cisco Unified Presence |
8.5, 8.6 |
8.5(4), 8.6(3), 8.6(4), 8.6(5) |
8.6(3), 8.6(4), 8.6(5) |
8.6(3), 8.6(4), 8.6(5) |
8.6(3), 8.6(4), 8.6(5) |
— |
— |
IM and Presence Service |
— |
— |
— |
— |
— |
10.x, 10.5(1), 10.5(2) |
Not Supported |
Cisco Unified Contact Center Express |
8.5(1), 9.0, 9.0(2), 10.x |
Not Supported |
9.0(2), 10.x |
9.0(2), 10.x |
9.0(2), 10.x |
10.5(x) |
10.5(x) |
Cisco Unity Connection |
8.6(1), 8.6(2), 9.x, 10.x |
Not Supported |
From 8.6(x) to 8.6(x) From 8.6(x) to 9.x From 9.x to 9.x From 10.0(1) to 10.x |
8.6(1), 8.6(2), 9.x, 10.x |
8.6(1), 8.6(2), 9.x, 10.x |
10.5(x) |
10.5(x) |
Product and Functions |
Cluster Discovery |
Migration to 10.x Cluster |
Upgrade Task (Upgrade Application Server or Install COP Files) |
Restart Task |
Switch Version Task |
Fresh Install a New 10.x Cluster |
Readdress Task (Change Hostname or IP Addresses for One or More Nodes in a Cluster) |
---|---|---|---|---|---|---|---|
Cisco Unified Communications Manager |
8.6(2 ), 9.0.(1), 9.1(1), 9.1(2), 10.0(1 ) |
Not Supported |
8.6(2), 9.0.(1), 9.1(1), 9.1(2), 10.0(1) |
8.6(2), 9.0.(1), 9.1(1), 9.1(2), 10.0(1) |
8.6(2), 9.0.(1), 9.1(1), 9.1(2), 10.0(1) |
Not Supported |
Not Supported |
Cisco Unified Presence |
8.6 |
Not Supported |
8.6(3), 8.6(4), 8.6(5) |
8.6 |
8.6 |
Not Supported |
Not Supported |
IM and Presence Service |
9.0.(1), 9.1(1), 9.1(2), 10.0(1) |
Not Supported |
9.0.(1), 9.1(1), 9.1(2), 10.0(1) |
9.0.(1), 9.1(1), 9.1(2), 10.0(1) |
9.0.(1), 9.1(1), 9.1(2), 10.0(1) |
Not Supported |
Not Supported |
Cisco Unified Contact Center Express |
Not Supported |
Not Supported |
Not Supported |
Not Supported |
Not Supported |
Not Supported |
Not Supported |
Cisco Unity Connection |
8.6(2) , 9.x, 10.0(1) |
Not Supported |
From 8.6(x) to 8.6(x) From 8.6(x) to 9.x From 9.x to 9.x From 9.x to 10.x From 10.0(1) to 10.x |
8.6(2), 9.x, 10.0(1 ) |
8.6(2), 9.x, 10.0(1) |
Not Supported |
Not Supported |
UC Application |
VMware Cloning from Golden Template |
Readdress Task (Change Hostname or IP Addresses for One or More Nodes in a Cluster) |
---|---|---|
Cisco Unified Communications Manager |
9.0.(1), 9.1(1), 9.1(2), 10.0(1) |
9.0.(1), 9.1(1), 9.1(2), 10.0(1 ) |
Cisco Unified Presence |
Not Supported |
Not Supported |
IM and Presence Service |
10.0.(1) |
10.0.(1) |
Cisco Unified Contact Center Express |
Not Supported |
Not Supported |
Cisco Unity Connection |
9.x and 10.0.(1) |
9.x and 10.0(1) |
Cisco supports virtualized deployments of Cisco Prime Collaboration Deployment. The application is deployed using an OVA that contains the pre-installed application. This OVA is obtained with a licensed copy of Cisco Unified Communications Manager software. For information about how to extract and deploy the PCD_VAPP.OVA file, see the Cisco Prime Collaboration Administration Guide.
Use the Cluster Discovery feature to find application clusters on which to perform fresh installs, migration, and upgrade functions. Perform this discovery on a blade-by-blade basis.
Note | If you use Cisco Prime Collaboration Deployment to migrate Cisco Unified Communications Manager and Cisco Unified Communications Manager IM and Presence Service to the 10.5(x) (or later) version of those applications, remember to update the version in Cisco Unified Communications Domain Manager. Select the new version in the Version drop list for each application in the Cisco Unified Communications Domain Manager user interface. |
Cisco Prime Collaboration Administration Guide: http://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/products-maintenance-guides-list.html
Release Notes for Cisco Prime Collaboration Deployment: http://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/products-release-notes-list.html
Infrastructure Platform Automation (IPA) is an application designed to be an optional tool used to assist in the automation of the provisioning steps for on-boarding customers inside both the Cisco Unified Communications Manager application and the Cisco Unity Connection by using an XML configuration file that is loaded in Infrastructure Manager within the Cisco HCM-F interface. The automation process includes Virtual Machine cloning from golden templates and running change identity on the Cisco Unified Communications Manager or Cisco Unity Connection Publisher and Subscriber Virtual Machines. If the Virtual Machines are pre-cloned, for example by Cloud-O or manually, IPA performs only identity operations on Virtual Machines.
IPA supports deployment of IM and Presence nodes in a Cisco Unified Communications Manager cluster.
Golden templates are master copies of Cisco Unified Communications Manager and Cisco Unity Connection that you can reuse or install on multiple virtual machines. They are built on a source system controlled by a service provider. Golden templates are built one for publisher and one for subscriber. After golden templates are built, IPA automates the process of cloning, identity, and post-installation operations of the virtual machine.
Note | IPA requires the Cisco Nexus 1000V Switch for VMware vSphere and vSphere Enterprise Plus to function. This impacts Micro Node deployments which only require a vNetwork Standard Switch (vSwitch) and vSphere Standard. For more information on vNetwork Distributed Switch concepts see Overview of vNetwork Distributed Switch concepts (1010555) at the VMware Knowledge Base. |
Take the following actions for IPA planning:
Step 1 | Create golden templates one time for the Cisco Unified Communications Manager Publisher, Cisco Unified Communications Manager Subscriber, and Cisco Unity Connection nodes for IPA use. For details on creating golden templates, see the Cisco Hosted Collaboration Mediation Fulfillment Install and Configure Guide, Release 10.6(1). | ||||
Step 2 | Carefully
gather the detailed configuration defined by the XML configuration file. The
XML configuration file requires details for the customer organization, Cisco
Unified Communications Manager and Cisco Unity Connection applications, and
Virtual Machines.
|
Note | Notice of deprecation: API Gateway Planning is going to be removed in a future release. |
Take the following actions for API Gateway Proxy planning:
Step 1 | Determine if you will use the automated provisioning system that communicates through the API Gateway Proxy or manual provisioning with the GUI interface. | ||
Step 2 | Deploy the API
Gateway Proxy only if one of the following scenarios exists:
If neither of these scenarios apply, you do not need to deploy the API Gateway Proxy. | ||
Step 3 | For high availability, implement at least two instances of the API Gateway Proxy web services node, including the following: use a load balancer to provide a single virtual IP address and balance the traffic flowing to the API Gateway Proxy nodes. The load balancer must be sourced by the service provider. | ||
Step 4 | Use a DNS to
support API Gateway Proxy deployment to avoid a 10-second delay each time a new
session is established between the gateway and other HCS components.
|
The API Gateway provides a single point of integration for the Cisco HCS Management Fulfillment APIs. The API Gateway provides access to Service Fulfillment APIs of HCS management components Cisco Unified Communications Domain Manager 10.6(1) and CCDM.
Take the following actions for API Gateway planning:
Step 1 | Determine if you will use the automated provisioning system that communicates through the API Gateway, or manual provisioning with the GUI interface. |
Step 2 | Determine if you will use a load balancer to provide a single virtual IP address and balance the traffic flowing to the API Gateway nodes. The load balancer must be sourced by the service provider. |
Cisco Unified Communications Domain Manager is an integral part of the service fulfillment subsystem. It is primarily responsible for the configuration and registration of users, subscribers, and endpoints with the back-end Cisco Unified Communications Manager, Cisco Unity Connection, and Cisco Unified Communications IM and Presence Service servers. Cisco Unified Communications Domain Manager provides the day-to-day service and device provisioning and management tools. One instance supports all deployment sizes up to 200,000 subscribers.
Consider the steps in the following procedure for Cisco Unified Communications Domain Manager planning:
Step 1 | Determine if WebEx and Contact Center is integrated. | ||
Step 2 | Set up Cisco Unified Communications Domain Manager redundancy at the initial install; it cannot be introduced later. Cisco Unified Communications Domain Manager is deployed as one Unified Communications Domain Manager Master or Active instance and one Disaster Recovery (DR) instance hosted across two data centers, and management must be able to route to both. There is an added layer of High Availability that is provided by VMware HA for both the active and standby Cisco Unified Communications Domain Manager node. Redundancy is provided by the active sync of data between the active Cisco Unified Communications Domain Manager node and the standby Cisco Unified Communications Domain Manager node. | ||
Step 3 | Determine which dial plan to use. See the "Customer-specific dial plan" section in this document. | ||
Step 4 | For user activations, decide if you use automated system activations based on system inventory or the Cisco Unified Communications Domain Manager administrator interface. | ||
Step 5 | Decide if you want to use the Cisco Unified Communications Domain Manager user self-care portal. If yes, you need to allow access for customers or end users. | ||
Step 6 | Check to see
what the static deployment requirements are on Cisco Unified Communications
Manager clusters before managing a cluster from Cisco Unified Communications
Domain Manager. Gather the following information:
| ||
Step 7 | Determine if extra languages are required for the system other than English. | ||
Step 8 | Determine if custom branding is desired. | ||
Step 9 | For a Shared
Instance deployment:
|
Cisco Unified Communications Domain Manager 10.6(1) is an integral part of the service fulfillment subsystem. It is primarily responsible for the configuration and registration of users, subscribers, and endpoints with the back-end Cisco Unified Communications Manager, Cisco Unity Connection, and IM and Presence Service servers. Cisco Unified Communications Domain Manager 10.6(1) provides the day-to-day service and device provisioning and management tools. One instance supports all deployment sizes up to 200,000 subscribers.
Consider the steps in the following procedure for Cisco Unified Communications Domain Manager 10.6(1) planning:
Step 1 | Determine if WebEx and Contact Center will be integrated. | ||
Step 2 | Cisco Unified Communications Domain
Manager 10.6(1) is deployed either as a single node, or a cluster of
multiple nodes with High Availability (HA) and/or Disaster Recovery (DR)
qualities. Each node can be assigned one or more of the following functional
roles:
The following combined roles are defined: | ||
Step 3 | Determine which dial plan to use. See the "Customer specific dial plan" section in this document | ||
Step 4 | For user activations, decide if you will use automated system activations based on system inventory or the Cisco Unified Communications Domain Manager 10.6(1) admin interface. | ||
Step 5 | Decide if you want to use the Cisco Unified Communications Domain Manager 10.6(1) user self-care portal. If yes, you need to allow access for customers or end users. | ||
Step 6 | Check to see
what the static deployment requirements are on Cisco Unified Communications
Manager clusters before managing a cluster from
Cisco Unified
Communications Domain Manager 10.6(1). Gather the following
information:
| ||
Step 7 | Determine if additional languages are required for the system other than English. | ||
Step 8 | Determine if custom branding is desired. | ||
Step 9 | For a Shared
Instance deployment:
|
The following table lists the resource requirements for the listed SF components.
HCS | ||||
---|---|---|---|---|
Fulfillment component | vCPU | RAM (GB) | Storage (GB) | IOPS |
CUCDM | 7 | 32 | 325 (includes a 100 GB dedicated backup partition) | 300 during provisioning and 650 during database backup |
HCM-F | 4 | 16 (Res). Web service node (if used) uses 8 MB of RAM | 80 | 200 |
Prime License Manager | 1 | 4 | 50 | - |
CCDM | 8 | 32 | 100 | 775 (DB server)
565 (web server) |
Note | For current updates to the above requirements see the Cisco Hosted Collaboration Solution Compatibility Matrix. |
The following table lists the resource requirements for the listed SF components.
HCS 10.6(1) | |||||
---|---|---|---|---|---|
Fulfillment component | vCPU | RAM (GB) | Storage | IOPS | OS |
CUCDM 10.1.1 Multi-node | 4vCPU @ 2GHz | 8GB | 370GB partitioned as
follows:
• 20GB for OS • 40GB for application • 10GB for logs • 50GB for compressed backups • 250GB for database |
300 | |
WebProxy Nodes | 2vCPU @ 2GHz | 4GB |
150GB |
||
HCM-F | 4 x 1.8 GHz | 16 (Res) | 80 | 200 | |
PLM | 1 vCPU x 1.8 GHz | 4 | 50 | - | |
CCDM | 8 | 32 | 100 | 775 (DB server)
565 (web server) |
Microsoft Windows |
The Database storage partition is sized at the initial installation to support the maximum deployment size for the release. Further increase in the size of the partition is not required as new customers are on-boarded.
To set up the disk requirements, the disk should be set up on the VMWare GUI Resources tab where a disk can be created. This task should be done after the OVA import but prior to the boot of the system.
See the Service Fulfillment compatibility table in Cisco Hosted Collaboration Solution Compatibility Matrix.
Service Providers (SPs) can use Usage-based billing, using call detail records (CDRs) or Call Manager Management Records (CMRs) for the enterprise.
If a service provider is interested in usage type billing, they can direct CDRs from Unified Communications Manager to their billing system. If Cisco Prime Collaboration Assurance is configured as a management application, the Cisco HCS Provisioning Adapter (CHPA) service configures any CUCM (release 9.0(1) or higher) to send CDRs to Cisco Prime Collaboration Assurance. The option also exists to work with our third-party vendor to consume CDRs and CMRs to produce necessary billing information or invoices.
The Cisco TelePresence Exchange System collects and displays call detail records (CDRs) for calls that are placed on the system. From the administration console, you can view CDR details for the system and export a comma-separated value (.csv) file of that information.
The Cisco TelePresence Exchange System retains CDRs for up to 30 days from the recorded end time of the CDR. The system automatically purges CDRs that exceed this 30-day limit. If the total number of CDRs retained by the system reaches 100,000, the system retains only the most recent 100,000 records and automatically purges the rest.
The Cisco TelePresence Exchange System also provides an Application Programming Interface (API) for managing and retrieving call records. For more details, see the API User Guide for the Cisco TelePresence Exchange System.