.. _call-manager-groups:

Call Manager Groups
------------------------


.. model: relation/HcsCallManagerGroupREL


.. tip:: 

   :ref:`use-action-search-to-navigate-automate`


Overview 
..........

A Call Manager Group (Cisco UCM group), contains a list of up
to three UCM servers (users). These 
servers are prioritized. The server marked with the lowest number (zero) serves 
as the primary UCM user for that group, and the other members of the group serve
as secondary and tertiary (backup) UCMs.

Each device pool has one UCM group that is
assigned to it. When a device registers, it attempts to connect to the primary
UCM user in the group assigned to its device pool. If the primary UCM is 
unavailable, the device tries to connect to the next UCM listed in the group, 
and so on.

A single UCM user is usually assigned as primary for one UCM group, and as secondary / tertiary 
(if applicable) on other UCM groups. 

The table describes the value of UCM groups for your system:

.. tabularcolumns:: |p{4cm}|p{11cm}|

+------------------------------------+----------------------------------------------------------+
| Benefit                            | Description                                              |
+====================================+==========================================================+
| Redundancy                         | This feature enables you to designate a primary and      |
|                                    | backup UCM user servers for each group.                  |
+------------------------------------+----------------------------------------------------------+
| Call processing load balancing     | This feature enables you to distribute the control of    | 
|                                    | devices across multiple UCM users.                       |
+------------------------------------+----------------------------------------------------------+

For systems with a UCM that includes multiple servers (users), you are likely 
to achieve better load distribution and redundancy.



Manage Call Manager Groups 
...................................

This procedure adds a new UCM group, and edits and deletes an existing UCM group. 


**Prerequisites**:

* Configure all UCM servers (users) that you want to assign as members of the Call Manager group.

.. note:: 
   
   After configuring the Call Manager group, you can use it to configure 
   device pools. Devices obtain their UCM group list setting from 
   the device pool to which they are assigned.



**Perform these steps**:


1. Log in to the Admin Portal as a Provider, Reseller, or Customer administrator.                                           

   .. note::
                                                            
      For Shared Architecture deployment, ensure you sign in only as either Provider or Reseller admin 
      as only these admins can add UCMs.   
2. If you are adding a new instance, ensure the hierarchy path is set to the
   target node for the new instance.

3. Go to **Call Manager Groups**. 
4. Choose an option:                             

   * To add a new UCM group, click the Plus icon (+), then go to step 5.
   * To edit an existing UCM group, click on the relevant option in the list to open its settings, then go to step 5.

5. Configure the UCM group:  

   .. tabularcolumns:: |p{4cm}|p{11cm}|
                                                            
   +----------------------+-------------------------------------+
   | Field                | Description                         |
   +======================+=====================================+
   | Name (Mandatory)     | Fill out the UCM group name.        |
   +----------------------+-------------------------------------+
   | Auto-registration    | Select this checkbox if you want    |
   | Cisco Unified        | this UCM group to be the default    |
   | Communications       | UCM group when auto-registration is |
   | Manager Group        | enabled.                            |
   |                      |                                     |
   |                      | Leave unchecked (disabled) if you   |
   |                      | don't want devices to               |
   |                      | auto-register with this UCM group.  |
   |                      |                                     |
   |                      | Tip                                 |
   |                      |                                     |
   |                      | Each UCM cluster can have only one  |
   |                      | default auto-registration group.    |
   |                      | If you choose a different UCM       |
   |                      | group as the default                | 
   |                      | auto-registration                   |
   |                      | group, that is, you select the      |
   |                      | Auto-registration Cisco Unified     |
   |                      | Unified Communications Manager      |
   |                      | Group* checkbox for a different     |
   |                      | UCM group, the previously chosen    |
   |                      | auto-registration group no longer   |
   |                      | serves as the default for the       |
   |                      | cluster; the Auto-registration      |
   |                      | Cisco Unified Communications        |     
   |                      | Manager* checkbox displays for the  |
   |                      | previously chosen group (the        |
   |                      | original default), and the checkbox |
   |                      | gets disabled for the group that    |
   |                      | now serves as the default.          |
   +----------------------+-------------------------------------+
   | Unified CM Group     | Click the Plus icon (+) to add a    |
   | Items (Mandatory)    | UCM to the group. Repeat to add     |
   |                      | multiple UCM's to the group.        |
   |                      |                                     |
   |                      | You can delete UCMs added to        |
   |                      | to the Call Manager (UCM) group or  |
   |                      | re-order UCMs in the group.         |
   +----------------------+-------------------------------------+
   | Priority (Mandatory) | Enter the priority number for this  |
   |                      | UCM in the group. The smaller       |
   |                      | the integer, the higher the         |
   |                      | priority.                           |
   +----------------------+-------------------------------------+
   | Selected Cisco       | This field displays the UCMs in     |
   | Unified              | the Cisco UCM group.                |
   | Communications       |                                     |
   | Managers             |                                     |
   +----------------------+-------------------------------------+

6. Click **Save**.

   New UCM groups now appear in the list view of Call Manager Groups. You can delete Call Manager Groups from the 
   list if required. 

   .. note::

      To verify that the UCM is deployed in Shared Mode: 
      
      * Go to UCM **Servers**. 
      * On the **Publisher** tab, verify that the Multi-Tenant field is set to *Shared*.


.. rubric:: Related topics 

*
  .. raw:: latex

     Cisco UCM group selection in the Core Feature Guide.

  .. raw:: html

     <a href="../concepts-cucm-group-selection.html">Cisco UCM group selection</a>

*
  .. raw:: latex

     Set up Cisco UCM servers in the Core Feature Guide.

  .. raw:: html

     <a href="../cucm-cluster-and-servers.html">Set up Cisco UCM servers</a>
