VMware Cloud Director API - AffinityRuleType

VMware Cloud Director API - AffinityRuleType

AffinityRuleType

Type:

AffinityRuleType

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

Represents the base type for affinity and anti-affinity rules.

Since:

20.0

Schema:

vmAffinityRule.xsd

Media type(s):

None

Extends:

IdentifiableResourceType

XML Representation:

<AffinityRuleType xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Name> xs:string </Name>
    <IsEnabled> xs:boolean </IsEnabled>
    <IsMandatory> xs:boolean </IsMandatory>
    <Polarity> AffinityRuleType/Polarity </Polarity>
</AffinityRuleType>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
href	anyURI	No	always	20.0		The URI of the entity.
type	string	No	always	20.0		The MIME type of the entity.
id	string	No	none	20.0		The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
operationKey	string	No	create	5.1		Optional unique identifier to support idempotent semantics for create and delete operations.

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
IsEnabled	boolean	Yes	always	20.0		True if the affinity rule is enabled.
IsMandatory	boolean	Yes	always	20.0		True if this affinity rule is mandatory. When a rule is mandatory, a host failover will not power on the VM if doing so would violate the rule.
Link	LinkType	No	none	20.0		A reference to an entity or operation associated with this object.
Name	string	Yes	always	20.0		The name of this affinity rule.
Polarity	AffinityRuleType/Polarity	Yes	always	20.0		The polarity of this rule. One of: Affinity Anti-Affinity
VCloudExtension	VCloudExtensionType	No	always	20.0		An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.