Cluster Compute Resource Find Rules For Vm
Finds all enabled and disabled VM-VM Affinity and Anti-Affinity rules, involving the given Virtual Machine.
Required privileges: System.View
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case ClusterComputeResource/{moId}.
The vSphere release schema. The current specification covers vSphere 9.1.0.0 APIs.
Show optional properties
{
"vm": {}
}{
"vm": {
"_typeName": "string",
"type": "string",
"value": "string"
}
}The vm whose rules need to be looked up.
OK
[
{
"_typeName": "string",
"key": 0,
"status": "string",
"enabled": false,
"name": "string",
"mandatory": false,
"userCreated": false,
"inCompliance": false,
"ruleUuid": "string"
}
]The ClusterRuleInfo data object is the base type for affinity and anti-affinity rules.
The affinity and anti-affinity rules are DRS (Distributed Resource Scheduling) rules that affect the placement of virtual machines in a cluster. Hosts and virtual machines referenced in a DRS rule must be in the same cluster.
Note: DRS rules are different than an individual host's CPU affinity rules (VirtualMachineAffinityInfo).
The Server uses DRS rule objects to describe the current rule configuration (ClusterConfigInfoEx.rule). Your client application uses rule objects to configure the affinity and anti-affinity rules (ClusterConfigSpecEx.rulesSpec).
You can create the following types of rules:
- An affinity rule defines a set of virtual machines that should run on the same host. The ClusterAffinityRuleSpec object describes a rule that identifies virtual machines, but does not identify any specific host.
- An anti-affinity rule defines a set of virtual machines that should run on different hosts. The ClusterAntiAffinityRuleSpec object describes a rule that identifies virtual machines, but does not identify any specific host.
- A VM-Host rule defines affinity and anti-affinity relationships between virtual machines and hosts. The ClusterVmHostRuleInfo object describes a rule that identifies a virtual machine group (ClusterVmGroup) and affinity and anti-affinity host groups (ClusterHostGroup).
Rule configuration is a dynamic process. When you create or modify a DRS rule, the Server applies the rule to the cluster. If the existing cluster configuration violates the rule, the Server attempts to correct the situation. If that is not possible, the Server generates a fault and produces a log event. DRS rules do not have precedence; all rules are applied equally. DRS does not validate one rule against another. If you create conflicting rules, the older rule takes precedence and DRS disables the newer rule.
Improperly used, DRS rules can fragment the cluster and inhibit the proper functioning of DRS, HA, and DPM services. vSphere services never take any actions that would result in the violation of mandatory DRS rules. An operation that violates a mandatory rule would produce the following consequences.
- DRS does not evacuate virtual machines to place a host in maintenance mode.
- DRS does not place virtual machines for power-on or load balance virtual machines.
- HA does not perform failovers.
- DPM does not optimize power management by placing hosts into standby mode.
To avoid these situations, exercise caution when creating more than one mandatory rule, or consider using only optional rules. Make sure that the number of hosts with which a virtual machine is related by affinity rule is large enough that losing a host does not prevent the virtual machine from running.
For manual and partially automated DRS clusters, the Server produces migration recommendations to satisfy the DRS rules. You are not required to act on the recommendations, but the Server maintains the recommendations until the rules are satisfied.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"vm":"{}"}' https://{api_host}/sdk/vim25/{release}/ClusterComputeResource/{moId}/FindRulesForVm