Get Started


Contact your Cisco partner to submit a Cisco Webex Cloud-Connected UC (CCUC) order for you or complete an order through Cisco Commerce Workspace (CCW).

For information on how to order CCUC, refer to the Cisco Collaboration Flex Plan Ordering Guide at:

https://www.cisco.com/c/en/us/products/collateral/customer-collaboration/guide-c07-740917.html

The first time that you set up CCUC, a wizard guides you on how to set up an agent file and cluster group. When you create more agent files and cluster groups after the first time, this wizard doesn’t appear.

Create First Agent File and Cluster Group

Before you begin

Ensure that your network firewalls and proxies allow access to the following URLs:

  • *.ucmgmt.cisco.com

  • *.webex.com


Use the global URL and one of the regional URLs based on the country code of your Webex organization when you try to connect a cluster to the data center. The regional URL is based on your country code and not the cluster’s location. Based on where your Webex organization is located, ensure that the nodes are able to connect to the global and regional URLs on port 443.

Collect the proxy information required to connect the nodes to the internet. For information on how to add an authenticated proxy or to add a proxy after the agent has been installed, see Add a Proxy.

1

From the customer view in Cisco Webex Control Hub, go to Services > Connected UC. On the UC Management card, click Get Started.


 

The Get Started button remains enabled until you create an agent file and a cluster group.

2

Click Next.

3

Name the agent file and provide a description.

The maximum length for a filename is 200 characters and the description is 1000 characters.

4

Enter the proxy information that can be used to connect the nodes to internet, and then click Save to create the agent file.


 
  • The proxies added to an agent installer file determine the data center where you can use the file. If you have multiple data centers, we recommend that you create a single agent file having the proxy information about all of them.

  • The agent file can take up to a minute to generate.

  • To use proxy that supports authentication, use the Admin CLI in the Unified CM or IM&P server to configure it. You can’t use the Control Hub UI to configure the proxy during Agent Install file creation. This task requires credentials for proxy authentication. The supported proxy authentication schemes are Basic and Digest.

5

Click Download.

You created and downloaded your first agent file. After the first agent file is created, Add Agent Install File appears on the screen. Use this button to create multiple agent install files.

Continue with the setup wizard to create your first cluster group. Cluster groups are just like folders. They're a logical construct that allows you to group your clusters to manage them together. Enter a name for the cluster group that makes sense for your deployment. For example, you can name cluster groups based on geographic regions or release environments.

6

Click Next.

7

Enter a name for the cluster group and a description, then click Save.

You can create multiple cluster groups. After you're done creating the cluster groups you require, proceed to the next step.

8

Click Next, and then Finish to close the wizard.

Now you have an agent file and a cluster group. Install the agent file on the nodes that you want to monitor. Then, return to Control Hub to verify the nodes in a cluster and assign them to a cluster group.

Each agent installer file can have zero to any number of HTTP proxies defined in it. If you must add more HTTP proxies after you create an agent installer file, create a new agent installer file with the requisite proxies. When you install the agent installer file on a node, the node cycles through all the proxies defined in the file until it can reach the cloud service. Hence, the proxies added to an agent installer cop file determine the data center where you can use the file.

You can also create multiple cluster groups to organize your clusters.

Onboarding a Node having Unified CM 12.5 SU3 or Lower Version


Set Up Agent File

Before you begin

Ensure that your network firewalls and proxies allow access to the following URLs:

  • *.ucmgmt.cisco.com

  • *.webex.com


Use the global URL and one of the regional URLs based on the country code of your Webex organization when you try to connect a cluster to the data center. The regional URL is based on your country code and not the cluster’s location. Based on where your Webex organization is located, ensure that the nodes are able to connect to the global and regional URLs on port 443.

Collect the proxy information required to connect the nodes to the internet. For information on how to add an authenticated proxy or to add a proxy after the agent has been installed, see Add a Proxy.

1

From the customer view in Cisco Webex Control Hub, go to Services > Connected UC. On the UC Management card, click Agent Install Files.

2

Click Add File to create an agent installer file containing zero or more proxies.

3

Name the agent file and provide a description.

The maximum length for a filename is 200 characters and the description is 1000 characters.

4

Enter the proxy information, and then click Save to create the agent file.


 
  • The proxies added to an agent installer file determine the data center where you can use the file. If you have multiple data centers, we recommend that you create a single agent file having the proxy information about all of them.

  • The agent file can take up to a minute to generate.

  • To use proxy that supports authentication, use the Admin CLI in the Unified CM or IM&P server to configure it. You can’t use the Control Hub UI to configure the proxy during Agent Install file creation. This task requires credentials for proxy authentication. The supported proxy authentication schemes are Basic and Digest.

