ComputeCluster

A note on the naming of this resource: VMware refers to clusters of hosts in the UI and documentation as clusters, HA clusters, or DRS clusters. All of these refer to the same kind of resource (with the latter two referring to specific features of clustering). We use vsphere..ComputeCluster to differentiate host clusters from datastore clusters, which are clusters of datastores that can be used to distribute load and ensure fault tolerance via distribution of virtual machines. Datastore clusters can also be managed through the provider, via the vsphere..DatastoreCluster resource.

The vsphere..ComputeCluster resource can be used to create and manage clusters of hosts allowing for resource control of compute resources, load balancing through DRS, and high availability through vSphere HA.

For more information on vSphere clusters and DRS, see this page. For more information on vSphere HA, see this page.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.
NOTE: vSphere DRS requires a vSphere Enterprise Plus license.
vSphere Version Requirements

A large number of settings in the vsphere..ComputeCluster resource require a specific version of vSphere to function. Rather than include warnings at every setting or section, these settings are documented below. Note that this list is for cluster-specific attributes only, and does not include the tags parameter, which requires vSphere 6.0 or higher across all resources that can be tagged.

All settings are footnoted by an asterisk (*) in their specific section in the documentation, which takes you here.

Settings that require vSphere version 6.0 or higher

These settings require vSphere 6.0 or higher:

ha_datastore_apd_recovery_action
ha_datastore_apd_response
ha_datastore_apd_response_delay
ha_datastore_pdl_response
ha_vm_component_protection

Settings that require vSphere version 6.5 or higher

These settings require vSphere 6.5 or higher:

drs_enable_predictive_drs
ha_admission_control_host_failure_tolerance (When ha_admission_control_policy is set to resourcePercentage or slotPolicy. Permitted in all versions under failoverHosts)
ha_admission_control_resource_percentage_auto_compute
ha_vm_restart_timeout
ha_vm_dependency_restart_condition
ha_vm_restart_additional_delay
proactive_ha_automation_level
proactive_ha_enabled
proactive_ha_moderate_remediation
proactive_ha_provider_ids
proactive_ha_severe_remediation

Create a ComputeCluster Resource

new ComputeCluster(name: string, args: ComputeClusterArgs, opts?: CustomResourceOptions);

def ComputeCluster(resource_name, opts=None, custom_attributes=None, datacenter_id=None, dpm_automation_level=None, dpm_enabled=None, dpm_threshold=None, drs_advanced_options=None, drs_automation_level=None, drs_enable_predictive_drs=None, drs_enable_vm_overrides=None, drs_enabled=None, drs_migration_threshold=None, folder=None, force_evacuate_on_destroy=None, ha_admission_control_failover_host_system_ids=None, ha_admission_control_host_failure_tolerance=None, ha_admission_control_performance_tolerance=None, ha_admission_control_policy=None, ha_admission_control_resource_percentage_auto_compute=None, ha_admission_control_resource_percentage_cpu=None, ha_admission_control_resource_percentage_memory=None, ha_admission_control_slot_policy_explicit_cpu=None, ha_admission_control_slot_policy_explicit_memory=None, ha_admission_control_slot_policy_use_explicit_size=None, ha_advanced_options=None, ha_datastore_apd_recovery_action=None, ha_datastore_apd_response=None, ha_datastore_apd_response_delay=None, ha_datastore_pdl_response=None, ha_enabled=None, ha_heartbeat_datastore_ids=None, ha_heartbeat_datastore_policy=None, ha_host_isolation_response=None, ha_host_monitoring=None, ha_vm_component_protection=None, ha_vm_dependency_restart_condition=None, ha_vm_failure_interval=None, ha_vm_maximum_failure_window=None, ha_vm_maximum_resets=None, ha_vm_minimum_uptime=None, ha_vm_monitoring=None, ha_vm_restart_additional_delay=None, ha_vm_restart_priority=None, ha_vm_restart_timeout=None, host_cluster_exit_timeout=None, host_managed=None, host_system_ids=None, name=None, proactive_ha_automation_level=None, proactive_ha_enabled=None, proactive_ha_moderate_remediation=None, proactive_ha_provider_ids=None, proactive_ha_severe_remediation=None, tags=None, __props__=None);

func NewComputeCluster(ctx *Context, name string, args ComputeClusterArgs, opts ...ResourceOption) (*ComputeCluster, error)

public ComputeCluster(string name, ComputeClusterArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ComputeClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ComputeClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ComputeClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ComputeCluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ComputeCluster resource accepts the following input properties:

DatacenterId string: The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
CustomAttributes Dictionary<string, string>: A map of custom attribute ids to attribute value strings to set for the datastore cluster.
DpmAutomationLevel string: The automation level for host power operations in this cluster. Can be one of manual or automated. Default: manual.
DpmEnabled bool: Enable DPM support for DRS in this cluster. Requires drs_enabled to be true in order to be effective. Default: false.
DpmThreshold int: A value between 1 and 5 indicating the threshold of load within the cluster that influences host power operations. This affects both power on and power off operations - a lower setting will tolerate more of a surplus/deficit than a higher setting. Default: 3.
DrsAdvancedOptions Dictionary<string, string>: A key/value map that specifies advanced options for DRS and DPM.
DrsAutomationLevel string: The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.
DrsEnablePredictiveDrs bool: When true, enables DRS to use data from [vRealize Operations Manager][ref-vsphere-vro] to make proactive DRS recommendations. ^*
DrsEnableVmOverrides bool: Allow individual DRS overrides to be set for virtual machines in the cluster. Default: true.
DrsEnabled bool: Enable DRS for this cluster. Default: false.
DrsMigrationThreshold int: A value between 1 and 5 indicating the threshold of imbalance tolerated between hosts. A lower setting will tolerate more imbalance while a higher setting will tolerate less. Default: 3.
Folder string: The relative path to a folder to put this cluster in. This is a path relative to the datacenter you are deploying the cluster to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a cluster named compute-cluster-test in a host folder located at /dc1/host/foo/bar, with the final inventory path being /dc1/host/foo/bar/datastore-cluster-test.
ForceEvacuateOnDestroy bool: When destroying the resource, setting this to true will auto-remove any hosts that are currently a member of the cluster, as if they were removed by taking their entry out of host_system_ids (see below). This is an advanced option and should only be used for testing. Default: false.
HaAdmissionControlFailoverHostSystemIds List<string>: Defines the managed object IDs of hosts to use as dedicated failover hosts. These hosts are kept as available as possible - admission control will block access to the host, and DRS will ignore the host when making recommendations.
HaAdmissionControlHostFailureTolerance int: The maximum number of failed hosts that admission control tolerates when making decisions on whether to permit virtual machine operations. The maximum is one less than the number of hosts in the cluster. Default: 1. ^*
HaAdmissionControlPerformanceTolerance int: The percentage of resource reduction that a cluster of virtual machines can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting. Default: 100 (disabled).
HaAdmissionControlPolicy string: The type of admission control policy to use with vSphere HA. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Default: resourcePercentage.
HaAdmissionControlResourcePercentageAutoCompute bool: Automatically determine available resource percentages by subtracting the average number of host resources represented by the ha_admission_control_host_failure_tolerance setting from the total amount of resources in the cluster. Disable to supply user-defined values. Default: true. ^*
HaAdmissionControlResourcePercentageCpu int: Controls the user-defined percentage of CPU resources in the cluster to reserve for failover. Default: 100.
HaAdmissionControlResourcePercentageMemory int: Controls the user-defined percentage of memory resources in the cluster to reserve for failover. Default: 100.
HaAdmissionControlSlotPolicyExplicitCpu int: Controls the user-defined CPU slot size, in MHz. Default: 32.
HaAdmissionControlSlotPolicyExplicitMemory int: Controls the user-defined memory slot size, in MB. Default: 100.
HaAdmissionControlSlotPolicyUseExplicitSize bool: Controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is false, which tells vSphere to gather a automatic average based on all powered-on virtual machines currently in the cluster.
HaAdvancedOptions Dictionary<string, string>: A key/value map that specifies advanced options for vSphere HA.
HaDatastoreApdRecoveryAction string: Controls the action to take on virtual machines if an APD status on an affected datastore clears in the middle of an APD event. Can be one of none or reset. Default: none. ^*
HaDatastoreApdResponse string: Controls the action to take on virtual machines when the cluster has detected loss to all paths to a relevant datastore. Can be one of disabled, warning, restartConservative, or restartAggressive. Default: disabled. ^*
HaDatastoreApdResponseDelay int: Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Default: 3 minutes. ^*
HaDatastorePdlResponse string: Controls the action to take on virtual machines when the cluster has detected a permanent device loss to a relevant datastore. Can be one of disabled, warning, or restartAggressive. Default: disabled. ^*
HaEnabled bool: Enable vSphere HA for this cluster. Default: false.
HaHeartbeatDatastoreIds List<string>: The list of managed object IDs for preferred datastores to use for HA heartbeating. This setting is only useful when ha_heartbeat_datastore_policy is set to either userSelectedDs or allFeasibleDsWithUserPreference.
HaHeartbeatDatastorePolicy string: The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference. Default: allFeasibleDsWithUserPreference.
HaHostIsolationResponse string: The action to take on virtual machines when a host has detected that it has been isolated from the rest of the cluster. Can be one of none, powerOff, or shutdown. Default: none.
HaHostMonitoring string: Global setting that controls whether vSphere HA remediates virtual machines on host failure. Can be one of enabled or disabled. Default: enabled.
HaVmComponentProtection string: Controls vSphere VM component protection for virtual machines in this cluster. Can be one of enabled or disabled. Default: enabled. ^*
HaVmDependencyRestartCondition string: The condition used to determine whether or not virtual machines in a certain restart priority class are online, allowing HA to move on to restarting virtual machines on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen. The default is none, which means that a virtual machine is considered ready immediately after a host is found to start it on. ^*
HaVmFailureInterval int: If a heartbeat from a virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.
HaVmMaximumFailureWindow int: The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).
HaVmMaximumResets int: The maximum number of resets that HA will perform to a virtual machine when responding to a failure event. Default: 3
HaVmMinimumUptime int: The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).
HaVmMonitoring string: The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.
HaVmRestartAdditionalDelay int: Additional delay in seconds after ready condition is met. A VM is considered ready at this point. Default: 0 (no delay). ^*
HaVmRestartPriority string: The default restart priority for affected virtual machines when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest. Default: medium.
HaVmRestartTimeout int: The maximum time, in seconds, that vSphere HA will wait for virtual machines in one priority to be ready before proceeding with the next priority. Default: 600 (10 minutes). ^*
HostClusterExitTimeout int: The timeout for each host maintenance mode operation when removing hosts from a cluster. The value is specified in seconds. Default: 3600 (1 hour).
HostManaged bool: Can be set to true if compute cluster membership will be managed through the host resource rather than the compute_cluster resource. Conflicts with: host_system_ids. >>>>>>> v1.18.3
HostSystemIds List<string>: The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster. Conflicts with: host_managed.
Name string: The name of the cluster.
ProactiveHaAutomationLevel string: Determines how the host quarantine, maintenance mode, or virtual machine migration recommendations made by proactive HA are to be handled. Can be one of Automated or Manual. Default: Manual. ^*
ProactiveHaEnabled bool: Enables Proactive HA. Default: false. ^*
ProactiveHaModerateRemediation string: The configured remediation for moderately degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to MaintenanceMode when proactive_ha_severe_remediation is set to QuarantineMode. Default: QuarantineMode. ^*
ProactiveHaProviderIds List<string>: The list of IDs for health update providers configured for this cluster. ^*
ProactiveHaSevereRemediation string: The configured remediation for severely degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to QuarantineMode when proactive_ha_moderate_remediation is set to MaintenanceMode. Default: QuarantineMode. ^*
Tags List<string>: The IDs of any tags to attach to this resource.

