ClusterFtVmHostRuleInfo

An ClusterFtVmHostRuleInfo object provides control of the placement of virtual machines across two host groups. The virtual machines and hosts referenced by an FT VM-Host rule must be in the same cluster.

An FT VM-Host rule identifies the following groups.

A virtual machine group name (ClusterVmGroup).
An array of two host groups (ClusterHostGroup).

ClusterFtVmHostRuleInfo stores only the names of the relevant virtual machine and host groups. The group contents are stored in the virtual machine and host group objects.

When employing this rule, take care to ensure that the specified host groups have sufficient resources to support the requirements of all VMs specified.

Since: vSphere API Release 8.0.3.0

AllOf

This class requires all of the following:

ClusterRuleInfo

JSON Example

{
    "_typeName": "string",
    "key": 0,
    "status": "string",
    "enabled": false,
    "name": "string",
    "mandatory": false,
    "userCreated": false,
    "inCompliance": false,
    "ruleUuid": "string",
    "vmGroupName": "string",
    "hostGroupName": [
        "string"
    ]
}

string

vmGroupName

Required

Virtual machine group name (ClusterVmGroup.name).

The named virtual machine group may have zero or more VMs. A virtual machine in this group may be a normal virtual machine or a fault tolerant primary virtual machine; it cannot be a fault tolerant secondary virtual machine.

Control of FT secondary virtual machines is implied by the presence of the primary FT virtual machine.

A virtual machine in this group should not be referenced in any other FT VM-Host rule or VM-Host rule ClusterVmHostRuleInfo.

array of string

hostGroupName

Optional

Array of two Host Groups (ClusterHostGroup).

The hostGroup array must have two host groups. Each host group in the hostGroup array will have a set of hosts. For each Fault Tolerance primary VM that is part of VmGroup, the primary and secondary VMs would be placed on hosts that are not part of the same host group.

The members of each host group should be disjoint from the members of all other host group specified.

Availability

Added in vSphere API Release 8.0.3.0

Property Of

ArrayOfClusterFtVmHostRuleInfo