REST Data Access Objects

This section describes the following Data Access Objects (DAO) for the Capacity-Aware Placement Advice REST web service:

Request objects

The following sections describe request objects part of the Capacity-Aware Placement Advice REST web service.

hostPlacementInput

Description: It contains input information for placement of virtual hosts.
XML sample:

<?xml version="1.0" encoding="UTF-8"?>
<placementInput placementAlgorithm="Type2">
                <candidateList>
                <candidate coId="candidate" type="CUSTOM_TEMPLATE">
                         <candidateLookupInfo clusterName=""
                          externalId="" hostName="" hostUuid=""
                          instanceIds="1" managementCenterName=""
                          vmName=""/>
                                   <candidateResourceDemands c
                                    puCoreClockFreq="0.0" cpuUtil="300.0"
                                    cpuUtilPerc="0.8" diskSize="100"
                                    diskUtil="10.0" diskUtilPerc="0.0"
                                    memSize="100" memUtil="1.0"
                                    memUtilPerc="0.0" netNicNum="10"
                                    netUtil="10.0" vCpuNum="1"/>
                          </candidate>
                </candidateList>
                    <targetList>
                  <target type="EXISTING" coId="">
                         <targetLookupInfo>
                                  <coLookupField lookupField="guid"
                                   lookupValue=
                                   "e958cbbc-fc44-4f64-9e28-c9d3f112b19e"/>
                         </targetLookupInfo>
                   </target>
                   <target type="EXISTING" coId="">
                         <targetLookupInfo>
                                  <coLookupField lookupField="guid"
                                   lookupValue=
                                   "ec9f7f59-7291-4fed-94c3-5dc421d8077d"/>
                         </targetLookupInfo>
                   </target>
                   <target type="EXISTING" coId="">
                         <targetLookupInfo>
                                  <coLookupField lookupField="guid"
                                   lookupValue=
                                   "95f68d50-45e2-4de3-b053-d7616c48ef31"/>
                         </targetLookupInfo>
                   </target>
             </targetList>
                <affinityTransactionId>1</affinityTransactionId>
                <type>Host</type>
</placementInput>

clusterPlacementInput

Description: It contains input information for placement on virtual clusters.
XML sample:

<?xml version="1.0" encoding="UTF-8"?>
<placementInput placementAlgorithm="Type2">
                <candidateList>
                <candidate coId="candidate" type="CUSTOM_TEMPLATE">
                         <candidateLookupInfo clusterName=""
                          externalId="" hostName="" hostUuid=""
                          instanceIds="1" managementCenterName=""
                                          vmName=""/>
                                   <candidateResourceDemands
                                    cpuCoreClockFreq="0.0"
                                    cpuUtil="300.0"
                                    cpuUtilPerc="0.8" diskSize="100"
                                    diskUtil="10.0" diskUtilPerc="0.0"
                                    memSize="100"
                                    memUtil="1.0" memUtilPerc="0.0"
                                    netNicNum="10"
                                    netUtil="10.0" vCpuNum="1"/>
                          </candidate>
                </candidateList>
                    <targetList>
                  <target type="EXISTING" coId="">
                         <targetLookupInfo>
                                  <coLookupField lookupField="guid"
                                   lookupValue=
                                   "a0931952-1ab9-4817-b67f-01dc4e4b52d7"/>
                         </targetLookupInfo>
                   </target>
             </targetList>
                <affinityTransactionId>2</affinityTransactionId>
                <type>Cluster</type>
</placementInput>

resourcePoolPlacementInput

Description: It contains input information for placement on virtual resource pools.
XML sample:

