VcenterSettingsV1ConfigComponentsInventoryClusterDrsAffinityRule

The AffinityRule structure defines a set of virtual machines that DRS will attempt to run on the same host.


Properties

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

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: 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.


array of string
vms Optional

List of virtual machines.

JSON Example

{
	"enabled": false,
	"in_compliance": false,
	"mandatory": false,
	"name": "string",
	"status": "GRAY",
	"user_created": false,
	"vms": [
		"string"
	]
}

Feedback

Was this page helpful?