# Data Object - ClusterFailoverResourcesAdmissionControlPolicy(vim.cluster.FailoverResourcesAdmissionControlPolicy)

Extends
  ClusterDasAdmissionControlPolicy
Since
  vSphere API 4.0

## Data Object Description

The ClusterFailoverResourcesAdmissionControlPolicy reserves a specified percentage of aggregate cluster resources for failover. With the resources failover policy in place, vSphere HA uses the following calculations to control virtual machine migration in the cluster.

1. Calculate the total resource requirements for all powered-on virtual machines in the cluster.
2. Calculate the total host resources available for virtual machines.
3. Calculate the Current CPU failover capacity, memory failover capacity and optionally, persistent memory failover capacity for the cluster.
4. Compare the current CPU failover capacity and current memory failover capacity with the configured resource percentages (cpuFailoverResourcesPercent and memoryFailoverResourcesPercent). If either current capacity is less than the corresponding configured capacity, HA does not allow the operation.

HA uses the actual reservations of the virtual machines. If a virtual machine does not have reservations, meaning that the reservation is 0, a default of 0MB memory and 256MHz CPU is applied. This is controlled by the same HA advanced options used for the failover level policy (ClusterFailoverLevelAdmissionControlPolicy).

Properties

Name | Type | Description
--- | --- | ---
autoComputePercentages* | xsd:boolean | Flag to enable user input values for cpuFailoverResourcesPercent and memoryFailoverResourcesPercent By default, this is true and the default calculation is using the failoverLevel hosts' resources. If users want to override the percentage values, they must disable the auto-compute by setting this field to false. Since vSphere API 6.5
autoComputePMemFailoverResourcesPercent* | xsd:boolean | Flag to enable user input values for pMemFailoverResourcesPercent By default, this is true and the default calculation is done using the failoverLevel hosts' resources. If a user wants to override the percentage values, they must disable the auto-compute by setting this field to false. Since vSphere API 7.0.2.0
cpuFailoverResourcesPercent | xsd:int | Percentage of CPU resources in the cluster to reserve for failover. You can specify up to 100% of CPU resources for failover.
failoverLevel* | xsd:int | Number of host failures that should be tolerated, still guaranteeing sufficient resources to restart virtual machines on available hosts. If not set, we assume 1. Since vSphere API 6.5
memoryFailoverResourcesPercent | xsd:int | Percentage of memory resources in the cluster to reserve for failover. You can specify up to 100% of memory resources for failover.
pMemFailoverResourcesPercent* | xsd:int | Percentage of persistent memory resources in the cluster to reserve for the failover. You can specify up to 100% of persistent memory resources for failover. Since vSphere API 7.0.2.0
Properties inherited from ClusterDasAdmissionControlPolicy
pMemAdmissionControlEnabled, resourceReductionToToleratePercent
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition
<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="ClusterFailoverResourcesAdmissionControlPolicy"> <complexContent> <extension base="vsan:ClusterDasAdmissionControlPolicy"> <sequence> <element name="cpuFailoverResourcesPercent" type="xsd:int"/> <element name="memoryFailoverResourcesPercent" type="xsd:int"/> <element name="failoverLevel" type="xsd:int" minOccurs="0"/> <element name="autoComputePercentages" type="xsd:boolean" minOccurs="0"/> <element name="pMemFailoverResourcesPercent" type="xsd:int" minOccurs="0"/> <element name="autoComputePMemFailoverResourcesPercent" type="xsd:boolean" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>