<?xml version="1.0" encoding="UTF-8"?>
<placementInput placementAlgorithm="Type1">
                <candidateList>
                <candidate coId="candidate" type="CUSTOM_TEMPLATE">
                         <candidateLookupInfo clusterName="" externalId=""
                          hostName="" hostUuid="" instanceIds=
                          "1" managementCenterName="" vmName=""/>
                                   <candidateResourceDemands
                                    cpuCoreClockFreq="0.0"
                                    cpuUtil="300.0"
                                    cpuUtilPerc="0.8" diskSize="100"
                                    diskUtil="10.0" diskUtilPerc="0.0"
                                    memSize="100"
                                    memUtil="1.0" memUtilPerc="0.0"
                                    netNicNum="10"
                                    netUtil="10.0" vCpuNum="1"/>
                          </candidate>
                </candidateList>
                    <targetList>
                  <target type="EXISTING" coId="">
                         <targetLookupInfo>
                                  <coLookupField lookupField="guid"
                                   lookupValue=
                                   "671d305f-77dc-4558-8c09-b3608648ad58"/>
                         </targetLookupInfo>
                   </target>
                   <target type="EXISTING" coId="">
                         <targetLookupInfo>
                                  <coLookupField lookupField="guid" lookupValue=
                                   "b9a5265b-989e-4ffe-aa91-8f30d415db2f"/>
                         </targetLookupInfo>
                   </target>
                   <target type="EXISTING" coId="">
                         <targetLookupInfo>
                                  <coLookupField lookupField=
                                   "guid" lookupValue=
                                   "d92b9df4-dabc-4aef-8b51-4678e793a2ba"/>
                         </targetLookupInfo>
                   </target>
             </targetList>
                <affinityTransactionId>3</affinityTransactionId>
                <type>ResourcePool</type>
</placementInput>

computePoolPlacementInput

Description: It contains input information for placement on Compute Pools.
XML sample:

<?xml version="1.0" encoding="UTF-8"?>
<placementInput placementAlgorithm="Type1">
                <candidateList>
                <candidate coId="candidate" type="CUSTOM_TEMPLATE">
                         <candidateLookupInfo clusterName="" externalId=""
                          hostName="" hostUuid="" instanceIds="1"
                          managementCenterName="" vmName=""/>
                                   <candidateResourceDemands
                          cpuCoreClockFreq="0.0" cpuUtil="300.0" cpuUtilPerc="0.8"
                          diskSize="100" diskUtil="10.0" diskUtilPerc="0.0"
                          memSize="100" memUtil="1.0" memUtilPerc="0.0"
                          netNicNum="10" netUtil="10.0" vCpuNum="1"/>
                          </candidate>
                </candidateList>
                    <targetList>
                  <target type="EXISTING" coId="">
                         <targetLookupInfo>
                                  <coLookupField lookupField="guid" lookupValue=
                                   "671d305f-77dc-4558-8c09-b3608648ad58"/>
                         </targetLookupInfo>
                   </target>
                   <target type="EXISTING" coId="">
                         <targetLookupInfo>
                                  <coLookupField lookupField="guid" lookupValue=
                                   "b9a5265b-989e-4ffe-aa91-8f30d415db2f"/>
                         </targetLookupInfo>
                   </target>
                   <target type="EXISTING" coId="">
                         <targetLookupInfo>
                                  <coLookupField lookupField="guid" lookupValue=
                                   "d92b9df4-dabc-4aef-8b51-4678e793a2ba"/>
                         </targetLookupInfo>
                   </target>
             </targetList>
                <affinityTransactionId>4</affinityTransactionId>
                <type>ComputePool</type>
</placementInput>

scenarioIdsInput

Description: It contains input properties to lookup BMC TrueSight Capacity Optimization scenarios.
XML sample:

<?xml version="1.0" encoding="UTF-8"?>
<scenarioIdsInput>
                <propertiesList>
                                <propertyValue>model.cloudid=
                                 Cloud_vw-pun-bcm-dv09</propertyValue>
                </propertiesList>
</scenarioIdsInput>

candidateTemplateInfo

Description: It contains information to manage candidate templates
XML sample:

<?xml
version="1.0" encoding="UTF-8"?>
<candidateTemplateInfo templateName="Placement_Advice_Candidate_Template">
		<resources cpuCoreClockFreq="100.0" cpuUtil="10.0"
                 cpuUtilPerc="0.1" vcpuNum="1"
		diskSize="100" diskUtil="10.0" diskUtilPerc="0.1"
                memSize="50" memUtil="10.0" memUtilPerc="0.5"
               netNicNum="1" netUtil="100.0" netUtilPerc="1"
               xsi:type="genericResource" />
