[Index]

Model: relation/HcsCerVirtualREL

CER Servers

Complete this procedure at any time to configure Cisco Emergency Responder (CER) on VOSS-4-UC. For more information on CER installation and setup, refer to the Cisco Emergency Responder Administration Guide.

Note

References to HCM-F and Shared Data Repository (SDR) are only relevant if installed.

Procedure

  1. Log in as the appropriate hierarchy administrator.

  2. Set the hierarchy path to the correct level. Shared instances are created at the provider, reseller, or customer level. Dedicated instances are created at the customer level.

  3. Choose Device Management > CER > Servers.

  4. Perform one of the following:

  5. Enter a name for the Cisco Emergency Responder in the CER_Virtual Server Name field.

    Note:

    A Cisco Emergency Responder 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 will be 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.

  7. Expand Network Addresses.

    1. Choose the SERVICE_PROVIDER_SPACE address space.

    2. Enter the IP address of the CER 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.

    3. The Hostname field is automatically populated with the CER Name. Edit it if necessary.

    4. Fill in the domain of the CER application.

    5. Provide an optional description for the network address.

  8. Expand Credentials.

    1. Add credentials for PLATFORM and ADMIN credential types. Click + to add more credentials.
    2. Fill in the user ID and password that you configured when you installed the CER.
    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.

    PLATFORM and ADMIN are required for license management.

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

Field Description
Version Select the version of the Cisco Emergency Responder Servers in this cluster. The available versions depend on the version of the HCM-F device that has been configured.
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.
  1. Click Save.

What to Do Next

Associate CER with Customers

Model Details

Title Description Details
description
  • Field Name: description
  • Type: ["String", "Null"]
virtualMachine
  • Field Name: virtualMachine
  • Type: ["String", "Null"]
  • Target: device/hcmf/VirtualMachine
  • Format: uri
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"]
Voss Cluster
  • Field Name: vossCluster
  • Type: Object
Name * The (unique) name of the CER_Virtual cluster.
  • Field Name: vossCluster.name
  • Type: String
  • Target: device/hcmf/CER_Cluster_Virtual
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Version Indicates the version of the CER_Virtuals 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 CER_Virtual
  • 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"]
Customers
  • Field Name: customers.[n]
  • Type: Array
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
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
typeCerSharingMode Default: DEDICATED
  • Field Name: sdrCluster.typeCerSharingMode
  • Type: ["String", "Null"]
  • Default: DEDICATED
  • Choices: ["DEDICATED", "SHARED"]
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: CER_Cluster_Virtual
  • Field Name: sdrCluster.type
  • Type: String
  • Default: CER_Cluster_Virtual
email
  • Field Name: sdrCluster.email
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: sdrCluster.syncTimestamp
  • Type: ["String", "Null"]
isModifiable
  • Field Name: isModifiable
  • Type: ["Boolean", "Null"]
name *
  • Field Name: name
  • Type: String
routingId
  • Field Name: routingId
  • Type: ["String", "Null"]
isUCPublisher
  • Field Name: isUCPublisher
  • Type: ["Boolean", "Null"]
cER_Cluster_Virtual *
  • Field Name: cER_Cluster_Virtual
  • Type: String
  • Target: device/hcmf/CER_Cluster_Virtual
  • Format: uri
cdmUpdateTimestamp
  • Field Name: cdmUpdateTimestamp
  • Type: ["String", "Null"]
credentials
  • Field Name: credentials
  • Type: ["Array", "Null"]
password_CommunityString
  • Field Name: credentials.password_CommunityString
  • Type: ["String", "Null"]
  • Is Password: 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: CER_Virtual
  • Field Name: type
  • Type: String
  • Default: CER_Virtual
id
  • Field Name: id
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: syncTimestamp
  • Type: ["String", "Null"]
bkCER_Cluster_Virtual_name
  • Field Name: bkCER_Cluster_Virtual_name
  • Type: ["String", "Null"]
API reference for relation/HcsCerVirtualREL