5

Click Download.

6

In the short-cut menu, choose one of the options:

  • Version 14
  • Version 11.5.x and 12.x

Based on your selection, the Agent COP file corresponding to the Unified CM version installed on the node is downloaded.

Onboarding a Node Having Unified CM 12.5 SU4 Version Installed

The Agent COP file is bundled along with your Unified CM software.

1

On the Admin CLI prompt, type utils ucmgmt organization organization_id.

2

To find out your Organization ID, from the customer view in Cisco Webex Control Hub, go to Management > Account. In the Company Information section, you can see the Organization ID.

For example, organization_id could be 43e67ab7-8f31-4566-abfc-16b3de8362ac.

3

Type utils ucmgmt agent enable.

After a few minutes, the node is onboarded.

4

Repeat the above steps on all the nodes in the cluster.

Once the nodes in a cluster are onboarded, see Verify and Assign Clusters for information on how to verify a cluster.

Onboarding a Node Having Unified CM 14.0 Version Installed

The Agent COP file is bundled along with your Unified CM software.

1

On the Admin CLI prompt, type utils ucmgmt organization organization_id.

2

To find out your Organization ID, from the customer view in Cisco Webex Control Hub, go to Management > Account. In the Company Information section, you can see the Organization ID.

For example, organization_id could be 43e67ab7-8f31-4566-abfc-16b3de8362ac.

3

Type utils ucmgmt agent enable.

After a few minutes, the node is onboarded.

4

Repeat the above steps on all the nodes in the cluster.

Once the nodes in a cluster are onboarded, see Verify and Assign Clusters for information on how to verify a cluster.

Add Cluster Groups

Add cluster groups to the Control Hub to enable you to assign clusters to them. A cluster group is a place to logically group clusters so that they can be managed together. For example, you can create cluster groups based on geographic regions or release environments. You can rename cluster groups, move clusters from one cluster group to another, and so on.


If you face any issues while performing the below procedure, see Troubleshoot Cisco Webex Cloud-Connected UC.

1

From the customer view in Cisco Webex Control Hub, go to Services > Connected UC. On the UC Management card, click Inventory.

The UC Management page appears showing the list of cluster groups.

2

Click Add Cluster Group.

3

Enter a name and description, then click Save.

The following table lists the different statuses of a cluster group with a brief description about each. For details on how to fix an issue that is related to a cluster group status, see Troubleshoot CiscoWebex Cloud-Connected UC.

Cluster Group Status

Brief Description

Needs Verification

Cluster must be verified by the customer administrator.

No Clusters

No clusters are present in the cluster group.

Misconfigured

One or more nodes in the cluster group are configured incorrectly.

No Agent running

No agents are running on any of the nodes.

No Publisher

  • Ensure that the platform API web service is enabled and running on the machine. For more information, refer to the Platform Administrative Web Service section in Cisco Unified Serviceability Administration Guide.

  • Node is down or proxies are offline.

Offline

One or more nodes in the cluster group have their agent offline. The agent process might have stopped and requires consideration.

The following table lists the different statuses of a node with a brief description about each. For details on how to fix an issue that is related to a node status, see Troubleshoot CiscoWebex Cloud-Connected UC.

Node Status

Brief Description

Needs Assignment

The node must be assigned to a cluster.

Needs Verification

Node must be verified by the customer administrator.

Unsupported

Node is onboarded but is not supported by CCUC. For example, Unity, CER, and so on.

Offline

The node is not reachable.

Online

The node is onboarded and the agent is verified.

Misconfigured

Node is configured incorrectly.

No Agent running

If no agents are running on the node, the agent process might have stopped.

No Publisher

One or more clusters in the clusters under that cluster have no Publisher. This is a rare scenario.

The following table lists the different statuses of a node in the analytics inventory with a brief description about each.

Analytics Status

Brief Description

Starting

The telemetry service has been started by the administrator.

Stopping

The telemetry service has been stopped by the administrator.

Stopped by user

The telemetry service has been stopped by the user.

Waiting for installation

Installation in progress.

Online

The module is online and running with the latest cop file.

Offline

The module is offline.

After installing the agent on a node, a verification code shows up at the end of the install log file. For more information about how to install an agent cop file, refer to the respective documentation, depending on whether you have a Unified CM node, IM and P node, or a CUC node, listed below.

For a Unified CM or IM and P node, refer to Installation Guide for Cisco Unified Communications Manager and the IM and Presence Service based on your Unified CM release at:

https://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/products-installation-guides-list.html