</candidateTemplateInfo>

targetTemplateInfo

Description: It contains information on managing the target.
XML sample:

<?xml version="1.0" encoding="UTF-8"?>
<targetTemplateInfo templateName="Placement_Advice_Target_Template">
		<resources cpuCoreClockFreq="100.0" cpuUtil="10.0"
                 cpuUtilPerc="0.1" vcpuNum="1" diskSize="100" diskUtil="10.0"
                 diskUtilPerc="0.1"
                memSize="50" memUtil="10.0" memUtilPerc="0.5"
                netNicNum="1" netUtil="100.0" netUtilPerc="1"
                xsi:type="genericResource" />
</targetTemplateInfo>

candidateLookupInfo

Description: It contains information on candidate lookup.
XML sample:

<?xml version="1.0" encoding="UTF-8"?>
<candidateLookupInfo externalId="" hostUuid=""
	instanceIds="" managementCenterName="" networkClusterName=""
	networkHostName="" networkResourcePoolName=""
        vmName="Placement_Advice_dummy_candidate">
	<coLookupField lookupField="" lookupValue="" />
</candidateLookupInfo>

targetLookupInfo

Description: It contains information on target lookup.
XML sample:

<?xml version="1.0" encoding="UTF-8"?>
<targetLookupInfo externalId="" hostUuid=""
	managementCenterName="" networkClusterName=""
networkHostName="Placement_Advice_dummy_target"
	networkResourcePoolName="">
	<coLookupField lookupField="" lookupValue="" />
</targetLookupInfo>

machinesInput

Description: It contains a list of machines identifiers.
XML sample:

<?xml version="1.0" encoding="UTF-8"?>
<placementAdviceInputMachines>
	<machineIds>
		<machineId>123456</machineId>
	</machineIds>
</placementAdviceInputMachines>

scenarioInput

Description: It contains input information for BMC TrueSight Capacity Optimization scenarios management.
XML sample:

<?xml version="1.0" encoding="UTF-8"?>
<scenarioInput modelName=
"Placement Advice model" scenarioName="Placement Advice Scenario">
  <options>
    <lastex>H48+</lastex>
<hostThresholdsList>
      <hostThreshold resource="cpu" value="95.0"/>
      <hostThreshold resource="memory" value="100.0"/>
      <hostThreshold resource="network" value="100.0"/>
      <hostThreshold resource="disk" value="100.0"/>
    </hostThresholdsList>
    <clusterThresholdsList>
     <clusterThreshold resource="cpu" value="85.0"/>
     <clusterThreshold resource="memory" value="90.0"/>
     <clusterThreshold resource="network" value="90.0"/>
     <clusterThreshold resource="disk" value="90.0"/>
    </clusterThresholdsList>
    <candidateDefaultUtilizationsList>
      <candidateDefaultUtilization resource="cpu" value="33.0"/>
      <candidateDefaultUtilization resource="memory" value="33.0"/>
      <candidateDefaultUtilization resource="network" value="20.0"/>
      <candidateDefaultUtilization resource="disk" value="20.0"/>
    </candidateDefaultUtilizationsList>
    <targetDefaultUtilizationsList>
      <targetDefaultUtilization resource="cpu" value="50.0"/>
      <targetDefaultUtilization resource="memory" value="50.0"/>
      <targetDefaultUtilization resource="network" value="50.0"/>
      <targetDefaultUtilization resource="disk" value="50.0"/>
    </targetDefaultUtilizationsList>
  </options>
  <modelProperties>
    <property>modelTag=PaTestUpdated</property>
  </modelProperties>
</scenarioInput>

placementInput

Description: It contains input information for datastore placement in BMC TrueSight Capacity Optimization.
XML sample:

<placementInput>
    <affinityComputeContainerId>3e6a0351-24b6-4c55-b15a-9a8dcba7b779</affinityComputeContainerId>
    <candidateList>
    <candidate type="CUSTOM_TEMPLATE" coId="candidate">
    <candidateLookupInfo instanceIds="CSM_compute_container"/>
    <candidateResourceDemands vcpuNum="1.0" memSize="1.073741824E9"/>
    </candidate>
    </candidateList>
    <targetList>
    <target type="EXISTING" coId="">
    <targetLookupInfo datastoreName="DELL-Storage-VD0">
    <coLookupField lookupValue="3bc86569-3115-4b5d-8bb7-1493bf3c7cb0" lookupField="GUID"/>
    </targetLookupInfo>
    </target>
    <target type="EXISTING" coId="">
    <targetLookupInfo datastoreName="DELL-Storage-VD2">
    <coLookupField lookupValue="998da2ef-3a61-4dbb-af90-712472a2e1b5" lookupField="GUID"/>
    </targetLookupInfo>
    </target>
    </targetList>
    <affinityTransactionId>1250de1e-e461-422c-8cac-c25145d6b42d</affinityTransactionId>
    <type>Datastore</type>
    </placementInput>

Response objects

Name

Object fields

placementOutput

  • List<PlacementInfo> placementsList: A list of placements, each of which is constituted of a candidate - target information couple. This might be empty in case no placement can be performed by the service.
  • List<ExitStatus>exitStatusList: An exit status list that contains the code for each error or warning that occurrs during execution. This might be empty if no errors or warnings have been encountered.

scenarioIdsOutput

  • List<String> scenarioIdsList: List of BMC TrueSight Capacity Optimization scenario identifiers which match a set of input properties.
  • List<ExitStatus> exitStatus: List of returned ExitStatus (if any)

managementOutput

  • String Id: BMC TrueSight Capacity Optimization identifier for managed objects.
  • List<ExitStatus> exitStatus: List of returned ExitStatus (if any)

candidateManagementOutput

  • CandidateInfo candidateInfo: Candidate information
  • List<ExitStatus> exitStatus: List of returned ExitStatus (if any)

targetManagementOutput

  • TargetInfo targetInfo: Target information
  • List<ExitStatus> exitStatus: List of returned ExitStatus (if any)

scenarioStatusOutput

  • String name: The scenario name
  • String scenarioId: The BMC TrueSight Capacity Optimization Scenario identifier
  • String modelName: The model name which scenario refers to.
  • String description: A description for the scenario
  • List<CandidateStatusInfo> candidates: Information on candidates contained in the scenario
  • List<TargetStatusInfo> targets: Information on targets contained in the scenario
  • String candidateData: Data related to scenario candidates presented in a tabular form
  • String targetData: Data related to scenario targets presented in a tabular form
  • List<String> properties: List of scenario properties (each of which is of the form "propertyName=property_value")

serviceStatusOutput

  • List<String> details: A list containing all statistics of last 5-minutes period
  • List<String> extendedDetails: A list containing all available statistics of complete 5-minutes periods

Artifacts

Name

Object fields

PlacementInfo

  • CandidateInfo candidateInfo: Contains information on the candidate
  • TargetInfo targetInfo: Contains information on the target

CandidateInfo

  • String coId: BMC TrueSight Capacity Optimization candidate identifier
  • String type: Candidate type (existing, template, custom template)
  • CandidateLookupInfo candidateLookupInfo: Information used to lookup candidates
  • CandidateResourceDemands candidateResourceDemands: Demands for candidate resources

TargetInfo

  • String coId: BMC TrueSight Capacity Optimization target identifier
  • String type: Target type (existing, template)
  • TargetLookupInfo targetLookupInfo: Information used to lookup targets

CandidateResourceDemands

Extends the GenericResource object with no additional fields

TargetResourceDemands

Extends the GenericResource object with no additional fields

