[Index]

Model: relation/HcsUnityConnectionREL

CUC

Full HTML Help

Overview

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

To dedicate a CUC to a single customer Configure the CUC at the customer hierarchy node.
To 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.

Scheduled Data Syncs

Configuring a CUC device on VOSS Automate creates a scheduled data sync to import model data from the device into VOSS Automate.

The scheduled data sync ensures that the VOSS Automate cache maintains the most current view of the configured device.

Note

If Holiday Schedules were added to CUC directly, update the default scheduled data sync instance to include the Model Type List called CUCXN Schedules in order to ensure that these holiday schedules are synced into VOSS Automate.

Any changes to the configuration occurring on the device, including additions, deletions, or modifications, reflect in VOSS Automate after the next data sync.

Note

The recurring sync (disabled by default) is scheduled to occur every 14 days. You can enable the sync and modify the schedule (via 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 manually run the data sync at any time, via 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 Automate that requires information from CUC.

The performance of a data sync can be improved by controlling the types of data that are synced. See 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.

Add a CUC Server

To add a CUC server:

  1. Log in as the appropriate hierarchy administrator.

  2. Choose the relevant hierarchy.

  3. Go to (default menus) Apps Management > CUC > Servers.

  4. Click Add.

  5. Enter a Cisco Unity Connection server name in the CUC Server Name field.

    Note

    A CUC server that has been configured in HCM-F and synced into VOSS Automate may exist at the sys.hcs hierarchy.

    If the server name you enter matches this server, the Migrate from HCM-F to VOSS Automate 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.

    Provide details for the Publisher tab:

    Field Description
    Prime Collab

    Select the Prime Collaboration management application monitoring this cluster.

    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.
    Multi-Tenant If creating at Provider level, this field is read-only and set to Shared. If creating at Customer level, you can choose between Dedicated and Partitioned.
    Version Select the version of Cisco Unity Connection 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 Insights.

    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 Insights. The arbitrator checkboxes will then reflect the asset status.

    Note

    For details on monitoring and VOSS Insights, see VOSS Assurance Monitoring 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.

    1. Choose the SERVICE_PROVIDER_SPACE address space.

    2. The Hostname field is automatically populated with the Cisco Unity Connection Server Name. Edit it if necessary.

    3. 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 Automate cannot validate an entry that contains a blank space at the end of the hostname or IP address.

    4. Fill in the domain of the Cisco Unity Connection application.

    5. Provide an optional description for the network address.

      If NAT is used, also configure an APPLICATION_SPACE network address.

  9. Expand Credentials.

    1. Add credentials for PLATFORM, ADMIN, HTTP, and SNMP_Vx credential types. Click + to add more credentials.
    2. Fill in the user ID and password that you configured when you installed the Cisco Unity Connection.
    3. Choose RO (Read-only) or RW (Read or Write) for the Access Type. The default is RO.
    4. Provide an optional description for the credential.
      • ADMIN credentials are used by VOSS Automate 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 Automate's Device Management > CUC > Servers > Credentials section.
      • PLATFORM and ADMIN are required for Service Inventory to generate reports for UC applications.

  10. Click Save.

Delete a CUC Server

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

Model Details: relation/HcsUnityConnectionREL

Title Description Details
Voss Application
  • Field Name: vossApplication
  • Type: Object
Host Name * The host name of the Cisco Unity Connection server.
  • Field Name: vossApplication.host
  • Type: String
Admin Username * The administrator Username to connect to the Cisco Unity Connection server.
  • Field Name: vossApplication.username
  • Type: String
Admin Password * The administrator Password associated with the Username to connect to the Cisco Unity Connection server. The text will be hidden.
  • Field Name: vossApplication.password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Version * The version of the Cisco Unity Connection server to connect to.
  • Field Name: vossApplication.version
  • Type: String
  • Choices: ["9.1", "10.0", "10.5", "11.5", "12.5", "14.0"]
Port The port on the Cisco Unity Connection server to connect to. Default: 443
  • Field Name: vossApplication.port
  • Type: String
  • Default: 443
Description The description of the Cisco Unified Communications Manager.
  • Field Name: vossApplication.description
  • Type: String
CUC Cluster Notes CUC Cluster Notes Field
  • Field Name: vossApplication.notes
  • Type: String
description
  • Field Name: description
  • Type: ["String", "Null"]
virtualMachine
  • Field Name: virtualMachine
  • Type: ["String", "Null"]
  • Target: device/hcmf/VirtualMachine
  • Format: uri
CUCxn Server Name *
  • Field Name: name
  • Type: String
Sdr Cluster
  • Field Name: sdrCluster
  • Type: Object
status
  • Field Name: sdrCluster.status
  • Type: ["String", "Null"]
typeAppVersion *
  • Field Name: sdrCluster.typeAppVersion
  • Type: String
  • Choices: ["VERSION_PRE_8_6", "VERSION_8_6", "VERSION_9_0", "VERSION_9_1", "VERSION_10_0", "VERSION_10_5", "VERSION_11_5", "VERSION_12_5"]
customers
  • Field Name: customers
  • Type: ["Array", "Null"]
description
  • Field Name: sdrCluster.description
  • Type: ["String", "Null"]
ownsOrgUnit
  • Field Name: sdrCluster.ownsOrgUnit
  • Type: ["String", "Null"]
  • Target: device/hcmf/OrgUnit
  • Format: uri
typeCucxnSharingMode Default: DEDICATED
  • Field Name: sdrCluster.typeCucxnSharingMode
  • Type: ["String", "Null"]
  • Default: DEDICATED
  • Choices: ["DEDICATED", "SHARED", "PARTITIONED"]
connectionStatus
  • Field Name: sdrCluster.connectionStatus
  • Type: ["String", "Null"]
cdmUpdateTimestamp
  • Field Name: sdrCluster.cdmUpdateTimestamp
  • Type: ["String", "Null"]
lastExecutedTime
  • Field Name: sdrCluster.lastExecutedTime
  • Type: ["String", "Null"]
id
  • Field Name: sdrCluster.id
  • Type: ["String", "Null"]
uUID
  • Field Name: sdrCluster.uUID
  • Type: ["String", "Null"]
numEndUserSubscribers
  • Field Name: sdrCluster.numEndUserSubscribers
  • Type: ["Integer", "Null"]
isManualMode
  • Field Name: sdrCluster.isManualMode
  • Type: ["Boolean", "Null"]
countryCode
  • Field Name: sdrCluster.countryCode
  • Type: ["String", "Null"]
monitorsPrimeCollab
  • Field Name: sdrCluster.monitorsPrimeCollab
  • Type: ["String", "Null"]
  • Target: device/hcmf/PrimeCollab
  • Format: uri
eLM
  • Field Name: sdrCluster.eLM
  • Type: ["String", "Null"]
  • Target: device/hcmf/ELM
  • Format: uri
lastSuccessfulTime
  • Field Name: sdrCluster.lastSuccessfulTime
  • Type: ["String", "Null"]
clusterID
  • Field Name: sdrCluster.clusterID
  • Type: ["String", "Null"]
virtualAccounts
  • Field Name: sdrCluster.virtualAccounts
  • Type: ["String", "Null"]
  • Target: device/hcmf/VirtualAccounts
  • Format: uri
name *
  • Field Name: sdrCluster.name
  • Type: String
isModifiable
  • Field Name: sdrCluster.isModifiable
  • Type: ["Boolean", "Null"]
cUOM
  • Field Name: sdrCluster.cUOM
  • Type: ["String", "Null"]
  • Target: device/hcmf/CUOM
  • Format: uri
callProcessingID
  • Field Name: sdrCluster.callProcessingID
  • Type: ["String", "Null"]
isDeletable
  • Field Name: sdrCluster.isDeletable
  • Type: ["Boolean", "Null"]
type * Default: CUCxnCluster
  • Field Name: sdrCluster.type
  • Type: String
  • Default: CUCxnCluster
email
  • Field Name: sdrCluster.email
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: sdrCluster.syncTimestamp
  • Type: ["String", "Null"]
Voss Cluster
  • Field Name: vossCluster
  • Type: Object
Name * The (unique) name of the CUCxn cluster.
  • Field Name: vossCluster.name
  • Type: String
  • Target: device/hcmf/CUCxnCluster
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Sync on Create/Update If this checkbox is selected, then when saving this form (on either create or update), it will also immediately trigger the auto-import (sync) of this UC App server now.
  • Field Name: vossCluster.sync_on_save
  • Type: Boolean
Version Indicates the version of the CUCxns within the cluster.
  • Field Name: vossCluster.version
  • Type: String
  • Target: data/HcsVossToSdrVersionMap
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
HostNameOrIP The hostname or IPV4 of the CUCxn
  • Field Name: vossCluster.hostNameOrIP
  • Type: String
  • MaxLength: 1024
User Move Mode The behavior for moving users to site. Setting this value to Automatic will trigger the system to apply the move filters (refer to User Management) automatically when users are sync'd into the system. Automatic is only applicable to creating new users. Setting this value to Manual means that users must be moved to site by an Adminstrator (refer to User Management). Default: Automatic
  • Field Name: vossCluster.filter_move_mode
  • Type: String
  • Default: Automatic
  • MaxLength: 1024
  • Choices: ["Automatic", "Manual"]
User Entitlement Profile The Entitlement Profile assigned to users imported from this UC Application.
  • Field Name: vossCluster.default_entitlement_profile
  • Type: String
  • Target: data/HcsEntitlementProfileDAT
  • MaxLength: 1024
  • Format: uri
Misc Data Miscellaneous data used at run-time
  • Field Name: vossCluster.misc_data
  • Type: String
  • MaxLength: 1024
Migrate from HCM-F to CUCDM Migrate HCM-F Models to CUCDM Models Default: false
  • Field Name: vossCluster.migrate
  • Type: Boolean
  • Default: false
Multi-Tenant Indicates whether the cluster applications are dedicated to a customer, or partitioned for multiple customers Default: (( macro.HcsCustomerHnCountMCR > 0 )) <Dedicated> <Partitioned>
  • Field Name: vossCluster.multi_tenant
  • Type: String
  • Default: (( macro.HcsCustomerHnCountMCR > 0 )) <Dedicated> <Partitioned>
  • MaxLength: 1024
  • Choices: ["Dedicated", "Partitioned"]
Monitoring Manage Monitoring for this Cluster
  • Field Name: monitoring
  • Type: Object
Credential Type Select the credential type to use for the monitoring. Default: ADMIN
  • Field Name: vossCluster.monitoring.credential_type
  • Type: String
  • Default: ADMIN
  • Choices: ["SNMP_V1", "SNMP_V2", "SNMP_V3", "ADMIN", "PLATFORM", "WMI", "IOS_ENABLE", "HTTP", "CLI", "OPERATOR", "SFTP", "JTAPI"]
Assurance Arbitrator Servers Select the Assurance Arbitrator servers to configure for monitoring this cluster.
  • Field Name: arbitrators.[n]
  • Type: Array
networkAddresses
  • Field Name: networkAddresses
  • Type: ["Array", "Null"]
domain
  • Field Name: networkAddresses.domain
  • Type: ["String", "Null"]
iPAddrV4
  • Field Name: networkAddresses.iPAddrV4
  • Type: ["String", "Null"]
description
  • Field Name: networkAddresses.description
  • Type: ["String", "Null"]
iPAddrV6
  • Field Name: networkAddresses.iPAddrV6
  • Type: ["String", "Null"]
hostShortNameOnly
  • Field Name: networkAddresses.hostShortNameOnly
  • Type: ["String", "Null"]
isModifiable
  • Field Name: networkAddresses.isModifiable
  • Type: ["Boolean", "Null"]
isSRVAddress *
  • Field Name: networkAddresses.isSRVAddress
  • Type: Boolean
typeAddressSpace *
  • Field Name: networkAddresses.typeAddressSpace
  • Type: String
  • Choices: ["APPLICATION_SPACE", "SERVICE_PROVIDER_SPACE", "CUSTOMER_SPACE"]
cdmUpdateTimestamp
  • Field Name: networkAddresses.cdmUpdateTimestamp
  • Type: ["String", "Null"]
id
  • Field Name: networkAddresses.id
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: networkAddresses.syncTimestamp
  • Type: ["String", "Null"]
isDeletable
  • Field Name: networkAddresses.isDeletable
  • Type: ["Boolean", "Null"]
cUCxnCluster *
  • Field Name: cUCxnCluster
  • Type: String
  • Target: device/hcmf/CUCxnCluster
  • Format: uri
routingId
  • Field Name: routingId
  • Type: ["String", "Null"]
isUCPublisher
  • Field Name: isUCPublisher
  • Type: ["Boolean", "Null"]
isModifiable
  • Field Name: isModifiable
  • Type: ["Boolean", "Null"]
Cluster Name
  • Field Name: bkCUCxnCluster_name
  • Type: ["String", "Null"]
credentials
  • Field Name: credentials
  • Type: ["Array", "Null"]
password_CommunityString
  • Field Name: credentials.password_CommunityString
  • Type: ["String", "Null"]
  • Is Password: True
  • Store Encrypted: True
description
  • Field Name: credentials.description
  • Type: ["String", "Null"]
userID
  • Field Name: credentials.userID
  • Type: ["String", "Null"]
typeCredential *
  • Field Name: credentials.typeCredential
  • Type: String
  • Choices: ["SNMP_V1", "SNMP_V2", "SNMP_V3", "ADMIN", "PLATFORM", "WMI", "IOS_ENABLE", "HTTP", "CLI", "OPERATOR", "SFTP", "JTAPI"]
isModifiable
  • Field Name: credentials.isModifiable
  • Type: ["Boolean", "Null"]
cdmUpdateTimestamp
  • Field Name: credentials.cdmUpdateTimestamp
  • Type: ["String", "Null"]
typeSNMPAccess Default: RO
  • Field Name: credentials.typeSNMPAccess
  • Type: ["String", "Null"]
  • Default: RO
  • Choices: ["RO", "RW"]
id
  • Field Name: credentials.id
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: credentials.syncTimestamp
  • Type: ["String", "Null"]
isDeletable
  • Field Name: credentials.isDeletable
  • Type: ["Boolean", "Null"]
isAutoLinked Default: True
  • Field Name: isAutoLinked
  • Type: ["Boolean", "Null"]
  • Default: True
isDeletable
  • Field Name: isDeletable
  • Type: ["Boolean", "Null"]
type * Default: CUCxn
  • Field Name: type
  • Type: String
  • Default: CUCxn
id
  • Field Name: id
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: syncTimestamp
  • Type: ["String", "Null"]
cdmUpdateTimestamp
  • Field Name: cdmUpdateTimestamp
  • Type: ["String", "Null"]