.. _set_up_cisco_unity_connection:
Set up Cisco Unity Connection
-----------------------------
.. _19.2.1|EKB-2692:
.. _21.1|VOSS-842:
Overview
........
Cisco Unity Connection devices provide voicemail services for HCS deployments,
and can be dedicated to a customer or shared across multiple customers. To
dedicate a Cisco Unity Connection to a single customer, configure the Cisco Unity
Connection at the customer hierarchy node. To share a Cisco Unity Connection
across multiple customers, configure the Cisco Unity Connection at a hierarchy
node above the customer (reseller, provider, or intermediate node). The Cisco
Unity Connection device must be included in one or more Network Device Lists
(NDLs), and the NDL must be assigned to one or more sites.
Synchronization with VOSS-4-UC
..............................
Configuring a Cisco Unity Connection device on VOSS-4-UC creates a scheduled
data sync to import model data from the device into VOSS-4-UC. The scheduled data
sync ensures that the VOSS-4-UC cache maintains the most current view of the
configured device. Any changes to the configuration occurring on the device,
including additions, deletions, or modifications, will be reflected in VOSS-4-UC
after the next data sync.
.. note::
* There is no immediate data sync upon Update or Modification.
* Some license-related models will now be excluded from Cisco Unity Connection
imports by default:
* ``device/cuc/Handler``
* ``device/cuc/GlobalUser``
* ``device/cuc/LicenseStatus``
* ``device/cuc/TenantUserLicense``
* ``device/cuc/UserLicense``
The recurring sync is scheduled to occur every 14 days, but is disabled by default.
You can enable the sync and modify the schedule from **Apps Management > CUC > Schedules**.
When determining the appropriate schedule setting, the frequency of the sync must be
weighed against the additional processing and network activity associated with
the data sync. You can also manually run the data sync at any time from
**Apps Management > Advanced > Perform Publisher Actions**, or from
**Administration Tools > Data Sync**.
.. important::
Allow the initial data sync to complete before doing more configuration on
VOSS-4-UC that requires information from Cisco Unity Connection.
The performance of a data sync can be improved by controlling the types of data
that are synced. See :ref:`controlling_a_data_sync_with_a_model_type_list` for more
information.
.. note::
References to HCM-F and Shared Data Repository (SDR) are only relevant if
installed.
**Perform these steps**:
1. Log in as the appropriate hierarchy administrator.
Only a provider or reseller administrator can create a shared instance.
A customer, provider, or reseller administrator can create a dedicated instance.
2. Set the hierarchy path to the correct level. Create a shared instance at the
provider or reseller level. Create a dedicated instance at the customer level.
3. Choose **Apps Management > CUC > Servers**.
4. Click **Add**.
5. Enter a Cisco Unity Connection server name in the **CUC Server Name** field.
Note: A Cisco Unity Connection server that has been configured in
HCM-F and synced into VOSS-4-UC may exist at the sys.hcs hierarchy.
If the server name you enter matches this server, the **Migrate from
HCM-F to VOSS-4-UC** check box is displayed. Click **Save** to migrate this
server to the current hierarchy level. The fields are populated with
the values that were configured in HCM-F. If you do not want to
migrate the server, enter a different server name.
6. Select the **Publisher** check box if you are configuring a publisher node.
Note:
The **Publisher** tab is populated only when the **Publisher** check box is selected.
On the **Publisher** tab, you can specify the following information:
.. tabularcolumns:: |p{4cm}|p{11cm}|
+--------------------+---------------------------------------------------------------+
| Field | Description |
+====================+===============================================================+
| | Select the Prime Collaboration management |
| | application monitoring this cluster. |
| Prime Collab | |
| | To unassociate Prime Collaboration for this |
| | cluster, select None. |
+--------------------+---------------------------------------------------------------+
| Call Processing ID | The Call Processing ID of this cluster |
+--------------------+---------------------------------------------------------------+
| Cluster ID | The Cluster ID of this cluster. |
+--------------------+---------------------------------------------------------------+
| | 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. The available |
| | versions depend on the version of HCM-F that |
| | has been configured. |
+--------------------+---------------------------------------------------------------+
| Port | The port on the Cisco Unity Connection server |
| | to connect to. Default is 8443. |
+--------------------+---------------------------------------------------------------+
| Monitoring | For new servers and if arbitrator servers are available, |
| | monitoring can be enabled for this Unity Connection server on |
| | VOSS Assurance. |
| | |
| | The arbitrator server check boxes 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 VOSS Assurance. |
| | The arbitrator checkboxes will then reflect the asset status. |
+--------------------+---------------------------------------------------------------+
.. note::
For details on monitoring and VOSS Assurance and Analytics, see :ref:`voss-assurance-overview`.
7. Fill in the **Cluster Name** field with the name you want for this cluster. A new
cluster is created with this name. This field is mandatory.
Note: If the **Publisher** check box is not selected, the **Cluster Name** field
appears as a drop-down list, from which you choose an existing cluster.
8. Expand **Network Addresses**.
a. Choose the SERVICE_PROVIDER_SPACE address space.
b. The **Hostname** field is automatically populated with the Cisco Unity
Connection Server Name. Edit it if necessary.
c. Enter the IP address of the Cisco Unity Connection Server in the **IPV4
Address** field.
Note: Either the hostname or the IP address is required. Ensure that the
hostname or IP address does not contain a trailing blank space. VOSS-4-UC
cannot validate an entry that contains a blank space at the end of the
hostname or IP address.
d. Fill in the domain of the Cisco Unity Connection application.
e. Provide an optional description for the network address.
If NAT is used, also configure an APPLICATION_SPACE network address.
9. Expand **Credentials**.
a. Add credentials for PLATFORM, ADMIN, HTTP, and SNMP_Vx credential
types. Click + to add more credentials.
b. Fill in the user ID and password that you configured when you
installed the Cisco Unity Connection.
c. Choose RO (Read-only) or RW (Read or Write) for the Access Type.
The default is RO.
d. Provide an optional description for the credential.
* ADMIN credentials are used by VOSS-4-UC to access the Cisco
Unity Connection REST API interface for provisioning
synchronization.
* PLATFORM credentials are used by HCM-F (HLM service) to set the
deployment mode and restart the publisher.
* ADMIN, HTTP, and SNMP are required for PCA to manage Cisco Unity
Connection. These credentials must be manually configured in
Cisco Unity Connection, then configured in VOSS-4-UC's **Device
Management > CUC > Servers > Credentials** section.
* PLATFORM and ADMIN are required for Service Inventory to generate
reports for UC applications.
10. Click **Save**.