BlockModelRMO::Query Resource Capacity Data

Returns the resource capacity data for a resource instance. Used by Microsoft Provisioning Framework (MPF).

The following table describes the XML schema elements and attributes. Unless otherwise indicated, the data type is string.

Element	Description, relationships, and attributes
actualFree	Description: Minimum value allowed for actual free capacity. Parent: capacityData
actualMax	Description: Actual maximum capacity for the resource instance. Parent: capacityData
executeData	Description: Encapsulates the procedure's input data. Children: resourceInstance (minOccurs="1" maxOccurs="1", input only) capacityData (minOccurs="1" maxOccurs="1", output only)
fillRatio	Description: Percentage of virtual resource capacity; used to calculate actual resource capacity from virtual capacity. Parent: capacityData
instanceLocation	Description: Location of the resource instance. Parent: resourceInstance
instanceName	Description: Name of the resource instance which is being queried. Parent: resourceInstance
maxFillPc	Description: Percentage that represents the maximum capacity that can be allocated to resource consumers. When a resource reaches this level, consumers will no longer be allocated to it. Applies to both virtual and actual resource capacity. Parent: capacityData
resourceInstance	Description: Encapsulates data needed to describe a resource instance. Parent: executeData Children: instanceName (minOccurs="1" maxOccurs="1") instanceLocation (minOccurs="1" maxOccurs="1") typeName (minOccurs="1" maxOccurs="1")
capacityData	Description: The resource capacity data of the queried resource instance. Parent: executeData Parent: actualMax (minOccurs="1" maxOccurs="1") fillRatio (minOccurs="1" maxOccurs="1") actualFree (minOccurs="1" maxOccurs="1") virtualFree (minOccurs="1" maxOccurs="1") maxFillPc (minOccurs="1" maxOccurs="1") virtualMax (minOccurs="1" maxOccurs="1") warningPc (minOccurs="1" maxOccurs="1")
typeName	Description: Name of the resource type with which the resource instance is associated. Parent: resourceInstance
virtualFree	Description: Minimum value allowed for virtual free capacity. Parent: capacityData
virtualMax	Description: Maximum virtual capacity of the resource instance. Parent: capacityData
warningPc	Description: Percentage that represents the allocation level at which to raise a notification for the operator. Applies to both virtual and actual capacity. Parent: capacityData

Remarks

Schema Definition

Input

<executeData>1..1
  <resourceInstance>1..1
	<instanceName>1..1</instanceName> 
	<instanceLocation>1..1</instanceLocation> 
	<typeName>1..1</typeName> 
  </resourceInstance> 
</executeData>

Output

<executeData>1..1
  <capacityData>1..1
	<actualMax>1..1</actualMax>
	<virtualMax>1..1</virtualMax>
	<actualFree>1..1</actualFree>
	<virtualFree>1..1</virtualFree>
	<warningPc>1..1</warningPc>
	<maxFillPc>1..1</maxFillPc>
	<fillRatio>1..1</fillRatio>
  </capacityData>
</executeData>

Sample Code

Example XML Request

The following code fragment shows the format for sending data to this procedure. For more information on individual elements and attributes, see the Elements and Attributes table.

<request>
  <data/>
  <procedure>  
	<execute procedure="Query Resource Capacity Data" namespace="BlockModelRMO"> 
	<executeData>
		<resourceInstance>
		<instanceName>iis-1</instanceName>
		<typeName>IISServer</typeName>
		<instanceLocation>Lab A, Building B</instanceLocation>
		</resourceInstance>
	</executeData>
	<after source="executeData" sourcePath="capacityData" destination="data" />
	</execute>
  </procedure>
</request>

Example XML Response

The following code fragment shows the format for sending data to this procedure. For more information on individual elements and attributes, see the Elements and Attributes table.

Applies To