Attributes
Attribute | Type | Required | Modifiable | Since | Deprecated | 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 | Deprecated | 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 | Since | Deprecated |
---|---|---|---|---|
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. |