DatacenterId string: The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
CustomAttributes map[string]string: A map of custom attribute ids to attribute value strings to set for the datastore cluster.
DpmAutomationLevel string: The automation level for host power operations in this cluster. Can be one of manual or automated. Default: manual.
DpmEnabled bool: Enable DPM support for DRS in this cluster. Requires drs_enabled to be true in order to be effective. Default: false.
DpmThreshold int: A value between 1 and 5 indicating the threshold of load within the cluster that influences host power operations. This affects both power on and power off operations - a lower setting will tolerate more of a surplus/deficit than a higher setting. Default: 3.
DrsAdvancedOptions map[string]string: A key/value map that specifies advanced options for DRS and DPM.
DrsAutomationLevel string: The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.
DrsEnablePredictiveDrs bool: When true, enables DRS to use data from [vRealize Operations Manager][ref-vsphere-vro] to make proactive DRS recommendations. ^*
DrsEnableVmOverrides bool: Allow individual DRS overrides to be set for virtual machines in the cluster. Default: true.
DrsEnabled bool: Enable DRS for this cluster. Default: false.
DrsMigrationThreshold int: A value between 1 and 5 indicating the threshold of imbalance tolerated between hosts. A lower setting will tolerate more imbalance while a higher setting will tolerate less. Default: 3.
Folder string: The relative path to a folder to put this cluster in. This is a path relative to the datacenter you are deploying the cluster to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a cluster named compute-cluster-test in a host folder located at /dc1/host/foo/bar, with the final inventory path being /dc1/host/foo/bar/datastore-cluster-test.
ForceEvacuateOnDestroy bool: When destroying the resource, setting this to true will auto-remove any hosts that are currently a member of the cluster, as if they were removed by taking their entry out of host_system_ids (see below). This is an advanced option and should only be used for testing. Default: false.
HaAdmissionControlFailoverHostSystemIds []string: Defines the managed object IDs of hosts to use as dedicated failover hosts. These hosts are kept as available as possible - admission control will block access to the host, and DRS will ignore the host when making recommendations.
HaAdmissionControlHostFailureTolerance int: The maximum number of failed hosts that admission control tolerates when making decisions on whether to permit virtual machine operations. The maximum is one less than the number of hosts in the cluster. Default: 1. ^*
HaAdmissionControlPerformanceTolerance int: The percentage of resource reduction that a cluster of virtual machines can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting. Default: 100 (disabled).
HaAdmissionControlPolicy string: The type of admission control policy to use with vSphere HA. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Default: resourcePercentage.
HaAdmissionControlResourcePercentageAutoCompute bool: Automatically determine available resource percentages by subtracting the average number of host resources represented by the ha_admission_control_host_failure_tolerance setting from the total amount of resources in the cluster. Disable to supply user-defined values. Default: true. ^*
HaAdmissionControlResourcePercentageCpu int: Controls the user-defined percentage of CPU resources in the cluster to reserve for failover. Default: 100.
HaAdmissionControlResourcePercentageMemory int: Controls the user-defined percentage of memory resources in the cluster to reserve for failover. Default: 100.
HaAdmissionControlSlotPolicyExplicitCpu int: Controls the user-defined CPU slot size, in MHz. Default: 32.
HaAdmissionControlSlotPolicyExplicitMemory int: Controls the user-defined memory slot size, in MB. Default: 100.
HaAdmissionControlSlotPolicyUseExplicitSize bool: Controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is false, which tells vSphere to gather a automatic average based on all powered-on virtual machines currently in the cluster.
HaAdvancedOptions map[string]string: A key/value map that specifies advanced options for vSphere HA.
HaDatastoreApdRecoveryAction string: Controls the action to take on virtual machines if an APD status on an affected datastore clears in the middle of an APD event. Can be one of none or reset. Default: none. ^*
HaDatastoreApdResponse string: Controls the action to take on virtual machines when the cluster has detected loss to all paths to a relevant datastore. Can be one of disabled, warning, restartConservative, or restartAggressive. Default: disabled. ^*
HaDatastoreApdResponseDelay int: Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Default: 3 minutes. ^*
HaDatastorePdlResponse string: Controls the action to take on virtual machines when the cluster has detected a permanent device loss to a relevant datastore. Can be one of disabled, warning, or restartAggressive. Default: disabled. ^*
HaEnabled bool: Enable vSphere HA for this cluster. Default: false.
HaHeartbeatDatastoreIds []string: The list of managed object IDs for preferred datastores to use for HA heartbeating. This setting is only useful when ha_heartbeat_datastore_policy is set to either userSelectedDs or allFeasibleDsWithUserPreference.
HaHeartbeatDatastorePolicy string: The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference. Default: allFeasibleDsWithUserPreference.
HaHostIsolationResponse string: The action to take on virtual machines when a host has detected that it has been isolated from the rest of the cluster. Can be one of none, powerOff, or shutdown. Default: none.
HaHostMonitoring string: Global setting that controls whether vSphere HA remediates virtual machines on host failure. Can be one of enabled or disabled. Default: enabled.
HaVmComponentProtection string: Controls vSphere VM component protection for virtual machines in this cluster. Can be one of enabled or disabled. Default: enabled. ^*
HaVmDependencyRestartCondition string: The condition used to determine whether or not virtual machines in a certain restart priority class are online, allowing HA to move on to restarting virtual machines on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen. The default is none, which means that a virtual machine is considered ready immediately after a host is found to start it on. ^*
HaVmFailureInterval int: If a heartbeat from a virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.
HaVmMaximumFailureWindow int: The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).
HaVmMaximumResets int: The maximum number of resets that HA will perform to a virtual machine when responding to a failure event. Default: 3
HaVmMinimumUptime int: The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).
HaVmMonitoring string: The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.
HaVmRestartAdditionalDelay int: Additional delay in seconds after ready condition is met. A VM is considered ready at this point. Default: 0 (no delay). ^*
HaVmRestartPriority string: The default restart priority for affected virtual machines when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest. Default: medium.
HaVmRestartTimeout int: The maximum time, in seconds, that vSphere HA will wait for virtual machines in one priority to be ready before proceeding with the next priority. Default: 600 (10 minutes). ^*
HostClusterExitTimeout int: The timeout for each host maintenance mode operation when removing hosts from a cluster. The value is specified in seconds. Default: 3600 (1 hour).
HostManaged bool: Can be set to true if compute cluster membership will be managed through the host resource rather than the compute_cluster resource. Conflicts with: host_system_ids. >>>>>>> v1.18.3
HostSystemIds []string: The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster. Conflicts with: host_managed.
Name string: The name of the cluster.
ProactiveHaAutomationLevel string: Determines how the host quarantine, maintenance mode, or virtual machine migration recommendations made by proactive HA are to be handled. Can be one of Automated or Manual. Default: Manual. ^*
ProactiveHaEnabled bool: Enables Proactive HA. Default: false. ^*
ProactiveHaModerateRemediation string: The configured remediation for moderately degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to MaintenanceMode when proactive_ha_severe_remediation is set to QuarantineMode. Default: QuarantineMode. ^*
ProactiveHaProviderIds []string: The list of IDs for health update providers configured for this cluster. ^*
ProactiveHaSevereRemediation string: The configured remediation for severely degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to QuarantineMode when proactive_ha_moderate_remediation is set to MaintenanceMode. Default: QuarantineMode. ^*
Tags []string: The IDs of any tags to attach to this resource.

