CoreRMO::Discard Candidates By Mapping

Finds candidates (resource instances and groups, and consumer instances and groups) based on their mapping relationship with other instances or groups and removes them from the specified candidate set. 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
  <candidates>1..1
	<targetSet>1..1</targetSet>
	<relatedFromSet>0..1</relatedFromSet>
	<relatedToSet>0..1</relatedToSet>
	<relationship>0..1</relationship>
	<sourceCategory>0..1</sourceCategory>
	<targetCategory>0..1</targetCategory>
  </candidates>
</executeData>

XML Output Schema

Discard Candidates By Mapping 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:
relatedFromSet (minOccurs="0" maxOccurs="1")
relatedToSet (minOccurs="0" maxOccurs="1")
relationship (minOccurs="0" maxOccurs="1")
sourceCategory (minOccurs="0" maxOccurs="1")
targetCategory (minOccurs="0" maxOccurs="1")
targetSet (minOccurs="1" maxOccurs="1")
executeData Description:
 Encapsulates the procedure's input data.

Child:
candidates (minOccurs="1" maxOccurs="1")
relatedFromSet Description:
Set of groups or instances in the "from" side of the relationship. If neither is specified, no candidates are discarded.

Parent:
candidates

relatedToSet Description:
Set of groups or instances in the "to" side of the relationship. If neither is specified, no candidates are discarded.

Parent:
candidates

relationship Description:
Name of the relationship that exists between the source and target instances or groups. Can be used to narrow the result set down to those elements that have a given relationship to each other. If not specified, all relationships are discarded.

Parent:
candidates

sourceCategory Description:
Category of the source groups or instances to consider: resourceInstance, resourceGroup, consumerInstance, or consumerGroup. If not specified, all instances and groups in either or both the "from" set or the "to" set are discarded.

Parent:
candidates

targetCategory Description:
Category of the target groups or instances to consider: resourceInstance, resourceGroup, consumerInstance, or consumerGroup. If not specified, the instances and groups in the opposite end of the relationship are discarded.

Parent:
candidates

targetSet Description:
Name of the candidate set from which to discard the groups or instances.

Parent:
candidates

Remarks

Instances or groups of interest are found and removed by specifying:

For example, suppose a mapping relationship called "allocation" exists from resourceInstance R to consumerInstance C. ResourceSet is a candidate set containing R, and ConsumerSet is a candidate set containing C. To discard C from ConsumerSet candidate set, you would pass the following XML.

<targetSet>ConsumerSet</targetSet>
<relatedFromSet>ResourceSet</relatedFromSet>
<relationship>allocation</relationship>
<sourceCategory>resourceInstance</sourceCategory>
<targetCategory>consumerInstance</targetCategory>

To discard R from ResourceSet candidate set, the XML would be:

<targetSet>ResourceSet</targetSet>
<relatedToSet>ConsumerSet</relatedToSet>
<relationship>allocation</relationship>
<sourceCategory>consumerInstance</sourceCategory>
<targetCategory>resourceInstance</targetCategory>

See Also

CoreRMO Provider, Find Candidates By Mapping, Keep Candidates By Mapping, Resource Manager

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