For a Unified CM node, the verification code is also present on the sign-in pages for the GUI and CLI. This code is similar to a serial number and makes it easy for you to identify each node uniquely. When you accept a node into the inventory, ensure that the verification code on the node matches what is displayed in Control Hub. Thus, you're certain that you’re working with the correct node.

Verify and Assign Clusters

If you face any issues while performing the below procedure, see Troubleshoot Cisco Webex Cloud-Connected UC.

1

From the customer view in Cisco Webex Control Hub, go to Services > Connected UC. On the UC Management card, click Inventory.

The UC Management page appears showing the list of cluster groups.

2

If any of the cluster groups shows the Needs Verification status, click Resolve next to the cluster group.

3

Click Verify next to a cluster.

4

From the Cluster Group drop-down list, choose the cluster group to which you want to assign a cluster.

After you assign a cluster to the cluster group, all the nodes belonging to that cluster get assigned to the selected cluster group.

5

Click check next to the node that you want to assign to the cluster group, or X to remove the node.

6

Click Save.


 

After the cloud agent COP file installation, it would take up to one and half hours for the UC Analytics service to be up and running.

You can redownload and delete agent files and change the name and descriptions of cluster groups.

Edit Names or Descriptions of Cluster Groups

1

From the customer view in Cisco Webex Control Hub, go to Services > Connected UC. On the UC Management card, click Inventory.

The UC Management page appears showing the list of cluster groups.

2

Click Details next to the cluster group that you want to edit.

3

Click on the text field that you want to edit.

Delete a Cluster Group from Control Hub

You can remove a cluster group that you no longer require to efficiently manage the infrastructure that is connected to the cloud.

1

From the customer view in Cisco Webex Control Hub, go to Services > Connected UC. On the UC Management card, click Inventory.

The UC Management page appears showing the list of cluster groups.

2

Click Details next to the cluster group that you want to delete.

The Inventory page displays all the clusters that are assigned to the selected cluster group. If the cluster group has any clusters that are assigned to it, you must either move those clusters to a different cluster group or delete those clusters before you delete the cluster group. For more information on how to delete a cluster, see Delete a Cluster from Control Hub.

3

(Optional) To move a cluster, select it and click Move.

The Assign and Move window appears.

4

(Optional) From the cluster group selection drop-down list, choose a cluster group and click Move.


 
  • The cluster group that you want to delete is not listed in the drop-down list.

  • You can create a new cluster group using Add Cluster Group option in the drop-down list.

5

(Optional) To create a new cluster group, choose Add Cluster Group option in the drop-down list and then Save.

6

To delete the empty cluster group, click Delete Cluster Group on the Inventory page.

The deleted cluster group no longer appears on the Control Hub.

Delete a Cluster from Control Hub

You can remove a cluster that you no longer require to efficiently manage the infrastructure that is connected to the cloud.

1

From the customer view in Cisco Webex Control Hub, go to Services > Connected UC. On the UC Management card, click Inventory.

The UC Management page appears showing the list of cluster groups.

2

Click Details next to the cluster group to which the cluster you want to delete belongs.

3

On the cluster group details page, choose Delete Cluster from the drop-down list at the top right of the page.

4

Click Yes to delete or click No to cancel.

After cluster deletion, the agent and telemetry module are uninstalled from all the nodes that are associated with the deleted cluster. The deleted cluster no longer appears on the Control Hub.

Download or Delete Agent Files

After you create an agent installer file, you can’t edit it. If any file produces an error during its installation or you want to add more proxy information to a file, you can create a new agent install file and choose to delete the old file that is no longer needed.

1

From the customer view in Cisco Webex Control Hub, go to Services. In the UC Management card, and click Agent Install Files.

2

Click on an agent file, and then select Download or Delete.

Cisco Webex Cloud-Connected UC (CCUC) enables you to view the issues that occur on your on-premises infrastructure. These issues cause loss of telemetry data and incorrect data to be displayed on the Analytics charts. Based on the severity of the issue, either an error or warning notification is sent to the Control Hub. The notifications enable you to take necessary actions to rectify any on-premises issue and make informed decisions.

View on Cluster Groups Details Page

You can view the error or warning messages regarding your on-premises infrastructure on the cluster groups details page.

1

From the customer view in Cisco Webex Control Hub, go to Services > Connected UC. On the UC Management card click Inventory.

The UC Management page appears showing the list of cluster groups. You can also see an Error or Warning label in the Status column of cluster groups that have an issue.

2

Click Details next to the cluster group for which you want to view the notification.

3

Click Details next to the cluster for which you want to view the notification.

If there are any error or warning notifications or both, you can view them on the side panel.

4