datacenterId string: The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
customAttributes {[key: string]: string}: A map of custom attribute ids to attribute value strings to set for the datastore cluster.
dpmAutomationLevel string: The automation level for host power operations in this cluster. Can be one of manual or automated. Default: manual.
dpmEnabled boolean: Enable DPM support for DRS in this cluster. Requires drs_enabled to be true in order to be effective. Default: false.
dpmThreshold number: A value between 1 and 5 indicating the threshold of load within the cluster that influences host power operations. This affects both power on and power off operations - a lower setting will tolerate more of a surplus/deficit than a higher setting. Default: 3.
drsAdvancedOptions {[key: string]: string}: A key/value map that specifies advanced options for DRS and DPM.
drsAutomationLevel string: The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.
drsEnablePredictiveDrs boolean: When true, enables DRS to use data from [vRealize Operations Manager][ref-vsphere-vro] to make proactive DRS recommendations. ^*
drsEnableVmOverrides boolean: Allow individual DRS overrides to be set for virtual machines in the cluster. Default: true.
drsEnabled boolean: Enable DRS for this cluster. Default: false.
drsMigrationThreshold number: A value between 1 and 5 indicating the threshold of imbalance tolerated between hosts. A lower setting will tolerate more imbalance while a higher setting will tolerate less. Default: 3.
folder string: The relative path to a folder to put this cluster in. This is a path relative to the datacenter you are deploying the cluster to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a cluster named compute-cluster-test in a host folder located at /dc1/host/foo/bar, with the final inventory path being /dc1/host/foo/bar/datastore-cluster-test.
forceEvacuateOnDestroy boolean: When destroying the resource, setting this to true will auto-remove any hosts that are currently a member of the cluster, as if they were removed by taking their entry out of host_system_ids (see below). This is an advanced option and should only be used for testing. Default: false.
haAdmissionControlFailoverHostSystemIds string[]: Defines the managed object IDs of hosts to use as dedicated failover hosts. These hosts are kept as available as possible - admission control will block access to the host, and DRS will ignore the host when making recommendations.
haAdmissionControlHostFailureTolerance number: The maximum number of failed hosts that admission control tolerates when making decisions on whether to permit virtual machine operations. The maximum is one less than the number of hosts in the cluster. Default: 1. ^*
haAdmissionControlPerformanceTolerance number: The percentage of resource reduction that a cluster of virtual machines can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting. Default: 100 (disabled).
haAdmissionControlPolicy string: The type of admission control policy to use with vSphere HA. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Default: resourcePercentage.
haAdmissionControlResourcePercentageAutoCompute boolean: Automatically determine available resource percentages by subtracting the average number of host resources represented by the ha_admission_control_host_failure_tolerance setting from the total amount of resources in the cluster. Disable to supply user-defined values. Default: true. ^*
haAdmissionControlResourcePercentageCpu number: Controls the user-defined percentage of CPU resources in the cluster to reserve for failover. Default: 100.
haAdmissionControlResourcePercentageMemory number: Controls the user-defined percentage of memory resources in the cluster to reserve for failover. Default: 100.
haAdmissionControlSlotPolicyExplicitCpu number: Controls the user-defined CPU slot size, in MHz. Default: 32.
haAdmissionControlSlotPolicyExplicitMemory number: Controls the user-defined memory slot size, in MB. Default: 100.
haAdmissionControlSlotPolicyUseExplicitSize boolean: Controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is false, which tells vSphere to gather a automatic average based on all powered-on virtual machines currently in the cluster.
haAdvancedOptions {[key: string]: string}: A key/value map that specifies advanced options for vSphere HA.
haDatastoreApdRecoveryAction string: Controls the action to take on virtual machines if an APD status on an affected datastore clears in the middle of an APD event. Can be one of none or reset. Default: none. ^*
haDatastoreApdResponse string: Controls the action to take on virtual machines when the cluster has detected loss to all paths to a relevant datastore. Can be one of disabled, warning, restartConservative, or restartAggressive. Default: disabled. ^*
haDatastoreApdResponseDelay number: Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Default: 3 minutes. ^*
haDatastorePdlResponse string: Controls the action to take on virtual machines when the cluster has detected a permanent device loss to a relevant datastore. Can be one of disabled, warning, or restartAggressive. Default: disabled. ^*
haEnabled boolean: Enable vSphere HA for this cluster. Default: false.
haHeartbeatDatastoreIds string[]: The list of managed object IDs for preferred datastores to use for HA heartbeating. This setting is only useful when ha_heartbeat_datastore_policy is set to either userSelectedDs or allFeasibleDsWithUserPreference.
haHeartbeatDatastorePolicy string: The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference. Default: allFeasibleDsWithUserPreference.
haHostIsolationResponse string: The action to take on virtual machines when a host has detected that it has been isolated from the rest of the cluster. Can be one of none, powerOff, or shutdown. Default: none.
haHostMonitoring string: Global setting that controls whether vSphere HA remediates virtual machines on host failure. Can be one of enabled or disabled. Default: enabled.
haVmComponentProtection string: Controls vSphere VM component protection for virtual machines in this cluster. Can be one of enabled or disabled. Default: enabled. ^*
haVmDependencyRestartCondition string: The condition used to determine whether or not virtual machines in a certain restart priority class are online, allowing HA to move on to restarting virtual machines on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen. The default is none, which means that a virtual machine is considered ready immediately after a host is found to start it on. ^*
haVmFailureInterval number: If a heartbeat from a virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.
haVmMaximumFailureWindow number: The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).
haVmMaximumResets number: The maximum number of resets that HA will perform to a virtual machine when responding to a failure event. Default: 3
haVmMinimumUptime number: The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).
haVmMonitoring string: The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.
haVmRestartAdditionalDelay number: Additional delay in seconds after ready condition is met. A VM is considered ready at this point. Default: 0 (no delay). ^*
haVmRestartPriority string: The default restart priority for affected virtual machines when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest. Default: medium.
haVmRestartTimeout number: The maximum time, in seconds, that vSphere HA will wait for virtual machines in one priority to be ready before proceeding with the next priority. Default: 600 (10 minutes). ^*
hostClusterExitTimeout number: The timeout for each host maintenance mode operation when removing hosts from a cluster. The value is specified in seconds. Default: 3600 (1 hour).
hostManaged boolean: Can be set to true if compute cluster membership will be managed through the host resource rather than the compute_cluster resource. Conflicts with: host_system_ids. >>>>>>> v1.18.3
hostSystemIds string[]: The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster. Conflicts with: host_managed.
name string: The name of the cluster.
proactiveHaAutomationLevel string: Determines how the host quarantine, maintenance mode, or virtual machine migration recommendations made by proactive HA are to be handled. Can be one of Automated or Manual. Default: Manual. ^*
proactiveHaEnabled boolean: Enables Proactive HA. Default: false. ^*
proactiveHaModerateRemediation string: The configured remediation for moderately degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to MaintenanceMode when proactive_ha_severe_remediation is set to QuarantineMode. Default: QuarantineMode. ^*
proactiveHaProviderIds string[]: The list of IDs for health update providers configured for this cluster. ^*
proactiveHaSevereRemediation string: The configured remediation for severely degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to QuarantineMode when proactive_ha_moderate_remediation is set to MaintenanceMode. Default: QuarantineMode. ^*
tags string[]: The IDs of any tags to attach to this resource.