GenericResource

  • double cpuCoreClockFreq: CPU core clock frequency
  • double cpuUtil: CPU utilization (in MHz)
  • double cpuUtilPerc: Percentage CPU utilization (ranging between 0 and 1)
  • int vcpuNum: Number of virtual CPUs
  • int diskSize: Disk size (in Bytes)
  • double diskUtil: Disk utilization (in MBytes/s)
  • double diskUtilPerc: Percentage disk utilization (ranging between 0 and 1)
  • int memSize: Memory size (in MBytes)
  • double memUtil: Memory utilization (in MBytes)
  • double memUtilPerc: Percentage memory utilization (ranging between 0 and 1)
  • int netNicNum: Number of network interfaces
  • double netUtil: Network utilization (in Mbit/s)
  • double netUtilPerc: Percentage network utilization (ranging between 0 and 1)

CandidateLookupInfo

  • String networkClusterName: Network cluster name
  • String networkHostName: Network host name
  • String networkResourcePoolName: Network resource pool name
  • String hostUuid: Uuid value for host
  • String instanceIds: Comma separated list of instance identifiers for custom template candidates
  • String managementCenterName: Management center name
  • String vmName: VM name
  • String externalId: A field which can freely be filled by the user to carry information
  • List<CoLookupField> coLookupField: List of fields used to lookup candidate

TargetLookupInfo

  • String networkClusterName: Network cluster name
  • String networkHostName: Network host name
  • String networkResourcePoolName: Network resource pool name
  • String hostUuid: UUID value for host
  • String managementCenterName: Management center name
  • String externalId: A field which can freely be filled by the user to carry information
  • List<CoLookupField> coLookupField: List of fields used to lookup target

CandidateStatusInfo

  • String coId: BMC TrueSight Capacity Optimization candidate identifier
  • String machineType: Type of candidate machine (for example, "Virtual Machine")
  • boolean template: True if candidate is a template, false if it is an existing one
  • int numberOfInstances: Number of candidate instances (it is greater than zero if candidate is a template)

TargetStatusInfo

  • String coId: BMC TrueSight Capacity Optimization target identifier
  • String machineType: Type of target machine (for example, "Host", "Cluster", "Resource Pool" ...)
  • String clusterCoId: BMC TrueSight Capacity Optimization identifier for cluster which contains target (if any)
  • boolean template: True if target is a template, false if it is an existing one
  • int numberOfInstances: Number of target instances (it is greater than zero if target is a template)

TemplateInfo

  • String templateName: The name of the template
  • GenericResource resources: Resources Values for the template

CoLookupField

  • String lookupField: Name of the field used to lookup
  • String looukpValue: Value of the lookup field

ExitStatus

  • String exitCode: Exit (Failure, Error or Warning) Code
  • String description: Description of the return exit status
  • CandidateLookupInfo candidateLookupInfo: Lookup information for candidate (if any)
  • TargetLookupInfo targetLookupInfo: Lookup information for target(if any)

ScenarioOptions

  • List<ScenarioCandidateDefaultUtilization> scenarioCandidateDefaultUtilizations: Default utilization values for candidates
  • List<ScenarioTargetDefaultUtilization> scenarioTargetDefaultUtilizations: Default utilization values for targets
  • List<ScenarioThreshold> scenarioThresholds: Scenario hosts resource thresholds
  • List<ScenarioClusterThreshold> scenarioClusterThreshold: Scenario clusters resource thresholds
  • String globalFilterId: Global time filter identifier for the scenario
  • String lastex: It contains information on the time filter backward period (for example, H24+ stands for "last 24 hours")
  • Date sinceDate: Start date for time filter
  • Date toDate: End date for time filter
    Note that only one of globalFilterId, lastex and sinceDate/toDate couple should be set for a single scenario

ScenarioCandidateDefaultUtilization

  • String resource: The resource name with which the default value is associated.
  • double value: Default utilization value

ScenarioTargetDefaultUtilization

  • String resource: The resource name with which the value is associated.
  • double value: Default utilization value

ScenarioThreshold

  • String resource: The resource threshold with which the default value is associated.
  • double value: Threshold value

ScenarioClusterThreshold

  • String resource: The resource threshold with which the value is associated.
  • double value: Threshold value
Was this page helpful? Yes No Submitting... Thank you

Comments