Cisco Unified Contact Center Enterprise Developer Reference Release 10.0(x)
Deployment Type Info API
Downloads: This chapterpdf (PDF - 1.09MB) The complete bookPDF (PDF - 2.25MB) | The complete bookePub (ePub - 145.0KB) | The complete bookMobi (Mobi - 238.0KB) | Feedback

Deployment Type Info API

Deployment Type Info API

Use the Deployment Type Info API to view or edit the current system deployment type.

URL

https://<server>/unifiedconfig/config/deploymenttypeinfo

Operations

  • get: Returns the current deployment type and the results of the capacity and system validation tests, using the URL https://<server>/unifiedconfig/config/deploymenttypeinfo.
  • update: Sets the specified deployment type if the system validation check, capacity check, and VM Validation for that deployment type pass and are required.

Parameters

  • changeStamp: See Shared Parameters.
  • vmHosts: vmHost information, including name, address, username, and password parameters of Side A and Side B. Only required when switching to Packaged CCE, to allow access to the ESX servers for VM validation.
  • permissionInfo: See Permissions.
  • systemValidationStatus: A collection of validationRules that show the potential errors regarding system configuration. Each rule contains the following parameters:
    • name: The name of the rule.
    • isValid: Indicates if the rule is passing. Values are true/false.
    • min: The minimum number of items required to match for this rule.
    • max: The maximum number of items required to match for this rule.
    • actual: The current number of items configured that match this rule.
  • capacityInfo: A collection of capacityRules indicating if the capacity limits are valid. Each rule contains the following parameters:
    • name: The name of the capacity rule.
    • max: The maximum number of items allowed for the rule.
    • actual: The current number of items configured for the rule.
  • vmValidationLogURL: The URL to download a file about VM layout validation.
  • deploymentType: The type of deployment. The following types are supported:
    • 0: No deployment type specified. Initial type set at installation. Once set to another deployment type, you cannot switch back to 0.
    • 1: NAM
    • 2: IVR-ICM
    • 3: NAM Rogger
    • 4: ICM Router/Logger
    • 5: UCCE 8000 Agents Router/Logger
    • 6: UCCE 12000 Agents Router/Logger
    • 7: Packaged CCE: CCE-PAC-M1
    • 8: ICM Rogger
    • 9: UCCE 4000 Agents Rogger
    • 10: Packaged CCE: CCEPACM1 Lab only
    • 11: HCS-CC 1000 Agents
    • 12: HCS-CC 500 Agents
    • 13: UCCE 450 Agents Progger
    • 14: HCS-CC 4000 Agents

Example Get Response

<deploymentTypeInfo>
  <changeStamp>59</changeStamp>
  <deploymentType>7</deploymentType>
  <vmHosts>
    <vmHost>
      <name>sideA</name>
      <address>10.86.141.10</address>
      <userName>root</userName>
    </vmHost>
    <vmHost>
      <name>sideB</name>
      <address>10.86.141.29</address>
      <userName>root</userName>
      <password>pwexample</password>
    </vmHost>
  </vmHosts>
</deploymentTypeInfo>