VMware Cloud Director API - VMWVmHostAffinityRule

VMWVmHostAffinityRuleType

Element:

VMWVmHostAffinityRule

Type:

Namespace:

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

Description:

A VM-Host affinity rule controls the placement of VMs on hosts.

Since:

27.0

Schema:

vmwextensions.xsd

Media type(s):

application/vnd.vmware.admin.vmwVmHostAffinityRule+xml
application/vnd.vmware.admin.vmwVmHostAffinityRule+json
application/vnd.vmware.admin.vmwVmHostAffinityRules+json
application/vnd.vmware.admin.vmwVmHostAffinityRules+xml

Extends:

AffinityRuleType

XML Representation:

<VMWVmHostAffinityRule xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string">
    <vcloud_v1.5: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>
    <vcloud_v1.5:Polarity> vcloud_v1.5:AffinityRuleType/Polarity </vcloud_v1.5:Polarity>
    <HostGroupName> xs:string </HostGroupName>
    <VmGroupName> xs:string </VmGroupName>
</VMWVmHostAffinityRule>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
href	anyURI	No	always	27.0	The URI of the entity.
type	string	No	always	27.0	The MIME type of the entity.
id	string	No	none	27.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	Description
HostGroupName	string	Yes	always	27.0	The name of Host group on which virtual machines defined in VmGroupName may or may not be placed.
IsEnabled	boolean	Yes	always	27.0	True if the affinity rule is enabled.
IsMandatory	boolean	Yes	always	27.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	27.0	A reference to an entity or operation associated with this object.
Name	string	Yes	always	27.0	The name of this affinity rule.
Polarity	AffinityRuleType/Polarity	Yes	always	27.0	The polarity of this rule. One of: Affinity Anti-Affinity
VCloudExtension	VCloudExtensionType	No	always	27.0	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
VmGroupName	string	Yes	always	27.0	The name of the Virtual Machine group to which this rule applies.

Operations

CRUD	Operation	Description
read	GET /admin/extension/rule/{ruleId}	Retrieves the specified VM Host affinity rule
delete	DELETE /admin/extension/rule/{ruleId}	Deletes the specified VM Host affinity rule.
as input	POST /admin/extension/resourcePool/{rpId}/rules	Create VM Affinity Rules within this resource pool.