[Index]

Model: relation/HcsCallManagerREL

CUCM

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

This procedure configures Cisco Unified Communications Manager servers within a Unified CM cluster.

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 Device Management > CUCM > Servers.

  4. Click Add.

  5. Enter the Unified CM server name in the CUCM Server Name field.

    Note: A Unified CM 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. From the Server Type drop-down, choose Voice/Video.

  7. To configure a publisher node, select the Publisher check box.

    On the Publisher tab, you can specify the following information:

    Field Description
    Prime Collaboration

    Choose the Prime Collaboration management application monitoring this cluster.

    To unassociate Prime Collaboration for this cluster, choose None.
    Call Processing ID The Call Processing ID of this cluster
    SDR Cluster ID The SDR CUCM cluster ID, as shown on SDR Configuration > SDR CUCM Clusters.
    Multi-Tenant Read-only field. If creating at provider level, this field is set to Shared. If creating at customer level, this field is set to Dedicated.
    Version Choose the version of the Unified CM Servers in this cluster. The available versions depend on the version of the HCM-F device that has been configured.
    Port The port on the Unified CM server to connect to. Default is 8443.
    User Move Mode Choose Automatic to automatically move synced in users to sites, based on the filters and filter order defined in User Management > Manage Filters. Choose Manual if you want an Administrator to manually move synced in users to a Site.
    User Entitlement Profile

    Choose the Entitlement Profile that specifies which devices and services users synced from this Unified CM are entitled to.

    Note:

    A violation of the Entitlement Profile does not prevent a user from being synced to VOSS Automate from Unified CM. However, subsequent updates to the user fail until the user's configuration satisfies the restrictions set in the Entitlement Profile.
    Enable Change Notification Sync Select this check box to enable Change Notification. By enabling this, a Change Notification data sync and corresponding Schedule will be created. The Schedule is initially created as Disabled and needs to be manually enabled from the Scheduling menu. The Change Notification Sync interval is set to 14 days by default. See the note below this table.
    Monitoring

    For new servers and if arbitrator servers are available, monitoring can be enabled for this Unified CM 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.

  8. For a Unified CM Publisher node, 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 required. For Unified CM Subscribers, choose the Unified CM cluster from the Cluster Name drop-down menu.

  9. Expand Network Addresses.

    1. Choose the SERVICE_PROVIDER_SPACE address space.
    2. The Hostname field is automatically populated with the Unified CM Server Name. Edit it if necessary.
    3. Enter the IP address of the Cisco Unified Communications Manager 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 Unified CM application.
    5. Provide an optional description for the network address.

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

  10. 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 Unified CM.
    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, HTTP, PLATFORM, and SNMP are required for PCA to manage Unified CM. PLATFORM and ADMIN are also required for Service Inventory to generate reports for UC applications.

    Note

    • Expiration of the ADMIN account results in failed data syncs between Unified CM and VOSS Automate
    • The CUCM Admin Account requires the following roles (can be added in a group):
      • For normal AXL Add, Update, Delete transactions you need: Standard AXL API Access
      • For the Extension Mobility Login/Logout you need: Standard EM Authentication Proxy Rights
      • For querying the Phone Status via RIS API, uploading MOH files via GUI (Selenium Driver) and enabling Headset Service (also RIS API) you need: Standard CCM Admin Users

  11. Inspect the default mappings and modify if required, see User Field Mapping.

  12. Click Save. A Unified CM network device is created in VOSS Automate. (If installed, a cluster and Unified CM are created in the SDR.)

  13. Test the connection between Unified CM and VOSS Automate:

    1. Choose Device Management > Advanced > CUCM Network Device.
    2. Click the Unified CM you just added.
    3. Choose Action > Test Connection.

    If the test fails, and you used a hostname, make sure VOSS Automate has the correct DNS and Domain set.

    1. Log in to the platform CLI.
    2. Query the current DNS setting: network dns.
    3. Set the DNS if needed: network dns <dns_server_ip_address>.
    4. Query the current domain setting: network domain.
    5. Set the domain if needed: network domain <domain>.

    Note:

    Use the CUCM Network Device page only for testing the connection. Do not edit Unified CM from this page. To change any configuration of the Unified CM, edit it from the Device Management > CUCM > Servers page in VOSS Automate.

