[Index]

Model: relation/HcsCustomerEquipmentREL

Customer Equipment

Full HTML Help

Use this procedure to associate customer equipment with the Prime Collaboration application that monitors it.

  1. Log in as customer or site administrator.

  2. Set the hierarchy path to the appropriate site.

  3. Choose Apps Management > Customer Equipment.

  4. Click Add. The following fields appear:

    Note:

    The only required fields are Customer Equipment Name, at least one network address, and one credential if associating Prime Collaboration. Ensure that the network 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.

    Note:

    To unassociate Prime Collaboration for this customer equipment, choose None.

  5. Click Save.

Model Details: relation/HcsCustomerEquipmentREL

Title Description Details
isGateway
  • Field Name: isGateway
  • Type: ["Boolean", "Null"]
isSRST
  • Field Name: isSRST
  • Type: ["Boolean", "Null"]
isCubeEnterprise
  • Field Name: isCubeEnterprise
  • Type: ["Boolean", "Null"]
cluster
  • Field Name: cluster
  • Type: ["String", "Null"]
  • Target: device/hcmf/Cluster
  • Format: uri
cdmUpdateTimestamp
  • Field Name: cdmUpdateTimestamp
  • Type: ["String", "Null"]
id
  • Field Name: id
  • Type: ["String", "Null"]
customerLocation *
  • Field Name: customerLocation
  • Type: String
  • Target: device/hcmf/CustomerLocation
  • Format: uri
monitorsPrimeCollab
  • Field Name: monitorsPrimeCollab
  • Type: ["String", "Null"]
  • Target: device/hcmf/PrimeCollab
  • Format: uri
bkCustomerLocation_shortName
  • Field Name: bkCustomerLocation_shortName
  • Type: ["String", "Null"]
isModifiable
  • Field Name: isModifiable
  • Type: ["Boolean", "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"]
isRouter
  • Field Name: isRouter
  • Type: ["Boolean", "Null"]
type * Default: CustomerEquipment
  • Field Name: type
  • Type: String
  • Default: CustomerEquipment
description
  • Field Name: description
  • Type: ["String", "Null"]
isDeletable
  • Field Name: isDeletable
  • Type: ["Boolean", "Null"]
Clone
  • Field Name: clone
  • Type: Object
description
  • Field Name: clone.description
  • Type: ["String", "Null"]
isDeletable
  • Field Name: clone.isDeletable
  • Type: ["Boolean", "Null"]
isGateway
  • Field Name: clone.isGateway
  • Type: ["Boolean", "Null"]
isSRST
  • Field Name: clone.isSRST
  • Type: ["Boolean", "Null"]
isCubeEnterprise
  • Field Name: clone.isCubeEnterprise
  • Type: ["Boolean", "Null"]
cluster
  • Field Name: clone.cluster
  • Type: ["String", "Null"]
  • Target: device/hcmf/Cluster
  • Format: uri
cdmUpdateTimestamp
  • Field Name: clone.cdmUpdateTimestamp
  • Type: ["String", "Null"]
credentials
  • Field Name: credentials
  • Type: ["Array", "Null"]
password_CommunityString
  • Field Name: clone.credentials.password_CommunityString
  • Type: ["String", "Null"]
  • Is Password: True
description
  • Field Name: clone.credentials.description
  • Type: ["String", "Null"]
userID
  • Field Name: clone.credentials.userID
  • Type: ["String", "Null"]
typeCredential *
  • Field Name: clone.credentials.typeCredential
  • Type: String
  • Choices: ["SNMP_V1", "SNMP_V2", "SNMP_V3", "ADMIN", "PLATFORM", "WMI", "IOS_ENABLE", "HTTP", "CLI", "OPERATOR", "SFTP", "JTAPI"]
isModifiable
  • Field Name: clone.credentials.isModifiable
  • Type: ["Boolean", "Null"]
cdmUpdateTimestamp
  • Field Name: clone.credentials.cdmUpdateTimestamp
  • Type: ["String", "Null"]