datacenter_id str: The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
custom_attributes Dict[str, str]: A map of custom attribute ids to attribute value strings to set for the datastore cluster.
dpm_automation_level str: The automation level for host power operations in this cluster. Can be one of manual or automated. Default: manual.
dpm_enabled bool: Enable DPM support for DRS in this cluster. Requires drs_enabled to be true in order to be effective. Default: false.
dpm_threshold float: A value between 1 and 5 indicating the threshold of load within the cluster that influences host power operations. This affects both power on and power off operations - a lower setting will tolerate more of a surplus/deficit than a higher setting. Default: 3.
drs_advanced_options Dict[str, str]: A key/value map that specifies advanced options for DRS and DPM.
drs_automation_level str: The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.
drs_enable_predictive_drs bool: When true, enables DRS to use data from [vRealize Operations Manager][ref-vsphere-vro] to make proactive DRS recommendations. ^*
drs_enable_vm_overrides bool: Allow individual DRS overrides to be set for virtual machines in the cluster. Default: true.
drs_enabled bool: Enable DRS for this cluster. Default: false.
drs_migration_threshold float: A value between 1 and 5 indicating the threshold of imbalance tolerated between hosts. A lower setting will tolerate more imbalance while a higher setting will tolerate less. Default: 3.
folder str: The relative path to a folder to put this cluster in. This is a path relative to the datacenter you are deploying the cluster to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a cluster named compute-cluster-test in a host folder located at /dc1/host/foo/bar, with the final inventory path being /dc1/host/foo/bar/datastore-cluster-test.
force_evacuate_on_destroy bool: When destroying the resource, setting this to true will auto-remove any hosts that are currently a member of the cluster, as if they were removed by taking their entry out of host_system_ids (see below). This is an advanced option and should only be used for testing. Default: false.
ha_admission_control_failover_host_system_ids List[str]: Defines the managed object IDs of hosts to use as dedicated failover hosts. These hosts are kept as available as possible - admission control will block access to the host, and DRS will ignore the host when making recommendations.
ha_admission_control_host_failure_tolerance float: The maximum number of failed hosts that admission control tolerates when making decisions on whether to permit virtual machine operations. The maximum is one less than the number of hosts in the cluster. Default: 1. ^*
ha_admission_control_performance_tolerance float: The percentage of resource reduction that a cluster of virtual machines can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting. Default: 100 (disabled).
ha_admission_control_policy str: The type of admission control policy to use with vSphere HA. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Default: resourcePercentage.
ha_admission_control_resource_percentage_auto_compute bool: Automatically determine available resource percentages by subtracting the average number of host resources represented by the ha_admission_control_host_failure_tolerance setting from the total amount of resources in the cluster. Disable to supply user-defined values. Default: true. ^*
ha_admission_control_resource_percentage_cpu float: Controls the user-defined percentage of CPU resources in the cluster to reserve for failover. Default: 100.
ha_admission_control_resource_percentage_memory float: Controls the user-defined percentage of memory resources in the cluster to reserve for failover. Default: 100.
ha_admission_control_slot_policy_explicit_cpu float: Controls the user-defined CPU slot size, in MHz. Default: 32.
ha_admission_control_slot_policy_explicit_memory float: Controls the user-defined memory slot size, in MB. Default: 100.
ha_admission_control_slot_policy_use_explicit_size bool: Controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is false, which tells vSphere to gather a automatic average based on all powered-on virtual machines currently in the cluster.
ha_advanced_options Dict[str, str]: A key/value map that specifies advanced options for vSphere HA.
ha_datastore_apd_recovery_action str: Controls the action to take on virtual machines if an APD status on an affected datastore clears in the middle of an APD event. Can be one of none or reset. Default: none. ^*
ha_datastore_apd_response str: Controls the action to take on virtual machines when the cluster has detected loss to all paths to a relevant datastore. Can be one of disabled, warning, restartConservative, or restartAggressive. Default: disabled. ^*
ha_datastore_apd_response_delay float: Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Default: 3 minutes. ^*
ha_datastore_pdl_response str: Controls the action to take on virtual machines when the cluster has detected a permanent device loss to a relevant datastore. Can be one of disabled, warning, or restartAggressive. Default: disabled. ^*
ha_enabled bool: Enable vSphere HA for this cluster. Default: false.
ha_heartbeat_datastore_ids List[str]: The list of managed object IDs for preferred datastores to use for HA heartbeating. This setting is only useful when ha_heartbeat_datastore_policy is set to either userSelectedDs or allFeasibleDsWithUserPreference.
ha_heartbeat_datastore_policy str: The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference. Default: allFeasibleDsWithUserPreference.
ha_host_isolation_response str: The action to take on virtual machines when a host has detected that it has been isolated from the rest of the cluster. Can be one of none, powerOff, or shutdown. Default: none.
ha_host_monitoring str: Global setting that controls whether vSphere HA remediates virtual machines on host failure. Can be one of enabled or disabled. Default: enabled.
ha_vm_component_protection str: Controls vSphere VM component protection for virtual machines in this cluster. Can be one of enabled or disabled. Default: enabled. ^*
ha_vm_dependency_restart_condition str: The condition used to determine whether or not virtual machines in a certain restart priority class are online, allowing HA to move on to restarting virtual machines on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen. The default is none, which means that a virtual machine is considered ready immediately after a host is found to start it on. ^*
ha_vm_failure_interval float: If a heartbeat from a virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.
ha_vm_maximum_failure_window float: The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).
ha_vm_maximum_resets float: The maximum number of resets that HA will perform to a virtual machine when responding to a failure event. Default: 3
ha_vm_minimum_uptime float: The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).
ha_vm_monitoring str: The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.
ha_vm_restart_additional_delay float: Additional delay in seconds after ready condition is met. A VM is considered ready at this point. Default: 0 (no delay). ^*
ha_vm_restart_priority str: The default restart priority for affected virtual machines when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest. Default: medium.
ha_vm_restart_timeout float: The maximum time, in seconds, that vSphere HA will wait for virtual machines in one priority to be ready before proceeding with the next priority. Default: 600 (10 minutes). ^*
host_cluster_exit_timeout float: The timeout for each host maintenance mode operation when removing hosts from a cluster. The value is specified in seconds. Default: 3600 (1 hour).
host_managed bool: Can be set to true if compute cluster membership will be managed through the host resource rather than the compute_cluster resource. Conflicts with: host_system_ids. >>>>>>> v1.18.3
host_system_ids List[str]: The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster. Conflicts with: host_managed.
name str: The name of the cluster.
proactive_ha_automation_level str: Determines how the host quarantine, maintenance mode, or virtual machine migration recommendations made by proactive HA are to be handled. Can be one of Automated or Manual. Default: Manual. ^*
proactive_ha_enabled bool: Enables Proactive HA. Default: false. ^*
proactive_ha_moderate_remediation str: The configured remediation for moderately degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to MaintenanceMode when proactive_ha_severe_remediation is set to QuarantineMode. Default: QuarantineMode. ^*
proactive_ha_provider_ids List[str]: The list of IDs for health update providers configured for this cluster. ^*
proactive_ha_severe_remediation str: The configured remediation for severely degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to QuarantineMode when proactive_ha_moderate_remediation is set to MaintenanceMode. Default: QuarantineMode. ^*
tags List[str]: The IDs of any tags to attach to this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the ComputeCluster resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
ResourcePoolId string: The managed object ID of the cluster’s root resource pool.

