[Index]

Model: relation/HcsUnityConnectionREL

CUC

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

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 Device 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 Device 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 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.

Procedure

  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 Device 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:

    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.

  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-4-UC 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-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.

Model Details: relation/HcsUnityConnectionREL

Title Description Details
id
  • Field Name: id
  • Type: String
  • MaxLength: 1024
Is UC Publisher
  • Field Name: isUCPublisher
  • Type: Boolean
Server Name *
  • Field Name: name
  • Type: String
  • MaxLength: 64
Description
  • Field Name: description
  • Type: String
  • MaxLength: 128
Type Deployment Mode
  • Field Name: typeDeploymentMode
  • Type: String
  • MaxLength: 1024
  • Choices: ["HCS", "HCS_LE", "ENTERPRISE"]
Is Auto Linked Default: True
  • Field Name: isAutoLinked
  • Type: Boolean
  • Default: True
Routing Id
  • Field Name: routingId
  • Type: String
  • MaxLength: 128
CUCxn Cluster *
  • Field Name: cUCxnCluster
  • Type: String
  • Target: data/HCSHcmfCUCxnClusterDAT
  • MaxLength: 1024
  • Format: uri
Virtual Machine
  • Field Name: virtualMachine
  • Type: String
  • Target: data/HCSHcmfVirtualMachineDAT
  • MaxLength: 1024
  • Format: uri
Credentials
  • Field Name: credentials.[n]
  • Type: Array
Description
  • Field Name: credentials.[n].description
  • Type: String
  • MaxLength: 128
Type Credential *
  • Field Name: credentials.[n].typeCredential
  • Type: String
  • MaxLength: 1024
  • Choices: ["SNMP_V1", "SNMP_V2", "SNMP_V3", "ADMIN", "PLATFORM", "WMI", "IOS_ENABLE", "HTTP", "CLI", "OPERATOR", "SFTP", "JTAPI"]
User ID
  • Field Name: credentials.[n].userID
  • Type: String
  • MaxLength: 256
Password Community String
  • Field Name: credentials.[n].password_CommunityString
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 512
Type SNMP Access Default: RO
  • Field Name: credentials.[n].typeSNMPAccess
  • Type: String
  • Default: RO
  • MaxLength: 1024
  • Choices: ["RO", "RW"]
Network Addresses
  • Field Name: networkAddresses.[n]
  • Type: Array
Type Address Space *
  • Field Name: networkAddresses.[n].typeAddressSpace
  • Type: String
  • MaxLength: 1024
  • Choices: ["APPLICATION_SPACE", "SERVICE_PROVIDER_SPACE", "CUSTOMER_SPACE"]
Description
  • Field Name: networkAddresses.[n].description
  • Type: String
  • MaxLength: 128
IP Addr V4
  • Field Name: networkAddresses.[n].iPAddrV4
  • Type: String
  • MaxLength: 64
IP Addr V6
  • Field Name: networkAddresses.[n].iPAddrV6
  • Type: String
  • MaxLength: 64
Host Short Name Only
  • Field Name: networkAddresses.[n].hostShortNameOnly
  • Type: String
  • MaxLength: 128
Domain
  • Field Name: networkAddresses.[n].domain
  • Type: String
  • MaxLength: 128
Is SRV Address *
  • Field Name: networkAddresses.[n].isSRVAddress
  • Type: Boolean
Cluster Name
  • Field Name: bkCUCxnCluster_name
  • Type: String
  • Target: data/HCSHcmfCUCxnClusterDAT
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Sdr Cluster
  • Field Name: sdrCluster
  • Type: Object
id
  • Field Name: sdrCluster.id
  • Type: String
  • MaxLength: 1024
Type Cucxn Sharing Mode Default: DEDICATED
  • Field Name: sdrCluster.typeCucxnSharingMode
  • Type: String
  • Default: DEDICATED
  • MaxLength: 1024
  • Choices: ["DEDICATED", "SHARED", "PARTITIONED"]
Name *
  • Field Name: sdrCluster.name
  • Type: String
  • MaxLength: 128
Cluster ID
  • Field Name: sdrCluster.clusterID
  • Type: String
  • MaxLength: 64
Call Processing ID
  • Field Name: sdrCluster.callProcessingID
  • Type: String
  • MaxLength: 64
Description
  • Field Name: sdrCluster.description
  • Type: String
  • MaxLength: 128
Type App Version *
  • Field Name: sdrCluster.typeAppVersion
  • Type: String
  • MaxLength: 1024
  • Choices: ["VERSION_PRE_8_6", "VERSION_8_6", "VERSION_9_0", "VERSION_9_1", "VERSION_10_0", "VERSION_10_5"]
Is Manual Mode
  • Field Name: sdrCluster.isManualMode
  • Type: Boolean
Email
  • Field Name: sdrCluster.email
  • Type: String
  • MaxLength: 128
Country Code
  • Field Name: sdrCluster.countryCode
  • Type: String
  • MaxLength: 8
Num End User Subscribers
  • Field Name: sdrCluster.numEndUserSubscribers
  • Type: Integer
  • Maximum: 65535
ELMID
  • Field Name: sdrCluster.eLMID
  • Type: String
  • MaxLength: 128
CUOM
  • Field Name: sdrCluster.cUOM
  • Type: String
  • Target: data/HCSHcmfCUOMDAT
  • MaxLength: 1024
  • Format: uri
ELM
  • Field Name: sdrCluster.eLM
  • Type: String
  • Target: data/HCSHcmfELMDAT
  • MaxLength: 1024
  • Format: uri
Owns Org Unit
  • Field Name: sdrCluster.ownsOrgUnit
  • Type: String
  • Target: data/HCSHcmfOrgUnitDAT
  • MaxLength: 1024
  • Format: uri
Monitors Prime Collab
  • Field Name: sdrCluster.monitorsPrimeCollab
  • Type: String
  • Target: data/HCSHcmfPrimeCollabDAT
  • MaxLength: 1024
  • Format: uri
Customers
  • Field Name: customers.[n]
  • Type: Array
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"]
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
Voss Cluster
  • Field Name: vossCluster
  • Type: Object
Name * The (unique) name of the CUCxn cluster.
  • Field Name: vossCluster.name
  • Type: String
  • Target: data/HCSHcmfCUCxnClusterDAT
  • 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"]