[Index]

Model: relation/HcsPresenceREL

Model Details

Title Description Details
CUP Server Name *
  • Field Name: name
  • Type: String
virtualMachine
  • Field Name: virtualMachine
  • Type: ["String", "Null"]
  • Target: device/hcmf/VirtualMachine
  • Format: uri
cUPCluster *
  • Field Name: cUPCluster
  • Type: String
  • Target: device/hcmf/CUPCluster
  • Format: uri
Voss Cluster
  • Field Name: vossCluster
  • Type: Object
Name * The (unique) name of the CUP cluster.
  • Field Name: vossCluster.name
  • Type: String
  • Target: device/hcmf/CUPCluster
  • 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"]
description
  • Field Name: description
  • Type: ["String", "Null"]
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"]
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
typeCucmCupSharingMode Default: DEDICATED
  • Field Name: sdrCluster.typeCucmCupSharingMode
  • Type: ["String", "Null"]
  • Default: DEDICATED
  • Choices: ["DEDICATED", "SHARED"]
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
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: CUPCluster
  • Field Name: sdrCluster.type
  • Type: String
  • Default: CUPCluster
email
  • Field Name: sdrCluster.email
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: sdrCluster.syncTimestamp
  • Type: ["String", "Null"]
routingId
  • Field Name: routingId
  • Type: ["String", "Null"]
isUCPublisher
  • Field Name: isUCPublisher
  • Type: ["Boolean", "Null"]
isModifiable
  • Field Name: isModifiable
  • Type: ["Boolean", "Null"]
cdmUpdateTimestamp
  • Field Name: cdmUpdateTimestamp
  • Type: ["String", "Null"]
Cluster Name
  • Field Name: bkCUPCluster_name
  • Type: ["String", "Null"]
credentials
  • Field Name: credentials
  • Type: ["Array", "Null"]
password_CommunityString
  • Field Name: credentials.password_CommunityString
  • Type: ["String", "Null"]
  • Is Password: True
  • Store Encrypted: 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
type * Default: CUP
  • Field Name: type
  • Type: String
  • Default: CUP
id
  • Field Name: id
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: syncTimestamp
  • Type: ["String", "Null"]
isDeletable
  • Field Name: isDeletable
  • Type: ["Boolean", "Null"]
API reference for relation/HcsPresenceREL