Id string: The provider-assigned unique ID for this managed resource.
ResourcePoolId string: The managed object ID of the cluster’s root resource pool.

id string: The provider-assigned unique ID for this managed resource.
resourcePoolId string: The managed object ID of the cluster’s root resource pool.

id str: The provider-assigned unique ID for this managed resource.
resource_pool_id str: The managed object ID of the cluster’s root resource pool.

Look up an Existing ComputeCluster Resource

Get an existing ComputeCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ComputeClusterState, opts?: CustomResourceOptions): ComputeCluster

static get(resource_name, id, opts=None, custom_attributes=None, datacenter_id=None, dpm_automation_level=None, dpm_enabled=None, dpm_threshold=None, drs_advanced_options=None, drs_automation_level=None, drs_enable_predictive_drs=None, drs_enable_vm_overrides=None, drs_enabled=None, drs_migration_threshold=None, folder=None, force_evacuate_on_destroy=None, ha_admission_control_failover_host_system_ids=None, ha_admission_control_host_failure_tolerance=None, ha_admission_control_performance_tolerance=None, ha_admission_control_policy=None, ha_admission_control_resource_percentage_auto_compute=None, ha_admission_control_resource_percentage_cpu=None, ha_admission_control_resource_percentage_memory=None, ha_admission_control_slot_policy_explicit_cpu=None, ha_admission_control_slot_policy_explicit_memory=None, ha_admission_control_slot_policy_use_explicit_size=None, ha_advanced_options=None, ha_datastore_apd_recovery_action=None, ha_datastore_apd_response=None, ha_datastore_apd_response_delay=None, ha_datastore_pdl_response=None, ha_enabled=None, ha_heartbeat_datastore_ids=None, ha_heartbeat_datastore_policy=None, ha_host_isolation_response=None, ha_host_monitoring=None, ha_vm_component_protection=None, ha_vm_dependency_restart_condition=None, ha_vm_failure_interval=None, ha_vm_maximum_failure_window=None, ha_vm_maximum_resets=None, ha_vm_minimum_uptime=None, ha_vm_monitoring=None, ha_vm_restart_additional_delay=None, ha_vm_restart_priority=None, ha_vm_restart_timeout=None, host_cluster_exit_timeout=None, host_managed=None, host_system_ids=None, name=None, proactive_ha_automation_level=None, proactive_ha_enabled=None, proactive_ha_moderate_remediation=None, proactive_ha_provider_ids=None, proactive_ha_severe_remediation=None, resource_pool_id=None, tags=None, __props__=None);

func GetComputeCluster(ctx *Context, name string, id IDInput, state *ComputeClusterState, opts ...ResourceOption) (*ComputeCluster, error)

public static ComputeCluster Get(string name, Input<string> id, ComputeClusterState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CustomAttributes Dictionary<string, string>: A map of custom attribute ids to attribute value strings to set for the datastore cluster.
DatacenterId string: The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
DpmAutomationLevel string: The automation level for host power operations in this cluster. Can be one of manual or automated. Default: manual.
DpmEnabled bool: Enable DPM support for DRS in this cluster. Requires drs_enabled to be true in order to be effective. Default: false.
DpmThreshold int: A value between 1 and 5 indicating the threshold of load within the cluster that influences host power operations. This affects both power on and power off operations - a lower setting will tolerate more of a surplus/deficit than a higher setting. Default: 3.
DrsAdvancedOptions Dictionary<string, string>: A key/value map that specifies advanced options for DRS and DPM.
DrsAutomationLevel string: The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.
DrsEnablePredictiveDrs bool: When true, enables DRS to use data from [vRealize Operations Manager][ref-vsphere-vro] to make proactive DRS recommendations. ^*
DrsEnableVmOverrides bool: Allow individual DRS overrides to be set for virtual machines in the cluster. Default: true.
DrsEnabled bool: Enable DRS for this cluster. Default: false.
DrsMigrationThreshold int: A value between 1 and 5 indicating the threshold of imbalance tolerated between hosts. A lower setting will tolerate more imbalance while a higher setting will tolerate less. Default: 3.
Folder string: The relative path to a folder to put this cluster in. This is a path relative to the datacenter you are deploying the cluster to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a cluster named compute-cluster-test in a host folder located at /dc1/host/foo/bar, with the final inventory path being /dc1/host/foo/bar/datastore-cluster-test.
ForceEvacuateOnDestroy bool: When destroying the resource, setting this to true will auto-remove any hosts that are currently a member of the cluster, as if they were removed by taking their entry out of host_system_ids (see below). This is an advanced option and should only be used for testing. Default: false.
HaAdmissionControlFailoverHostSystemIds List<string>: Defines the managed object IDs of hosts to use as dedicated failover hosts. These hosts are kept as available as possible - admission control will block access to the host, and DRS will ignore the host when making recommendations.
HaAdmissionControlHostFailureTolerance int: The maximum number of failed hosts that admission control tolerates when making decisions on whether to permit virtual machine operations. The maximum is one less than the number of hosts in the cluster. Default: 1. ^*
HaAdmissionControlPerformanceTolerance int: The percentage of resource reduction that a cluster of virtual machines can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting. Default: 100 (disabled).
HaAdmissionControlPolicy string: The type of admission control policy to use with vSphere HA. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Default: resourcePercentage.
HaAdmissionControlResourcePercentageAutoCompute bool: Automatically determine available resource percentages by subtracting the average number of host resources represented by the ha_admission_control_host_failure_tolerance setting from the total amount of resources in the cluster. Disable to supply user-defined values. Default: true. ^*
HaAdmissionControlResourcePercentageCpu int: Controls the user-defined percentage of CPU resources in the cluster to reserve for failover. Default: 100.
HaAdmissionControlResourcePercentageMemory int: Controls the user-defined percentage of memory resources in the cluster to reserve for failover. Default: 100.
HaAdmissionControlSlotPolicyExplicitCpu int: Controls the user-defined CPU slot size, in MHz. Default: 32.
HaAdmissionControlSlotPolicyExplicitMemory int: Controls the user-defined memory slot size, in MB. Default: 100.
HaAdmissionControlSlotPolicyUseExplicitSize bool: Controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is false, which tells vSphere to gather a automatic average based on all powered-on virtual machines currently in the cluster.
HaAdvancedOptions Dictionary<string, string>: A key/value map that specifies advanced options for vSphere HA.
HaDatastoreApdRecoveryAction string: Controls the action to take on virtual machines if an APD status on an affected datastore clears in the middle of an APD event. Can be one of none or reset. Default: none. ^*
HaDatastoreApdResponse string: Controls the action to take on virtual machines when the cluster has detected loss to all paths to a relevant datastore. Can be one of disabled, warning, restartConservative, or restartAggressive. Default: disabled. ^*
HaDatastoreApdResponseDelay int: Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Default: 3 minutes. ^*
HaDatastorePdlResponse string: Controls the action to take on virtual machines when the cluster has detected a permanent device loss to a relevant datastore. Can be one of disabled, warning, or restartAggressive. Default: disabled. ^*
HaEnabled bool: Enable vSphere HA for this cluster. Default: false.
HaHeartbeatDatastoreIds List<string>: The list of managed object IDs for preferred datastores to use for HA heartbeating. This setting is only useful when ha_heartbeat_datastore_policy is set to either userSelectedDs or allFeasibleDsWithUserPreference.
HaHeartbeatDatastorePolicy string: The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference. Default: allFeasibleDsWithUserPreference.
HaHostIsolationResponse string: The action to take on virtual machines when a host has detected that it has been isolated from the rest of the cluster. Can be one of none, powerOff, or shutdown. Default: none.
HaHostMonitoring string: Global setting that controls whether vSphere HA remediates virtual machines on host failure. Can be one of enabled or disabled. Default: enabled.
HaVmComponentProtection string: Controls vSphere VM component protection for virtual machines in this cluster. Can be one of enabled or disabled. Default: enabled. ^*
HaVmDependencyRestartCondition string: The condition used to determine whether or not virtual machines in a certain restart priority class are online, allowing HA to move on to restarting virtual machines on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen. The default is none, which means that a virtual machine is considered ready immediately after a host is found to start it on. ^*
HaVmFailureInterval int: If a heartbeat from a virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.
HaVmMaximumFailureWindow int: The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).
HaVmMaximumResets int: The maximum number of resets that HA will perform to a virtual machine when responding to a failure event. Default: 3
HaVmMinimumUptime int: The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).
HaVmMonitoring string: The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.
HaVmRestartAdditionalDelay int: Additional delay in seconds after ready condition is met. A VM is considered ready at this point. Default: 0 (no delay). ^*
HaVmRestartPriority string: The default restart priority for affected virtual machines when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest. Default: medium.
HaVmRestartTimeout int: The maximum time, in seconds, that vSphere HA will wait for virtual machines in one priority to be ready before proceeding with the next priority. Default: 600 (10 minutes). ^*
HostClusterExitTimeout int: The timeout for each host maintenance mode operation when removing hosts from a cluster. The value is specified in seconds. Default: 3600 (1 hour).
HostManaged bool: Can be set to true if compute cluster membership will be managed through the host resource rather than the compute_cluster resource. Conflicts with: host_system_ids. >>>>>>> v1.18.3
HostSystemIds List<string>: The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster. Conflicts with: host_managed.
Name string: The name of the cluster.
ProactiveHaAutomationLevel string: Determines how the host quarantine, maintenance mode, or virtual machine migration recommendations made by proactive HA are to be handled. Can be one of Automated or Manual. Default: Manual. ^*
ProactiveHaEnabled bool: Enables Proactive HA. Default: false. ^*
ProactiveHaModerateRemediation string: The configured remediation for moderately degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to MaintenanceMode when proactive_ha_severe_remediation is set to QuarantineMode. Default: QuarantineMode. ^*
ProactiveHaProviderIds List<string>: The list of IDs for health update providers configured for this cluster. ^*
ProactiveHaSevereRemediation string: The configured remediation for severely degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to QuarantineMode when proactive_ha_moderate_remediation is set to MaintenanceMode. Default: QuarantineMode. ^*
ResourcePoolId string: The managed object ID of the cluster’s root resource pool.
Tags List<string>: The IDs of any tags to attach to this resource.

