.. _set-up-cisco-unity-connection:

CUC servers
-----------------

.. _19.2.1|EKB-2692:
.. _21.1|VOSS-842:



.. tip:: 

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


Overview
........

Cisco Unity Connection (CUC) devices provide voicemail services and can be dedicated to a customer or shared across multiple customers.

========================================== ========================================================
Dedicate a CUC to a single customer        Configure the CUC at the customer hierarchy node. 

Share a CUC across multiple customers      Configure the CUC at a hierarchy node above the 
                                           customer (reseller, provider, or intermediate node). 
                                           The CUC device must be included in one or more 
                                           Network Device Lists (NDLs), and the NDL must be 
                                           assigned to one or more sites.
========================================== ========================================================







Add a CUC server
.................

To add a CUC server: 

1. Log in as the appropriate hierarchy administrator.

   * **Creating a shared instance**? Log in as provider or reseller admin. 
   * **Creating a dedicated instance**? Log in as customer, provider, or reseller admin. 

#. Choose the relevant hierarchy. 

   * **Creating a shared instance**? Set the hierarchy to the provider or reseller level. 
   * **Creating a dedicated instance**? Set the hierarchy to the customer level.

#. Go to the CUC **Servers** list view. 

#. Click the Plus icon (+) to add a new server.
#. On the **Base** tab/panel, configure server details:  

   .. image:: /src/images/cuc-server-base-tab.png 

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

   +--------------------+--------------------------------------------------------------------------------+
   | Field              | Description                                                                    |
   +====================+================================================================================+
   | CUCxn Server Name  | Mandatory. Fill out the Cisco Unity Connection (CUC) server name.              |
   |                    |                                                                                |
   +--------------------+--------------------------------------------------------------------------------+
   | Publisher          | Select this checkbox only if you're configuring a publisher node.              |
   |                    |                                                                                |
   |                    | .. note::                                                                      |
   |                    |                                                                                |
   |                    |    The **Publisher** tab/panel displays only when this checkbox is selected.   |
   +--------------------+--------------------------------------------------------------------------------+
   | Cluster Name       | Mandatory. Fill out the name you want to use for this cluster. The new cluster |
   |                    | is created with this name.                                                     |
   |                    |                                                                                |
   |                    | .. note::                                                                      |
   |                    |                                                                                |
   |                    |    If the **Publisher** checkbox is not selected, the **Cluster Name** field   |
   |                    |    appears as a drop-down list so that you can choose an existing cluster.     |
   +--------------------+--------------------------------------------------------------------------------+
   | Network Addresses  | Expand this field, then:                                                       |
   |                    |                                                                                |
   |                    | * At **Address Space**, select SERVICE_PROVIDER_SPACE.                         |
   |                    | * At **IPV4 Address**, fill out the IP address of the CUC server.              |
   |                    | * The **Hostname** field is automatically populated with the CUC server name.  |
   |                    |   Edit this value if necessary.                                                |
   |                    |                                                                                |
   |                    | .. note::                                                                      |
   |                    |                                                                                |
   |                    |    Either the hostname *or* the IP address is required. Ensure that the        |
   |                    |    hostname or IP address does not contain a trailing blank space.             |
   |                    |    Automate cannot validate an entry that contains a blank space at the end of |
   |                    |    the hostname or IP address.                                                 |
   |                    |                                                                                |
   |                    | * At **Domain**, fill out the domain of the CUC application.                   |
   |                    | * At **Description**, fill out a description for the network address.          |
   |                    |                                                                                |
   |                    |   If NAT is used, also configure an APPLICATION_SPACE network address.         |
   +--------------------+--------------------------------------------------------------------------------+


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

   +--------------------+--------------------------------------------------------------------------------+
   | Field              | Description                                                                    |
   +====================+================================================================================+
   | Credentials        | Expand this field to add ADMIN credential type, fill out credential details.   |
   |                    | When done, add more credentials, if required.                                  |
   |                    |                                                                                |
   |                    | * Fill out the user ID and password that you configured when you installed the |
   |                    |   CUC.                                                                         |
   |                    | * Choose RO (Read-only) or RW (Read or Write) for the Access Type. The default |
   |                    |   is RO.                                                                       |
   |                    | * Optionally, provide a description for the credential.                        |
   |                    |                                                                                |
   |                    | .. note::                                                                      |
   |                    |                                                                                |
   |                    |    * Automate uses ADMIN credentials to access the CUC REST API                |
   |                    |      interface for provisioning synchronization.                               |
   |                    |                                                                                |
   |                    |      These credentials must be manually configured in Cisco Unity Connection,  |
   |                    |      then configured in Automate, via the CUC **Servers** page,                |
   |                    |      **Credentials** fields.                                                   |
   |                    |                                                                                |
   |                    |    * ADMIN is required for Service Inventory to generate reports for UC        |
   |                    |      for UC applications.                                                      |
   +--------------------+--------------------------------------------------------------------------------+

#. Configure details for the **Publisher** tab/panel. 

   .. image:: /src/images/cuc-server-publisher-tab.png 

   .. note:: 
      
      This tab/panel displays *only* if you're configuring a publisher node and have 
      selected the **Publisher** checkbox on the **Base** tab/panel. 

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

   +--------------------+---------------------------------------------------------------+
   | Field              | Description                                                   |
   +====================+===============================================================+
   | Call Processing ID | The Call Processing ID of this cluster                        |
   +--------------------+---------------------------------------------------------------+
   | SDR Cluster ID     | The Shared Data Repository (SDR) CUC cluster ID.              |
   +--------------------+---------------------------------------------------------------+
   |                    | If creating at Provider level, this field is                  |
   | Multi-Tenant       | read-only and set to Shared. If creating at                   |
   |                    | Customer level, you can choose between                        |
   |                    | Dedicated and Partitioned.                                    |
   +--------------------+---------------------------------------------------------------+
   |                    | Select the version of Cisco Unity Connection                  |
   | Version            | Servers in this cluster.                                      |
   +--------------------+---------------------------------------------------------------+
   | Port               | The port on the CUC server to connect to. The default is      |
   |                    | 8443.                                                         |
   +--------------------+---------------------------------------------------------------+
   | Monitoring         | For new servers and if Arbitrator servers are available,      |
   |                    | monitoring can be enabled for this CUC server on              |
   |                    | Insights.                                                     |
   |                    |                                                               |
   |                    | The Arbitrator server checkboxes can be selected to add the   |
   |                    | server as an asset. The Arbitrator server will be updated.    |
   |                    |                                                               |
   |                    | Existing servers can be managed from the Onboard Assets       |
   |                    | and Offboard Assets menus under Insights.                     |
   |                    | The Arbitrator checkboxes will then reflect the asset status. |
   +--------------------+---------------------------------------------------------------+

   .. note:: 
      
      For more information around monitoring and Insights, see :ref:`voss-assurance-overview`.

#. Save your changes.



.. _cuc-server-deletion:

Delete a CUC server 
.....................

Deleting a Cisco Unity Connection (CUC) server in Automate also deletes local data that
has been synced to it from the CUC server, including:

* Users
* Configuration parameters
* Dial Plan information (if applicable)