Model Details: relation/HcsCallManagerREL

Title Description Details
id
  • Field Name: id
  • Type: String
  • MaxLength: 1024
Is UC Publisher
  • Field Name: isUCPublisher
  • Type: Boolean
Is TFTP Server
  • Field Name: isTFTPServer
  • Type: Boolean
Is Music Server
  • Field Name: isMusicServer
  • Type: Boolean
Is Attendant Console
  • Field Name: isAttendantConsole
  • Type: Boolean
Is CTI Manager
  • Field Name: isCTIManager
  • Type: Boolean
Is Conference Server
  • Field Name: isConferenceServer
  • Type: Boolean
Is Annunciator
  • Field Name: isAnnunciator
  • Type: Boolean
Is Media Termination Point
  • Field Name: isMediaTerminationPoint
  • Type: Boolean
Is Call Processing Engine
  • Field Name: isCallProcessingEngine
  • Type: Boolean
Type Cucm Server * Default: VOICE_VIDEO
  • Field Name: typeCucmServer
  • Type: String
  • Default: VOICE_VIDEO
  • MaxLength: 1024
  • Choices: ["VOICE_VIDEO", "IM_P"]
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
CUCM Cluster *
  • Field Name: cUCMCluster
  • Type: String
  • Target: data/HCSHcmfCUCMClusterDAT
  • 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
SIP Trunks
  • Field Name: sIPTrunks.[n]
  • Type: Array
Cluster Name
  • Field Name: bkCUCMCluster_name
  • Type: String
  • Target: data/HCSHcmfCUCMClusterDAT
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Sdr Cluster
  • Field Name: sdrCluster
  • Type: Object
id
  • Field Name: sdrCluster.id
  • Type: String
  • MaxLength: 1024
Type Cucm Cup Sharing Mode Default: DEDICATED
  • Field Name: sdrCluster.typeCucmCupSharingMode
  • Type: String
  • Default: DEDICATED
  • MaxLength: 1024
  • Choices: ["DEDICATED", "SHARED"]
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
Description The description of the Cisco Unified Communications Manager.
  • Field Name: vossApplication.description
  • Type: String
Host Name * The host name of the Cisco Unified Communications Manager.
  • Field Name: vossApplication.host
  • Type: String
Admin Username * The administrator Username to connect to the Cisco Unified Communications Manager.
  • Field Name: vossApplication.username
  • Type: String
Admin Password * The administrator Password associated with the Username to connect to the Cisco Unified Communications Manager. The text will be hidden.
  • Field Name: vossApplication.password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Version * The selected version of the Cisco Unified Communications Manager to connect to. The list of versions is maintained in the CallManagerVersion model.
  • 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 Unified Communications Manager server to connect to. Default: 8443
  • Field Name: vossApplication.port
  • Type: String
  • Default: 8443
Immediate Import Deprecated.
  • Field Name: vossApplication.import
  • Type: Boolean
CUCM Cluster Notes CUCM Cluster Notes Field
  • Field Name: vossApplication.notes
  • Type: String
Voss Cluster
  • Field Name: vossCluster
  • Type: Object
Name * The (unique) name of the CUCM cluster.
  • Field Name: vossCluster.name
  • Type: String
  • Target: data/HCSHcmfCUCMClusterDAT
  • 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 CUCMs 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 CUCM
  • 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 shared across multiple customers
  • Field Name: vossCluster.multi_tenant
  • Type: String
  • MaxLength: 1024
  • Choices: ["Dedicated", "Shared"]
Enable Change Notification Sync Enable Change Notification Sync for Cluster Default: false
  • Field Name: vossCluster.enableCnf
  • Type: Boolean
  • Default: false
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
Field Mapping
  • Field Name: FieldMapping
  • Type: Object