CustomAttributes map[string]string: A map of custom attribute ids to attribute value strings to set for the datastore cluster.
DatacenterId string: The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
DpmAutomationLevel string: The automation level for host power operations in this cluster. Can be one of manual or automated. Default: manual.
DpmEnabled bool: Enable DPM support for DRS in this cluster. Requires drs_enabled to be true in order to be effective. Default: false.
DpmThreshold int: A value between 1 and 5 indicating the threshold of load within the cluster that influences host power operations. This affects both power on and power off operations - a lower setting will tolerate more of a surplus/deficit than a higher setting. Default: 3.
DrsAdvancedOptions map[string]string: A key/value map that specifies advanced options for DRS and DPM.
DrsAutomationLevel string: The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.
DrsEnablePredictiveDrs bool: When true, enables DRS to use data from [vRealize Operations Manager][ref-vsphere-vro] to make proactive DRS recommendations. ^*
DrsEnableVmOverrides bool: Allow individual DRS overrides to be set for virtual machines in the cluster. Default: true.
DrsEnabled bool: Enable DRS for this cluster. Default: false.
DrsMigrationThreshold int: A value between 1 and 5 indicating the threshold of imbalance tolerated between hosts. A lower setting will tolerate more imbalance while a higher setting will tolerate less. Default: 3.
Folder string: The relative path to a folder to put this cluster in. This is a path relative to the datacenter you are deploying the cluster to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a cluster named compute-cluster-test in a host folder located at /dc1/host/foo/bar, with the final inventory path being /dc1/host/foo/bar/datastore-cluster-test.
ForceEvacuateOnDestroy bool: When destroying the resource, setting this to true will auto-remove any hosts that are currently a member of the cluster, as if they were removed by taking their entry out of host_system_ids (see below). This is an advanced option and should only be used for testing. Default: false.
HaAdmissionControlFailoverHostSystemIds []string: Defines the managed object IDs of hosts to use as dedicated failover hosts. These hosts are kept as available as possible - admission control will block access to the host, and DRS will ignore the host when making recommendations.
HaAdmissionControlHostFailureTolerance int: The maximum number of failed hosts that admission control tolerates when making decisions on whether to permit virtual machine operations. The maximum is one less than the number of hosts in the cluster. Default: 1. ^*
HaAdmissionControlPerformanceTolerance int: The percentage of resource reduction that a cluster of virtual machines can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting. Default: 100 (disabled).
HaAdmissionControlPolicy string: The type of admission control policy to use with vSphere HA. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Default: resourcePercentage.
HaAdmissionControlResourcePercentageAutoCompute bool: Automatically determine available resource percentages by subtracting the average number of host resources represented by the ha_admission_control_host_failure_tolerance setting from the total amount of resources in the cluster. Disable to supply user-defined values. Default: true. ^*
HaAdmissionControlResourcePercentageCpu int: Controls the user-defined percentage of CPU resources in the cluster to reserve for failover. Default: 100.
HaAdmissionControlResourcePercentageMemory int: Controls the user-defined percentage of memory resources in the cluster to reserve for failover. Default: 100.
HaAdmissionControlSlotPolicyExplicitCpu int: Controls the user-defined CPU slot size, in MHz. Default: 32.
HaAdmissionControlSlotPolicyExplicitMemory int: Controls the user-defined memory slot size, in MB. Default: 100.
HaAdmissionControlSlotPolicyUseExplicitSize bool: Controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is false, which tells vSphere to gather a automatic average based on all powered-on virtual machines currently in the cluster.
HaAdvancedOptions map[string]string: A key/value map that specifies advanced options for vSphere HA.
HaDatastoreApdRecoveryAction string: Controls the action to take on virtual machines if an APD status on an affected datastore clears in the middle of an APD event. Can be one of none or reset. Default: none. ^*
HaDatastoreApdResponse string: Controls the action to take on virtual machines when the cluster has detected loss to all paths to a relevant datastore. Can be one of disabled, warning, restartConservative, or restartAggressive. Default: disabled. ^*
HaDatastoreApdResponseDelay int: Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Default: 3 minutes. ^*
HaDatastorePdlResponse string: Controls the action to take on virtual machines when the cluster has detected a permanent device loss to a relevant datastore. Can be one of disabled, warning, or restartAggressive. Default: disabled. ^*
HaEnabled bool: Enable vSphere HA for this cluster. Default: false.
HaHeartbeatDatastoreIds []string: The list of managed object IDs for preferred datastores to use for HA heartbeating. This setting is only useful when ha_heartbeat_datastore_policy is set to either userSelectedDs or allFeasibleDsWithUserPreference.
HaHeartbeatDatastorePolicy string: The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference. Default: allFeasibleDsWithUserPreference.
HaHostIsolationResponse string: The action to take on virtual machines when a host has detected that it has been isolated from the rest of the cluster. Can be one of none, powerOff, or shutdown. Default: none.
HaHostMonitoring string: Global setting that controls whether vSphere HA remediates virtual machines on host failure. Can be one of enabled or disabled. Default: enabled.
HaVmComponentProtection string: Controls vSphere VM component protection for virtual machines in this cluster. Can be one of enabled or disabled. Default: enabled. ^*
HaVmDependencyRestartCondition string: The condition used to determine whether or not virtual machines in a certain restart priority class are online, allowing HA to move on to restarting virtual machines on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen. The default is none, which means that a virtual machine is considered ready immediately after a host is found to start it on. ^*
HaVmFailureInterval int: If a heartbeat from a virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.
HaVmMaximumFailureWindow int: The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).
HaVmMaximumResets int: The maximum number of resets that HA will perform to a virtual machine when responding to a failure event. Default: 3
HaVmMinimumUptime int: The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).
HaVmMonitoring string: The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.
HaVmRestartAdditionalDelay int: Additional delay in seconds after ready condition is met. A VM is considered ready at this point. Default: 0 (no delay). ^*
HaVmRestartPriority string: The default restart priority for affected virtual machines when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest. Default: medium.
HaVmRestartTimeout int: The maximum time, in seconds, that vSphere HA will wait for virtual machines in one priority to be ready before proceeding with the next priority. Default: 600 (10 minutes). ^*
HostClusterExitTimeout int: The timeout for each host maintenance mode operation when removing hosts from a cluster. The value is specified in seconds. Default: 3600 (1 hour).
HostManaged bool: Can be set to true if compute cluster membership will be managed through the host resource rather than the compute_cluster resource. Conflicts with: host_system_ids. >>>>>>> v1.18.3
HostSystemIds []string: The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster. Conflicts with: host_managed.
Name string: The name of the cluster.
ProactiveHaAutomationLevel string: Determines how the host quarantine, maintenance mode, or virtual machine migration recommendations made by proactive HA are to be handled. Can be one of Automated or Manual. Default: Manual. ^*
ProactiveHaEnabled bool: Enables Proactive HA. Default: false. ^*
ProactiveHaModerateRemediation string: The configured remediation for moderately degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to MaintenanceMode when proactive_ha_severe_remediation is set to QuarantineMode. Default: QuarantineMode. ^*
ProactiveHaProviderIds []string: The list of IDs for health update providers configured for this cluster. ^*
ProactiveHaSevereRemediation string: The configured remediation for severely degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to QuarantineMode when proactive_ha_moderate_remediation is set to MaintenanceMode. Default: QuarantineMode. ^*
ResourcePoolId string: The managed object ID of the cluster’s root resource pool.
Tags []string: The IDs of any tags to attach to this resource.

