[Index]

Model: relation/HcsPresenceREL

CUCM Presence Servers

Full HTML Help

Tip

Use the Action search to navigate Automate

Add a CUCM Presence server

This procedure adds a IM and Presence server (previously, CUP) within a Cisco Unified Communications Manager (Cisco UCM) cluster.

  1. Log in as the appropriate hierarchy administrator.

  2. Set the hierarchy path to the correct level:

  3. Go to the CUCM Presence Servers, then click the Plus icon (+) to add a new server.

  4. Configure Base tab/panel details:

    Note

    Fields available on the tab/panel are assigned via the field display policy. For example, the following options may not be available:

    • Migrate from HCM-F to CUCDM: When checked, indicates a migration of HCM-F Models to CUCDM Models; when unchecked, all new models are created. Default: false
    • Migrate from HCM-F to CUCDM: When checked, indicates a migration of HCM-F Models to CUCDM Models; when unchecked, all new models are created. Default: false
    • Access Type: Either Read-only (RO) or Read/Write (RW). Default is RO.

    1. At CUP Server Name, fill out the name of the UC application instance.

    2. At Publisher, define whether the UC application instance is a publisher. When unchecked, this is a subscriber.

      When enabled (checked), the Publisher tab/panel displays, where you can select the version of the CUPs within the cluster.

    3. At Cluster Name:

      • If Publisher is enabled, fill out the name of the UCM cluster for the publisher.
      • If Publisher is not checked, select the UCM cluster under which the subscriber is managed.

    4. Configure Network Addresses:

      • Address Space: Select SERVICE_PROVIDER_SPACE address space.

      • Hostname: Fill out the hostname of the UC application instance.

      • IPv4 Address: Fill out the IPv4 address of the UC application instance.

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

      • Domain: Fill out the network domain of the UC application instance.

      • Description: Fill out an optional description of the network address.

      • If NAT is used, repeat these steps to also configure an APPLICATION_SPACE network address.

    5. Add credentials for credential type ADMIN.

      ADMIN is required for Service Inventory to generate reports for UC applications.

      Other credential types are SNMP_V1, SNMP_V2, SNMP_V3, PLATFORM, WMI, IOS_ENABLE, HTTP, CLI, OPERATOR, SFTP, JTAPI

      • User ID / Password: Mandatory. Fill out the user ID and password associated with this credential.

        User ID and password were configured when the IM and Presence Service was installed. If Credential Type is SNMP_V1 or SNMP_V2, the Password represents the SNMP community string.

      • Provide an optional description for the credential.

    6. Click the Plus icon (+) to add more credentials.

  5. Configure Publisher tab/panel details:

    1. Version: The version of the CUPs within the cluster.
    2. Multi-Tenant: Defines whether the cluster applications are dedicated to a customer or shared across multiple customers

Multi-cluster or single cluster configurations

Tip

Use the Action search to navigate Automate

Previously, IM and Presence service (CUP) was set up in a multi-cluster configuration (separate from the CUCM cluster). However, the IM and Presence Service servers are set up as part of the UCM cluster itself in a single-cluster configuration.

Advantages of a single-cluster configuration

A single cluster configuration is recommended. Service providers are encouraged to use a single cluster configuration for any new clusters.

Advantages:

Hierarchy considerations for migrating CUP nodes

Migrating CUP nodes to a UCM cluster is hierarchy-specific. A Customer CUP node can only be migrated to a Customer UCM cluster (not to a Provider or Reseller cluster).

A Publisher IM_P node is added first, then Subscriber nodes.

Migration conditions

The following conditions apply when migrating your CUP to a UCM cluster:

Deprecation of multi-cluster configurations

Multi-cluster configurations are deprecated and strongly discouraged. However, VOSS continues to support multi-cluster configurations for backward compatibility and upgrades.

Migrate CUP nodes from multi-cluster to single cluster configuration

This procedure migrates your IM and Presence Service (CUP) nodes from an existing multi-cluster configuration to a UCM single-cluster configuration (recommended).

  1. Log in to the VOSS UI as Provider, Reseller, or Customer admin, depending on the hierarchy where the CUP cluster was configured.

  2. Set the hierarchy path to the hierarchy node where the CUP cluster was configured.

    Choose an option:

    • Shared configuration: Set the hierarchy to Provider or Reseller node.
    • Dedicated configuration: Set the hierarchy to a Customer node.

  3. Go to (CUP - deprecated) Migrate CUP to CUCM Cluster.

  4. At From CUP Cluster, select the CUP cluster to migrate.

  5. At To CUCM Cluster, select the UCM cluster to which you want to migrate the CUP cluster.

  6. Save your changes.

    • The migrated CUP server is removed from the (CUP) Servers list, and displays instead on the (UCM) Servers list as server type, IM_P.
    • The cluster name for the migrated servers is now the same as the UCM cluster name.

Model Details: relation/HcsPresenceREL

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
CUP Cluster *
  • Field Name: cUPCluster
  • Type: String
  • Target: data/HCSHcmfCUPClusterDAT
  • 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: bkCUPCluster_name
  • Type: String
  • Target: data/HCSHcmfCUPClusterDAT
  • 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 Cluster
  • Field Name: vossCluster
  • Type: Object
Name * The (unique) name of the CUP cluster.
  • Field Name: vossCluster.name
  • Type: String
  • Target: data/HCSHcmfCUPClusterDAT
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Version Indicates the version of the CUPs 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 CUP
  • 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"]