To view the detailed information regarding an error or warning notification, next to the notification text click >.

A side panel appears that provides the details, such as severity, first and last reported times, applicability (to node or cluster level), description about the notification, and the corrective action that you need to take.

View on Nodes List Details Page

You can also view the error or warning messages regarding your on-premises infrastructure on the nodes list details page.

1

From the customer view in Cisco Webex Control Hub, go to Services > Connected UC. On the UC Management card click Inventory.

The UC Management page appears showing the list of cluster groups.

2

Click the Show Nodes List icon to view the list of all nodes.

You can also see an Error or Warning label in the Status column of nodes that have an issue.

3

Click the node for which you want to view the notifications.

If there are any error or warning notifications or both, you can view them on the side panel.

4

To view the detailed information regarding an error or warning notification, next to the notification text click >.

A side panel appears that provides the details, such as severity, first and last reported times, applicability (to node or cluster level), description about the notification, and the corrective action that you need to take.

View Events History

You can view the history of all Warning and Error events that were raised and resolved during a selected time period. The historical data for the past one year is maintained.

1

From the customer view in Cisco Webex Control Hub, go to Services > Connected UC. On the UC Management card click Inventory.

The UC Management page appears showing the list of cluster groups. You can also see an Error or Warning label in the Status column of cluster groups that have an issue.

2

Click Details next to the cluster group for which you want to view the event history.

The list of clusters belonging to the selected cluster group appears.

3

Click Details next to the cluster for which you want to view the event history.

The list of nodes belonging to the selected cluster appears.

4

Click Details next to the node for which you want to view the event history.

5

Click Events History.

The Events History page appears that provides details, such as event name, type, severity, cluster name, node name, and time.

6

To filter the data, choose one or a combination of the following options from the Time Duration drop-down list:

  • Cluster—To view event history for a particular cluster.

  • Node—To view event history for a particular node.

  • Service—To view event history for a particular Cisco Webex Cloud-Connected UC (CCUC) service.

  • Time Duration—To view event history for a particular time period. The supported time ranges are:

    • 24 hours—This is the default value.

    • 48 hours

    • Last 7 days

    • Last 30 days

You can set a specific upgrade schedule or use the default schedule of 3 a.m. Daily United States: America/Los Angeles.

Software upgrades for Cloud-Connected UC modules are done automatically at the cluster level, which ensures that all nodes are always running the same software version. Upgrades are done according to the upgrade schedule for the cluster.

Before you begin


  • An urgent upgrade is a critical fix that impacts multiple customers. It is applied using the default time set for the cluster in the next available schedule. Consider an example where you set the upgrade schedule for a cluster to 11 a.m. every Tuesday. If an urgent upgrade becomes available before 11 a.m. on a particular day, the Cloud-Connected UC module is upgraded at 11 a.m. the same day. However, if the urgent upgrade becomes available post 11 a.m., then the Cloud-Connected UC module is upgraded at 11 a.m. on the following day.

1

From the customer view in Cisco Webex Control Hub, go to Services > Connected UC. On the UC Management card, click Inventory.

The UC Management page appears with the list of cluster groups.

2

Click Details next to the cluster group that contains the cluster for which you want to set the upgrade schedule.

3

Click Details next to the cluster for which you want to set the upgrade schedule.

4

Click the ellipsis (…) icon beside Event History and select Choose CCUC Module Upgrade Schedule.

The CCUC Module Upgrade Schedule page appears. The below screenshot is just an example for illustrative purposes.

5

Choose the time, frequency, and time zone for the upgrade schedule from the respective drop-down lists.

Below the Time Zone field, the next available upgrade date and time are displayed.

6

(Optional) If you want to apply the same upgrade schedule settings for all the clusters in the selected cluster group, check the Copy all changes to all clusters in this cluster group check box.

7

(Optional) If you want to apply the same upgrade schedule settings for all the clusters that have been onboarded, check the Copy all changes to all onboarded clusters across my deployment check box.

8

Click Save to save the changes or Cancel to discard them.

You can start or stop the telemetry module based on your requirement. Once you disable this service, no cloud operations occur on the node, including upgrade.


Once you disable the service, no cloud operation (including upgrade) can take place on the node.

1

From the customer view in Cisco Webex Control Hub, go to Services. On the Analytics card, click Inventory.

2

Click any of the node entries in the list.

A pane appears on the right. You can view more details about the node and the agent.

3

Click Disable Analytics Service to disable the telemetry service.

4

Click Enable Analytics Service to enable the telemetry service..

What to do next

For information about CCUC Analytics, see Analytics for Your Cisco Webex Cloud-Connected UC.