customAttributes {[key: string]: string}: A map of custom attribute ids to attribute value strings to set for the datastore cluster.
datacenterId string: The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
dpmAutomationLevel string: The automation level for host power operations in this cluster. Can be one of manual or automated. Default: manual.
dpmEnabled boolean: Enable DPM support for DRS in this cluster. Requires drs_enabled to be true in order to be effective. Default: false.
dpmThreshold number: A value between 1 and 5 indicating the threshold of load within the cluster that influences host power operations. This affects both power on and power off operations - a lower setting will tolerate more of a surplus/deficit than a higher setting. Default: 3.
drsAdvancedOptions {[key: string]: string}: A key/value map that specifies advanced options for DRS and DPM.
drsAutomationLevel string: The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.
drsEnablePredictiveDrs boolean: When true, enables DRS to use data from [vRealize Operations Manager][ref-vsphere-vro] to make proactive DRS recommendations. ^*
drsEnableVmOverrides boolean: Allow individual DRS overrides to be set for virtual machines in the cluster. Default: true.
drsEnabled boolean: Enable DRS for this cluster. Default: false.
drsMigrationThreshold number: A value between 1 and 5 indicating the threshold of imbalance tolerated between hosts. A lower setting will tolerate more imbalance while a higher setting will tolerate less. Default: 3.
folder string: The relative path to a folder to put this cluster in. This is a path relative to the datacenter you are deploying the cluster to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a cluster named compute-cluster-test in a host folder located at /dc1/host/foo/bar, with the final inventory path being /dc1/host/foo/bar/datastore-cluster-test.
forceEvacuateOnDestroy boolean: When destroying the resource, setting this to true will auto-remove any hosts that are currently a member of the cluster, as if they were removed by taking their entry out of host_system_ids (see below). This is an advanced option and should only be used for testing. Default: false.
haAdmissionControlFailoverHostSystemIds string[]: Defines the managed object IDs of hosts to use as dedicated failover hosts. These hosts are kept as available as possible - admission control will block access to the host, and DRS will ignore the host when making recommendations.
haAdmissionControlHostFailureTolerance number: The maximum number of failed hosts that admission control tolerates when making decisions on whether to permit virtual machine operations. The maximum is one less than the number of hosts in the cluster. Default: 1. ^*
haAdmissionControlPerformanceTolerance number: The percentage of resource reduction that a cluster of virtual machines can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting. Default: 100 (disabled).
haAdmissionControlPolicy string: The type of admission control policy to use with vSphere HA. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Default: resourcePercentage.
haAdmissionControlResourcePercentageAutoCompute boolean: Automatically determine available resource percentages by subtracting the average number of host resources represented by the ha_admission_control_host_failure_tolerance setting from the total amount of resources in the cluster. Disable to supply user-defined values. Default: true. ^*
haAdmissionControlResourcePercentageCpu number: Controls the user-defined percentage of CPU resources in the cluster to reserve for failover. Default: 100.
haAdmissionControlResourcePercentageMemory number: Controls the user-defined percentage of memory resources in the cluster to reserve for failover. Default: 100.
haAdmissionControlSlotPolicyExplicitCpu number: Controls the user-defined CPU slot size, in MHz. Default: 32.
haAdmissionControlSlotPolicyExplicitMemory number: Controls the user-defined memory slot size, in MB. Default: 100.
haAdmissionControlSlotPolicyUseExplicitSize boolean: Controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is false, which tells vSphere to gather a automatic average based on all powered-on virtual machines currently in the cluster.
haAdvancedOptions {[key: string]: string}: A key/value map that specifies advanced options for vSphere HA.
haDatastoreApdRecoveryAction string: Controls the action to take on virtual machines if an APD status on an affected datastore clears in the middle of an APD event. Can be one of none or reset. Default: none. ^*
haDatastoreApdResponse string: Controls the action to take on virtual machines when the cluster has detected loss to all paths to a relevant datastore. Can be one of disabled, warning, restartConservative, or restartAggressive. Default: disabled. ^*
haDatastoreApdResponseDelay number: Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Default: 3 minutes. ^*
haDatastorePdlResponse string: Controls the action to take on virtual machines when the cluster has detected a permanent device loss to a relevant datastore. Can be one of disabled, warning, or restartAggressive. Default: disabled. ^*
haEnabled boolean: Enable vSphere HA for this cluster. Default: false.
haHeartbeatDatastoreIds string[]: The list of managed object IDs for preferred datastores to use for HA heartbeating. This setting is only useful when ha_heartbeat_datastore_policy is set to either userSelectedDs or allFeasibleDsWithUserPreference.
haHeartbeatDatastorePolicy string: The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference. Default: allFeasibleDsWithUserPreference.
haHostIsolationResponse string: The action to take on virtual machines when a host has detected that it has been isolated from the rest of the cluster. Can be one of none, powerOff, or shutdown. Default: none.
haHostMonitoring string: Global setting that controls whether vSphere HA remediates virtual machines on host failure. Can be one of enabled or disabled. Default: enabled.
haVmComponentProtection string: Controls vSphere VM component protection for virtual machines in this cluster. Can be one of enabled or disabled. Default: enabled. ^*
haVmDependencyRestartCondition string: The condition used to determine whether or not virtual machines in a certain restart priority class are online, allowing HA to move on to restarting virtual machines on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen. The default is none, which means that a virtual machine is considered ready immediately after a host is found to start it on. ^*
haVmFailureInterval number: If a heartbeat from a virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.
haVmMaximumFailureWindow number: The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).
haVmMaximumResets number: The maximum number of resets that HA will perform to a virtual machine when responding to a failure event. Default: 3
haVmMinimumUptime number: The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).
haVmMonitoring string: The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.
haVmRestartAdditionalDelay number: Additional delay in seconds after ready condition is met. A VM is considered ready at this point. Default: 0 (no delay). ^*
haVmRestartPriority string: The default restart priority for affected virtual machines when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest. Default: medium.
haVmRestartTimeout number: The maximum time, in seconds, that vSphere HA will wait for virtual machines in one priority to be ready before proceeding with the next priority. Default: 600 (10 minutes). ^*
hostClusterExitTimeout number: The timeout for each host maintenance mode operation when removing hosts from a cluster. The value is specified in seconds. Default: 3600 (1 hour).
hostManaged boolean: Can be set to true if compute cluster membership will be managed through the host resource rather than the compute_cluster resource. Conflicts with: host_system_ids. >>>>>>> v1.18.3
hostSystemIds string[]: The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster. Conflicts with: host_managed.
name string: The name of the cluster.
proactiveHaAutomationLevel string: Determines how the host quarantine, maintenance mode, or virtual machine migration recommendations made by proactive HA are to be handled. Can be one of Automated or Manual. Default: Manual. ^*
proactiveHaEnabled boolean: Enables Proactive HA. Default: false. ^*
proactiveHaModerateRemediation string: The configured remediation for moderately degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to MaintenanceMode when proactive_ha_severe_remediation is set to QuarantineMode. Default: QuarantineMode. ^*
proactiveHaProviderIds string[]: The list of IDs for health update providers configured for this cluster. ^*
proactiveHaSevereRemediation string: The configured remediation for severely degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to QuarantineMode when proactive_ha_moderate_remediation is set to MaintenanceMode. Default: QuarantineMode. ^*
resourcePoolId string: The managed object ID of the cluster’s root resource pool.
tags string[]: The IDs of any tags to attach to this resource.

