[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
id
  • Field Name: id
  • Type: String
  • MaxLength: 1024
Name *
  • Field Name: name
  • Type: String
  • MaxLength: 128
Is Router
  • Field Name: isRouter
  • Type: Boolean
Is Gateway
  • Field Name: isGateway
  • Type: Boolean
Is SRST
  • Field Name: isSRST
  • Type: Boolean
Is Media Device
  • Field Name: isMediaDevice
  • Type: Boolean
Is Cube Enterprise
  • Field Name: isCubeEnterprise
  • Type: Boolean
Description
  • Field Name: description
  • Type: String
  • MaxLength: 152
CUOM
  • Field Name: cUOM
  • Type: String
  • Target: data/HCSHcmfCUOMDAT
  • MaxLength: 1024
  • Format: uri
Cluster
  • Field Name: cluster
  • Type: String
  • Target: data/HCSHcmfClusterDAT
  • MaxLength: 1024
  • Format: uri
Customer Location *
  • Field Name: customerLocation
  • Type: String
  • Target: data/HCSHcmfCustomerLocationDAT
  • MaxLength: 1024
  • Format: uri
Monitors Prime Collab
  • Field Name: monitorsPrimeCollab
  • Type: String
  • Target: data/HCSHcmfPrimeCollabDAT
  • 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
Bk Customer Short Name
  • Field Name: bkCustomer_shortName
  • Type: String
  • Target: data/HCSHcmfCustomerDAT
  • Target attr: shortName
  • MaxLength: 1024
  • Format: uri
Bk Customer Location Short Name
  • Field Name: bkCustomerLocation_shortName
  • Type: String
  • Target: data/HCSHcmfCustomerLocationDAT
  • Target attr: shortName
  • MaxLength: 1024
  • Format: uri
Clone
  • Field Name: clone
  • Type: Object
id
  • Field Name: clone.id
  • Type: String
  • MaxLength: 1024
Name *
  • Field Name: clone.name
  • Type: String
  • MaxLength: 128
Is Router
  • Field Name: clone.isRouter
  • Type: Boolean
Is Gateway
  • Field Name: clone.isGateway
  • Type: Boolean
Is SRST
  • Field Name: clone.isSRST
  • Type: Boolean
Is Media Device
  • Field Name: clone.isMediaDevice
  • Type: Boolean
Is Cube Enterprise
  • Field Name: clone.isCubeEnterprise
  • Type: Boolean
Description
  • Field Name: clone.description
  • Type: String
  • MaxLength: 152
CUOM
  • Field Name: clone.cUOM
  • Type: String
  • Target: data/HCSHcmfCUOMDAT
  • MaxLength: 1024
  • Format: uri
Cluster
  • Field Name: clone.cluster
  • Type: String
  • Target: data/HCSHcmfClusterDAT
  • MaxLength: 1024
  • Format: uri
Customer Location *
  • Field Name: clone.customerLocation
  • Type: String
  • Target: data/HCSHcmfCustomerLocationDAT
  • MaxLength: 1024
  • Format: uri
Monitors Prime Collab
  • Field Name: clone.monitorsPrimeCollab
  • Type: String
  • Target: data/HCSHcmfPrimeCollabDAT
  • MaxLength: 1024
  • Format: uri
Credentials
  • Field Name: credentials.[n]
  • Type: Array
Description
  • Field Name: clone.credentials.[n].description
  • Type: String
  • MaxLength: 128
Type Credential *
  • Field Name: clone.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: clone.credentials.[n].userID
  • Type: String
  • MaxLength: 256
Password Community String
  • Field Name: clone.credentials.[n].password_CommunityString
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 512
Type SNMP Access Default: RO
  • Field Name: clone.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: clone.networkAddresses.[n].typeAddressSpace
  • Type: String
  • MaxLength: 1024
  • Choices: ["APPLICATION_SPACE", "SERVICE_PROVIDER_SPACE", "CUSTOMER_SPACE"]
Description
  • Field Name: clone.networkAddresses.[n].description
  • Type: String
  • MaxLength: 128
IP Addr V4
  • Field Name: clone.networkAddresses.[n].iPAddrV4
  • Type: String
  • MaxLength: 64
IP Addr V6
  • Field Name: clone.networkAddresses.[n].iPAddrV6
  • Type: String
  • MaxLength: 64
Host Short Name Only
  • Field Name: clone.networkAddresses.[n].hostShortNameOnly
  • Type: String
  • MaxLength: 128
Domain
  • Field Name: clone.networkAddresses.[n].domain
  • Type: String
  • MaxLength: 128
Is SRV Address *
  • Field Name: clone.networkAddresses.[n].isSRVAddress
  • Type: Boolean
Bk Customer Short Name
  • Field Name: clone.bkCustomer_shortName
  • Type: String
  • Target: data/HCSHcmfCustomerDAT
  • Target attr: shortName
  • MaxLength: 1024
  • Format: uri
Bk Customer Location Short Name
  • Field Name: clone.bkCustomerLocation_shortName
  • Type: String
  • Target: data/HCSHcmfCustomerLocationDAT
  • Target attr: shortName
  • MaxLength: 1024
  • Format: uri