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

string
affine_host_group_name Optional

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.


string
anti_affine_host_group_name Optional

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.


boolean
enabled Optional

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.


boolean
in_compliance Optional

Flag to indicate if the rule is in compliance. If unset or empty, the value is skipped.


boolean
mandatory Optional

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.


string
name Optional

Name of the rule.


status Optional

Flag to indicate whether or not the rule is currently satisfied.

Possible values are: GRAYGREENYELLOWRED


boolean
user_created Optional

Flag to indicate whether the rule is created by the user or the system. If unset or empty, the value is skipped.


string
vm_group_name Optional

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": "enum",
    "user_created": false,
    "vm_group_name": "string"
}
Feedback

Was this page helpful?