custom_attributes Dict[str, str]: A map of custom attribute ids to attribute value strings to set for the datastore cluster.
datacenter_id str: The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
dpm_automation_level str: The automation level for host power operations in this cluster. Can be one of manual or automated. Default: manual.
dpm_enabled bool: Enable DPM support for DRS in this cluster. Requires drs_enabled to be true in order to be effective. Default: false.
dpm_threshold float: A value between 1 and 5 indicating the threshold of load within the cluster that influences host power operations. This affects both power on and power off operations - a lower setting will tolerate more of a surplus/deficit than a higher setting. Default: 3.
drs_advanced_options Dict[str, str]: A key/value map that specifies advanced options for DRS and DPM.
drs_automation_level str: The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.
drs_enable_predictive_drs bool: When true, enables DRS to use data from [vRealize Operations Manager][ref-vsphere-vro] to make proactive DRS recommendations. ^*
drs_enable_vm_overrides bool: Allow individual DRS overrides to be set for virtual machines in the cluster. Default: true.
drs_enabled bool: Enable DRS for this cluster. Default: false.
drs_migration_threshold float: A value between 1 and 5 indicating the threshold of imbalance tolerated between hosts. A lower setting will tolerate more imbalance while a higher setting will tolerate less. Default: 3.
folder str: The relative path to a folder to put this cluster in. This is a path relative to the datacenter you are deploying the cluster to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a cluster named compute-cluster-test in a host folder located at /dc1/host/foo/bar, with the final inventory path being /dc1/host/foo/bar/datastore-cluster-test.
force_evacuate_on_destroy bool: When destroying the resource, setting this to true will auto-remove any hosts that are currently a member of the cluster, as if they were removed by taking their entry out of host_system_ids (see below). This is an advanced option and should only be used for testing. Default: false.
ha_admission_control_failover_host_system_ids List[str]: Defines the managed object IDs of hosts to use as dedicated failover hosts. These hosts are kept as available as possible - admission control will block access to the host, and DRS will ignore the host when making recommendations.
ha_admission_control_host_failure_tolerance float: The maximum number of failed hosts that admission control tolerates when making decisions on whether to permit virtual machine operations. The maximum is one less than the number of hosts in the cluster. Default: 1. ^*
ha_admission_control_performance_tolerance float: The percentage of resource reduction that a cluster of virtual machines can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting. Default: 100 (disabled).
ha_admission_control_policy str: The type of admission control policy to use with vSphere HA. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Default: resourcePercentage.
ha_admission_control_resource_percentage_auto_compute bool: Automatically determine available resource percentages by subtracting the average number of host resources represented by the ha_admission_control_host_failure_tolerance setting from the total amount of resources in the cluster. Disable to supply user-defined values. Default: true. ^*
ha_admission_control_resource_percentage_cpu float: Controls the user-defined percentage of CPU resources in the cluster to reserve for failover. Default: 100.
ha_admission_control_resource_percentage_memory float: Controls the user-defined percentage of memory resources in the cluster to reserve for failover. Default: 100.
ha_admission_control_slot_policy_explicit_cpu float: Controls the user-defined CPU slot size, in MHz. Default: 32.
ha_admission_control_slot_policy_explicit_memory float: Controls the user-defined memory slot size, in MB. Default: 100.
ha_admission_control_slot_policy_use_explicit_size bool: Controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is false, which tells vSphere to gather a automatic average based on all powered-on virtual machines currently in the cluster.
ha_advanced_options Dict[str, str]: A key/value map that specifies advanced options for vSphere HA.
ha_datastore_apd_recovery_action str: Controls the action to take on virtual machines if an APD status on an affected datastore clears in the middle of an APD event. Can be one of none or reset. Default: none. ^*
ha_datastore_apd_response str: Controls the action to take on virtual machines when the cluster has detected loss to all paths to a relevant datastore. Can be one of disabled, warning, restartConservative, or restartAggressive. Default: disabled. ^*
ha_datastore_apd_response_delay float: Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Default: 3 minutes. ^*
ha_datastore_pdl_response str: Controls the action to take on virtual machines when the cluster has detected a permanent device loss to a relevant datastore. Can be one of disabled, warning, or restartAggressive. Default: disabled. ^*
ha_enabled bool: Enable vSphere HA for this cluster. Default: false.
ha_heartbeat_datastore_ids List[str]: The list of managed object IDs for preferred datastores to use for HA heartbeating. This setting is only useful when ha_heartbeat_datastore_policy is set to either userSelectedDs or allFeasibleDsWithUserPreference.
ha_heartbeat_datastore_policy str: The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference. Default: allFeasibleDsWithUserPreference.
ha_host_isolation_response str: The action to take on virtual machines when a host has detected that it has been isolated from the rest of the cluster. Can be one of none, powerOff, or shutdown. Default: none.
ha_host_monitoring str: Global setting that controls whether vSphere HA remediates virtual machines on host failure. Can be one of enabled or disabled. Default: enabled.
ha_vm_component_protection str: Controls vSphere VM component protection for virtual machines in this cluster. Can be one of enabled or disabled. Default: enabled. ^*
ha_vm_dependency_restart_condition str: The condition used to determine whether or not virtual machines in a certain restart priority class are online, allowing HA to move on to restarting virtual machines on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen. The default is none, which means that a virtual machine is considered ready immediately after a host is found to start it on. ^*
ha_vm_failure_interval float: If a heartbeat from a virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.
ha_vm_maximum_failure_window float: The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).
ha_vm_maximum_resets float: The maximum number of resets that HA will perform to a virtual machine when responding to a failure event. Default: 3
ha_vm_minimum_uptime float: The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).
ha_vm_monitoring str: The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.
ha_vm_restart_additional_delay float: Additional delay in seconds after ready condition is met. A VM is considered ready at this point. Default: 0 (no delay). ^*
ha_vm_restart_priority str: The default restart priority for affected virtual machines when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest. Default: medium.
ha_vm_restart_timeout float: The maximum time, in seconds, that vSphere HA will wait for virtual machines in one priority to be ready before proceeding with the next priority. Default: 600 (10 minutes). ^*
host_cluster_exit_timeout float: The timeout for each host maintenance mode operation when removing hosts from a cluster. The value is specified in seconds. Default: 3600 (1 hour).
host_managed bool: Can be set to true if compute cluster membership will be managed through the host resource rather than the compute_cluster resource. Conflicts with: host_system_ids. >>>>>>> v1.18.3
host_system_ids List[str]: The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster. Conflicts with: host_managed.
name str: The name of the cluster.
proactive_ha_automation_level str: Determines how the host quarantine, maintenance mode, or virtual machine migration recommendations made by proactive HA are to be handled. Can be one of Automated or Manual. Default: Manual. ^*
proactive_ha_enabled bool: Enables Proactive HA. Default: false. ^*
proactive_ha_moderate_remediation str: The configured remediation for moderately degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to MaintenanceMode when proactive_ha_severe_remediation is set to QuarantineMode. Default: QuarantineMode. ^*
proactive_ha_provider_ids List[str]: The list of IDs for health update providers configured for this cluster. ^*
proactive_ha_severe_remediation str: The configured remediation for severely degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to QuarantineMode when proactive_ha_moderate_remediation is set to MaintenanceMode. Default: QuarantineMode. ^*
resource_pool_id str: The managed object ID of the cluster’s root resource pool.
tags List[str]: The IDs of any tags to attach to this resource.

Package Details

Repository: https://github.com/pulumi/pulumi-vsphere
License: Apache-2.0
Notes: This Pulumi package is based on the vsphere Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud