VcenterSettingsV1ConfigComponentsInventoryClusterDrsVmHostRule
The VmHostRule structure defines 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 (vim.cluster.VmGroup).
- Two host groups - an affine host group and an anti-affine host group (vim.cluster.HostGroup). At least one of the groups must contain one or more hosts.
Properties
Name of the affine host group. The affine host group identifies hosts on which VmHotRule#vmGroupName virtual machines can be powered-on. If unset or empty, the value is skipped.
Name of the anti-affine host group. The anti-affine host group identifies hosts on which VmHotRule#vmGroupName virtual machines should not be powered-on. If unset or empty, the value is skipped.
Flag to indicate whether or not the rule is enabled. Set this property when user configures the rule. The default value is false (disabled). If there is a rule conflict, the Server can override the setting to disable a rule. If unset or empty, the value is skipped.
Flag to indicate if the rule is in compliance. If unset or empty, the value is skipped.
Flag to indicate whether compliance with this rule is mandatory or optional. The default value is false (optional). If unset or empty, the value is skipped.
Name of the rule.
The Status enumeration defines a general “health” value for a managed entity.
GRAY : The status is unknown.
GREEN : The entity is OK.
YELLOW : The entity might have a problem.
RED : The entity definitely has a problem.
Possible values are: GRAY , GREEN , YELLOW , RED
Flag to indicate whether the rule is created by the user or the system. If unset or empty, the value is skipped.
Virtual group name. If unset or empty, the value is skipped.
JSON Example
{
"affine_host_group_name": "string",
"anti_affine_host_group_name": "string",
"enabled": false,
"in_compliance": false,
"mandatory": false,
"name": "string",
"status": "GRAY",
"user_created": false,
"vm_group_name": "string"
}
