[Index]

Model: relation/HcsUnityConnectionREL

CUC

Full HTML Help

Overview

Cisco Unity Connection (CUC) devices provide voicemail services 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.

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 to open the server configuration page.

  5. Configure details for the Base tab/panel:

    The table describes configuration options on the Base tab:

    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. VOSS 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.
    Field Description
    Credentials

    Expand this field then add credentials for PLATFORM, ADMIN, HTTP, and SNMP_Vx credential types. Click the Plus icon (+) to add more credentials:

    • 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

    • ADMIN credentials are used by Automate to access the CUC REST API interface for provisioning synchronization.

      These credentials must be manually configured in Cisco Unity Connection, then configured in VOSS Automate, via (default menus) Apps Management > CUC > Servers, Credentials fields.

    • PLATFORM and ADMIN are required for Service Inventory to generate reports for UC applications.

  6. Configure details for the Publisher tab/panel.

    Note

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

    The table describes configuration options on the Publisher tab:

    Field Description
    Call Processing ID The Call Processing ID of this cluster
    SDR Cluster ID The Shared Data Repository (SDR) CUC cluster ID.
    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.
    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 VOSS 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 VOSS Insights. The Arbitrator checkboxes will then reflect the asset status.

    Note

    For more information around monitoring and VOSS Insights, see VOSS Assurance Monitoring Overview.

  1. 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
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", "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
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"]
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