User ID * The CUCM field mapped to the user's login attribute. Default: userid
  • Field Name: vossCluster.FieldMapping.username
  • Type: String
  • Default: userid
  • MaxLength: 1024
Building Name The CUCM field mapped to the user's custom building name.
  • Field Name: vossCluster.FieldMapping.buildingName
  • Type: String
  • MaxLength: 1024
C The CUCM field mapped to the user's custom country.
  • Field Name: vossCluster.FieldMapping.c
  • Type: String
  • MaxLength: 1024
Department The CUCM field mapped to the user's department number. Default: department
  • Field Name: vossCluster.FieldMapping.departmentNumber
  • Type: String
  • Default: department
  • MaxLength: 1024
Directory URI The CUCM field mapped to the user's custom directory URI. Default: directoryUri
  • Field Name: vossCluster.FieldMapping.directoryUri
  • Type: String
  • Default: directoryUri
  • MaxLength: 1024
Display Name The CUCM field mapped to the user's custom display name.
  • Field Name: vossCluster.FieldMapping.displayName
  • Type: String
  • MaxLength: 1024
Employee Number The CUCM field mapped to the user's custom employee number.
  • Field Name: vossCluster.FieldMapping.employeeNumber
  • Type: String
  • MaxLength: 1024
Employee Type The CUCM field mapped to the user's custom employee type.
  • Field Name: vossCluster.FieldMapping.employeeType
  • Type: String
  • MaxLength: 1024
Facsimile Telephone Number The CUCM field mapped to the user's custom FAX number.
  • Field Name: vossCluster.FieldMapping.facsimileTelephoneNumber
  • Type: String
  • MaxLength: 1024
First Name The CUCM field mapped to the user's first name. Default: firstName
  • Field Name: vossCluster.FieldMapping.givenName
  • Type: String
  • Default: firstName
  • MaxLength: 1024
Home Number The CUCM field mapped to the user's home phone number. Default: homeNumber
  • Field Name: vossCluster.FieldMapping.homePhone
  • Type: String
  • Default: homeNumber
  • MaxLength: 1024
IP Phone The CUCM field mapped to the user's custom IP phone number.
  • Field Name: vossCluster.FieldMapping.ipPhone
  • Type: String
  • MaxLength: 1024
Jabber ID The CUCM field mapped to the user's custom Jabber ID.
  • Field Name: vossCluster.FieldMapping.jabberID
  • Type: String
  • MaxLength: 1024
L The CUCM field mapped to the user's custom city.
  • Field Name: vossCluster.FieldMapping.l
  • Type: String
  • MaxLength: 1024
Mail ID The CUCM field mapped to the user's email address. Default: mailid
  • Field Name: vossCluster.FieldMapping.mail
  • Type: String
  • Default: mailid
  • MaxLength: 1024
Manager ID The CUCM field mapped to the user's manager. Default: manager
  • Field Name: vossCluster.FieldMapping.manager
  • Type: String
  • Default: manager
  • MaxLength: 1024
Member Of The CUCM field mapped to the user's groups.
  • Field Name: vossCluster.FieldMapping.memberOf
  • Type: String
  • MaxLength: 1024
Mobile Number The CUCM field mapped to the user's mobile phone number. Default: mobileNumber
  • Field Name: vossCluster.FieldMapping.mobile
  • Type: String
  • Default: mobileNumber
  • MaxLength: 1024
O The CUCM field mapped to the user's custom organization name.
  • Field Name: vossCluster.FieldMapping.o
  • Type: String
  • MaxLength: 1024
Object Class The CUCM field mapped to the user's object class.
  • Field Name: vossCluster.FieldMapping.objectClass
  • Type: String
  • MaxLength: 1024
Other Mailbox The CUCM field mapped to the user's other mailbox.
  • Field Name: vossCluster.FieldMapping.otherMailbox
  • Type: String
  • MaxLength: 1024
Ou The CUCM field mapped to the user's custom organization unit name.
  • Field Name: vossCluster.FieldMapping.ou
  • Type: String
  • MaxLength: 1024