typeSNMPAccess Default: RO
  • Field Name: clone.credentials.typeSNMPAccess
  • Type: ["String", "Null"]
  • Default: RO
  • Choices: ["RO", "RW"]
id
  • Field Name: clone.credentials.id
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: clone.credentials.syncTimestamp
  • Type: ["String", "Null"]
isDeletable
  • Field Name: clone.credentials.isDeletable
  • Type: ["Boolean", "Null"]
bkCustomer_shortName
  • Field Name: clone.bkCustomer_shortName
  • Type: ["String", "Null"]
id
  • Field Name: clone.id
  • Type: ["String", "Null"]
isMediaDevice
  • Field Name: clone.isMediaDevice
  • Type: ["Boolean", "Null"]
name *
  • Field Name: clone.name
  • Type: String
monitorsPrimeCollab
  • Field Name: clone.monitorsPrimeCollab
  • Type: ["String", "Null"]
  • Target: device/hcmf/PrimeCollab
  • Format: uri
bkCustomerLocation_shortName
  • Field Name: clone.bkCustomerLocation_shortName
  • Type: ["String", "Null"]
isModifiable
  • Field Name: clone.isModifiable
  • Type: ["Boolean", "Null"]
networkAddresses
  • Field Name: networkAddresses
  • Type: ["Array", "Null"]
domain
  • Field Name: clone.networkAddresses.domain
  • Type: ["String", "Null"]
iPAddrV4
  • Field Name: clone.networkAddresses.iPAddrV4
  • Type: ["String", "Null"]
description
  • Field Name: clone.networkAddresses.description
  • Type: ["String", "Null"]
iPAddrV6
  • Field Name: clone.networkAddresses.iPAddrV6
  • Type: ["String", "Null"]
hostShortNameOnly
  • Field Name: clone.networkAddresses.hostShortNameOnly
  • Type: ["String", "Null"]
isModifiable
  • Field Name: clone.networkAddresses.isModifiable
  • Type: ["Boolean", "Null"]
isSRVAddress *
  • Field Name: clone.networkAddresses.isSRVAddress
  • Type: Boolean
typeAddressSpace *
  • Field Name: clone.networkAddresses.typeAddressSpace
  • Type: String
  • Choices: ["APPLICATION_SPACE", "SERVICE_PROVIDER_SPACE", "CUSTOMER_SPACE"]
cdmUpdateTimestamp
  • Field Name: clone.networkAddresses.cdmUpdateTimestamp
  • Type: ["String", "Null"]
id
  • Field Name: clone.networkAddresses.id
  • Type: ["String", "Null"]
syncTimestamp
  • Field Name: clone.networkAddresses.syncTimestamp
  • Type: ["String", "Null"]
isDeletable
  • Field Name: clone.networkAddresses.isDeletable
  • Type: ["Boolean", "Null"]
cUOM
  • Field Name: clone.cUOM
  • Type: ["String", "Null"]
  • Target: device/hcmf/CUOM
  • Format: uri
customerLocation *
  • Field Name: clone.customerLocation
  • Type: String
  • Target: device/hcmf/CustomerLocation
  • Format: uri
isRouter
  • Field Name: clone.isRouter
  • Type: ["Boolean", "Null"]
type * Default: CustomerEquipment
  • Field Name: clone.type
  • Type: String
  • Default: CustomerEquipment
syncTimestamp
  • Field Name: clone.syncTimestamp
  • 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"]
bkCustomer_shortName
  • Field Name: bkCustomer_shortName
  • Type: ["String", "Null"]
isMediaDevice
  • Field Name: isMediaDevice
  • Type: ["Boolean", "Null"]
name *
  • Field Name: name
  • Type: String
cUOM
  • Field Name: cUOM
  • Type: ["String", "Null"]
  • Target: device/hcmf/CUOM
  • Format: uri
syncTimestamp
  • Field Name: syncTimestamp
  • Type: ["String", "Null"]