CoreRMO::Add Resource To Candidates

Adds a resource instance to a candidate set and optionally assigns the instance a rank. Used by Microsoft. Provisioning Framework (MPF).

XML Input Schema

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.

<executeData>1..1
  <resourceInstance>1..1
	<instanceName>1..1</instanceName>
	<typeName>1..1</typeName>
	<instanceLocation>1..1</instanceLocation>
   </resourceInstance>
  <candidates>1..1
	<targetSet>1..1</targetSet>
	<rank>0..1</rank>
  </candidates>
</executeData>

XML Output Schema

Add Resource To Candidates does not return data.

Elements and Attributes

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

Element Description, relationships, and attributes
candidates Description:
Encapsulates data needed to interact with a candidate set.

Parent:
executeData

Children:
targetSet (minOccurs="1" maxOccurs="1")
rank (minOccurs="0" maxOccurs="1")
executeData Description:
 Encapsulates the procedure's input data.

Children:
resourceInstance(minOccurs="1" maxOccurs="1")
candidates(minOccurs="1" maxOccurs="1")
instanceLocation Description:
Location of the resource instance.

Parent:
resourceInstance

instanceName Description:
Name of the resource instance. The resource instance will not be re-added if it already exists in the candidate set.

Parent:
resourceInstance

resourceInstance Description:
Encapsulates the data needed to describe a resource instance. The instance is identified by instanceName, typeName, and instanceLocation.

Parent:
executeData

Children:
instanceLocation (minOccurs="1" maxOccurs="1")
instanceName (minOccurs="1" maxOccurs="1")
typeName (minOccurs="1" maxOccurs="1")
rank Description:
Integer that specifies the rank to assign to the resource instance when it is added to the candidate set. If not specified, the default value is null.

Parent:
candidates

targetSet Description:
Name of the candidate set to add the resource instance to.

Parent:
candidates

typeName Description:
Name of the resource type associated with this instance.

Parent:
resourceInstance

Example

<request>
  <data/>
  <procedure>  
	<execute procedure="Add Resource To Candidates" namespace="CoreRMO"> 
	<executeData>
		<resourceInstance>
		<instanceName>iis-1</instanceName>
		<instanceLocation>Lab A, Building B</instanceLocation>
		<typeName>IISServer</typeName>
		</resourceInstance>
		<candidates>
		<targetSet>serverSet</targetSet>
		<rank>1</rank>
		</candidates>
	</executeData>
	</execute>
  </procedure>
</request>

See Also

Add Candidates to Candidates, Add Consumer Group to Candidates, Add Consumer Instance, Add Resource Group to Candidates, CoreRMO Provider, Delete Mapping, Find Candidates By Mapping, Find Consumers, Find Resources, Keep Candidates By Mapping, Resource Manager

Up Top of Page
) 1999-2002 Microsoft Corporation. All rights reserved.