ClusterVmHostRuleInfo

ClusterVmHostRuleInfo
ClusterVmHostRuleInfo

A ClusterVmHostRuleInfo object identifies virtual machines and host groups that determine virtual machine placement. The virtual machines and hosts referenced by a VM-Host rule must be in the same cluster.

A VM-Host rule identifies the following groups.

  • A virtual machine group (ClusterVmGroup).
  • Two host groups - an affine host group and an anti-affine host group (ClusterHostGroup). At least one of the groups must contain one or more hosts.

ClusterVmHostRuleInfo 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 you modify a VM-Host rule, only the fields that are specified are set.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "key": 0,
    "status": "string",
    "enabled": false,
    "name": "string",
    "mandatory": false,
    "userCreated": false,
    "inCompliance": false,
    "ruleUuid": "string",
    "vmGroupName": "string",
    "affineHostGroupName": "string",
    "antiAffineHostGroupName": "string"
}
string
vmGroupName
Optional

Virtual group name (ClusterVmGroup.name).

The virtual group may contain one or more virtual machines.

string
affineHostGroupName
Optional

Name of the affine host group (ClusterHostGroup.name).

The affine host group identifies hosts on which vmGroupName virtual machines can be powered-on. The value of the mandatory property determines how the Server interprets the rule.

string
antiAffineHostGroupName
Optional

Name of the anti-affine host group (ClusterHostGroup.name).

The anti-affine host group identifies hosts on which vmGroupName virtual machines should not be powered-on. The value of the mandatory property determines how the Server interprets the rule.

Property Of