Photo URL The CUCM field mapped to the user's custom photo URL.
  • Field Name: vossCluster.FieldMapping.photoURL
  • Type: String
  • MaxLength: 1024
Physical Delivery Office Name The CUCM field mapped to the user's post office.
  • Field Name: vossCluster.FieldMapping.physicalDeliveryOfficeName
  • Type: String
  • MaxLength: 1024
Postal Code The CUCM field mapped to the user's postal code.
  • Field Name: vossCluster.FieldMapping.postalCode
  • Type: String
  • MaxLength: 1024
Preferred Language The CUCM field mapped to the user's preferred language.
  • Field Name: vossCluster.FieldMapping.preferredLanguage
  • Type: String
  • MaxLength: 1024
Last Name * The CUCM field mapped to the user's last name. Default: lastName
  • Field Name: vossCluster.FieldMapping.sn
  • Type: String
  • Default: lastName
  • MaxLength: 1024
St The CUCM field mapped to the user's state.
  • Field Name: vossCluster.FieldMapping.st
  • Type: String
  • MaxLength: 1024
Street The CUCM field mapped to the user's street.
  • Field Name: vossCluster.FieldMapping.street
  • Type: String
  • MaxLength: 1024
Telephone Number The CUCM field mapped to the user's telephone number. Default: telephoneNumber
  • Field Name: vossCluster.FieldMapping.telephoneNumber
  • Type: String
  • Default: telephoneNumber
  • MaxLength: 1024
Timezone The CUCM field mapped to the user's time zone.
  • Field Name: vossCluster.FieldMapping.timezone
  • Type: String
  • MaxLength: 1024
Title The CUCM field mapped to the user's title. Default: title
  • Field Name: vossCluster.FieldMapping.title
  • Type: String
  • Default: title
  • MaxLength: 1024
Uid The CUCM field mapped to the user's userid.
  • Field Name: vossCluster.FieldMapping.uid
  • Type: String
  • MaxLength: 1024
Unverified Mail Box The CUCM field mapped to the user's unverified mailbox.
  • Field Name: vossCluster.FieldMapping.unverifiedMailBox
  • Type: String
  • MaxLength: 1024
Custom String 1 The CUCM field mapped to a custom string.
  • Field Name: vossCluster.FieldMapping.customString1
  • Type: String
  • MaxLength: 1024
Custom String 2 The CUCM field mapped to a custom string.
  • Field Name: vossCluster.FieldMapping.customString2
  • Type: String
  • MaxLength: 1024
Custom String 3 The CUCM field mapped to a custom string.
  • Field Name: vossCluster.FieldMapping.customString3
  • Type: String
  • MaxLength: 1024
Custom String 4 The CUCM field mapped to a custom string.
  • Field Name: vossCluster.FieldMapping.customString4
  • Type: String
  • MaxLength: 1024
Custom String 5 The CUCM field mapped to a custom string.
  • Field Name: vossCluster.FieldMapping.customString5
  • Type: String
  • MaxLength: 1024
Custom List of Strings 1 The CUCM field mapped to a custom list of strings.
  • Field Name: vossCluster.FieldMapping.customListOfStrings1
  • Type: String
  • MaxLength: 1024
Custom List of Strings 2 The CUCM field mapped to a custom list of strings.
  • Field Name: vossCluster.FieldMapping.customListOfStrings2
  • Type: String
  • MaxLength: 1024
Custom List of Strings 3 The CUCM field mapped to a custom list of strings.
  • Field Name: vossCluster.FieldMapping.customListOfStrings3
  • Type: String
  • MaxLength: 1024
Custom List of Strings 4 The CUCM field mapped to a custom list of strings.
  • Field Name: vossCluster.FieldMapping.customListOfStrings4
  • Type: String
  • MaxLength: 1024
Custom List of Strings 5 The CUCM field mapped to a custom list of strings.
  • Field Name: vossCluster.FieldMapping.customListOfStrings5
  • Type: String
  • MaxLength: 1024