vsphere.ComputeCluster
Explore with Pulumi AI
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 thevsphere.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.
Create ComputeCluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ComputeCluster(name: string, args: ComputeClusterArgs, opts?: CustomResourceOptions);
@overload
def ComputeCluster(resource_name: str,
args: ComputeClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ComputeCluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
datacenter_id: Optional[str] = None,
custom_attributes: Optional[Mapping[str, str]] = None,
dpm_automation_level: Optional[str] = None,
dpm_enabled: Optional[bool] = None,
dpm_threshold: Optional[int] = None,
drs_advanced_options: Optional[Mapping[str, str]] = None,
drs_automation_level: Optional[str] = None,
drs_enable_predictive_drs: Optional[bool] = None,
drs_enable_vm_overrides: Optional[bool] = None,
drs_enabled: Optional[bool] = None,
drs_migration_threshold: Optional[int] = None,
drs_scale_descendants_shares: Optional[str] = None,
folder: Optional[str] = None,
force_evacuate_on_destroy: Optional[bool] = None,
ha_admission_control_failover_host_system_ids: Optional[Sequence[str]] = None,
ha_admission_control_host_failure_tolerance: Optional[int] = None,
ha_admission_control_performance_tolerance: Optional[int] = None,
ha_admission_control_policy: Optional[str] = None,
ha_admission_control_resource_percentage_auto_compute: Optional[bool] = None,
ha_admission_control_resource_percentage_cpu: Optional[int] = None,
ha_admission_control_resource_percentage_memory: Optional[int] = None,
ha_admission_control_slot_policy_explicit_cpu: Optional[int] = None,
ha_admission_control_slot_policy_explicit_memory: Optional[int] = None,
ha_admission_control_slot_policy_use_explicit_size: Optional[bool] = None,
ha_advanced_options: Optional[Mapping[str, str]] = None,
ha_datastore_apd_recovery_action: Optional[str] = None,
ha_datastore_apd_response: Optional[str] = None,
ha_datastore_apd_response_delay: Optional[int] = None,
ha_datastore_pdl_response: Optional[str] = None,
ha_enabled: Optional[bool] = None,
ha_heartbeat_datastore_ids: Optional[Sequence[str]] = None,
ha_heartbeat_datastore_policy: Optional[str] = None,
ha_host_isolation_response: Optional[str] = None,
ha_host_monitoring: Optional[str] = None,
ha_vm_component_protection: Optional[str] = None,
ha_vm_dependency_restart_condition: Optional[str] = None,
ha_vm_failure_interval: Optional[int] = None,
ha_vm_maximum_failure_window: Optional[int] = None,
ha_vm_maximum_resets: Optional[int] = None,
ha_vm_minimum_uptime: Optional[int] = None,
ha_vm_monitoring: Optional[str] = None,
ha_vm_restart_additional_delay: Optional[int] = None,
ha_vm_restart_priority: Optional[str] = None,
ha_vm_restart_timeout: Optional[int] = None,
host_cluster_exit_timeout: Optional[int] = None,
host_image: Optional[ComputeClusterHostImageArgs] = None,
host_managed: Optional[bool] = None,
host_system_ids: Optional[Sequence[str]] = None,
name: Optional[str] = None,
proactive_ha_automation_level: Optional[str] = None,
proactive_ha_enabled: Optional[bool] = None,
proactive_ha_moderate_remediation: Optional[str] = None,
proactive_ha_provider_ids: Optional[Sequence[str]] = None,
proactive_ha_severe_remediation: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
vsan_compression_enabled: Optional[bool] = None,
vsan_dedup_enabled: Optional[bool] = None,
vsan_disk_groups: Optional[Sequence[ComputeClusterVsanDiskGroupArgs]] = None,
vsan_dit_encryption_enabled: Optional[bool] = None,
vsan_dit_rekey_interval: Optional[int] = None,
vsan_enabled: Optional[bool] = None,
vsan_esa_enabled: Optional[bool] = None,
vsan_fault_domains: Optional[Sequence[ComputeClusterVsanFaultDomainArgs]] = None,
vsan_network_diagnostic_mode_enabled: Optional[bool] = None,
vsan_performance_enabled: Optional[bool] = None,
vsan_remote_datastore_ids: Optional[Sequence[str]] = None,
vsan_stretched_cluster: Optional[ComputeClusterVsanStretchedClusterArgs] = None,
vsan_unmap_enabled: Optional[bool] = None,
vsan_verbose_mode_enabled: Optional[bool] = None)
func NewComputeCluster(ctx *Context, name string, args ComputeClusterArgs, opts ...ResourceOption) (*ComputeCluster, error)
public ComputeCluster(string name, ComputeClusterArgs args, CustomResourceOptions? opts = null)
public ComputeCluster(String name, ComputeClusterArgs args)
public ComputeCluster(String name, ComputeClusterArgs args, CustomResourceOptions options)
type: vsphere:ComputeCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
- args ComputeClusterArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control 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.
- name String
- The unique name of the resource.
- args ComputeClusterArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var computeClusterResource = new VSphere.ComputeCluster("computeClusterResource", new()
{
DatacenterId = "string",
CustomAttributes =
{
{ "string", "string" },
},
DpmAutomationLevel = "string",
DpmEnabled = false,
DpmThreshold = 0,
DrsAdvancedOptions =
{
{ "string", "string" },
},
DrsAutomationLevel = "string",
DrsEnablePredictiveDrs = false,
DrsEnableVmOverrides = false,
DrsEnabled = false,
DrsMigrationThreshold = 0,
DrsScaleDescendantsShares = "string",
Folder = "string",
ForceEvacuateOnDestroy = false,
HaAdmissionControlFailoverHostSystemIds = new[]
{
"string",
},
HaAdmissionControlHostFailureTolerance = 0,
HaAdmissionControlPerformanceTolerance = 0,
HaAdmissionControlPolicy = "string",
HaAdmissionControlResourcePercentageAutoCompute = false,
HaAdmissionControlResourcePercentageCpu = 0,
HaAdmissionControlResourcePercentageMemory = 0,
HaAdmissionControlSlotPolicyExplicitCpu = 0,
HaAdmissionControlSlotPolicyExplicitMemory = 0,
HaAdmissionControlSlotPolicyUseExplicitSize = false,
HaAdvancedOptions =
{
{ "string", "string" },
},
HaDatastoreApdRecoveryAction = "string",
HaDatastoreApdResponse = "string",
HaDatastoreApdResponseDelay = 0,
HaDatastorePdlResponse = "string",
HaEnabled = false,
HaHeartbeatDatastoreIds = new[]
{
"string",
},
HaHeartbeatDatastorePolicy = "string",
HaHostIsolationResponse = "string",
HaHostMonitoring = "string",
HaVmComponentProtection = "string",
HaVmDependencyRestartCondition = "string",
HaVmFailureInterval = 0,
HaVmMaximumFailureWindow = 0,
HaVmMaximumResets = 0,
HaVmMinimumUptime = 0,
HaVmMonitoring = "string",
HaVmRestartAdditionalDelay = 0,
HaVmRestartPriority = "string",
HaVmRestartTimeout = 0,
HostClusterExitTimeout = 0,
HostImage = new VSphere.Inputs.ComputeClusterHostImageArgs
{
Components = new[]
{
new VSphere.Inputs.ComputeClusterHostImageComponentArgs
{
Key = "string",
Version = "string",
},
},
EsxVersion = "string",
},
HostManaged = false,
HostSystemIds = new[]
{
"string",
},
Name = "string",
ProactiveHaAutomationLevel = "string",
ProactiveHaEnabled = false,
ProactiveHaModerateRemediation = "string",
ProactiveHaProviderIds = new[]
{
"string",
},
ProactiveHaSevereRemediation = "string",
Tags = new[]
{
"string",
},
VsanCompressionEnabled = false,
VsanDedupEnabled = false,
VsanDiskGroups = new[]
{
new VSphere.Inputs.ComputeClusterVsanDiskGroupArgs
{
Cache = "string",
Storages = new[]
{
"string",
},
},
},
VsanDitEncryptionEnabled = false,
VsanDitRekeyInterval = 0,
VsanEnabled = false,
VsanEsaEnabled = false,
VsanFaultDomains = new[]
{
new VSphere.Inputs.ComputeClusterVsanFaultDomainArgs
{
FaultDomains = new[]
{
new VSphere.Inputs.ComputeClusterVsanFaultDomainFaultDomainArgs
{
HostIds = new[]
{
"string",
},
Name = "string",
},
},
},
},
VsanNetworkDiagnosticModeEnabled = false,
VsanPerformanceEnabled = false,
VsanRemoteDatastoreIds = new[]
{
"string",
},
VsanStretchedCluster = new VSphere.Inputs.ComputeClusterVsanStretchedClusterArgs
{
PreferredFaultDomainHostIds = new[]
{
"string",
},
SecondaryFaultDomainHostIds = new[]
{
"string",
},
WitnessNode = "string",
PreferredFaultDomainName = "string",
SecondaryFaultDomainName = "string",
},
VsanUnmapEnabled = false,
VsanVerboseModeEnabled = false,
});
example, err := vsphere.NewComputeCluster(ctx, "computeClusterResource", &vsphere.ComputeClusterArgs{
DatacenterId: pulumi.String("string"),
CustomAttributes: pulumi.StringMap{
"string": pulumi.String("string"),
},
DpmAutomationLevel: pulumi.String("string"),
DpmEnabled: pulumi.Bool(false),
DpmThreshold: pulumi.Int(0),
DrsAdvancedOptions: pulumi.StringMap{
"string": pulumi.String("string"),
},
DrsAutomationLevel: pulumi.String("string"),
DrsEnablePredictiveDrs: pulumi.Bool(false),
DrsEnableVmOverrides: pulumi.Bool(false),
DrsEnabled: pulumi.Bool(false),
DrsMigrationThreshold: pulumi.Int(0),
DrsScaleDescendantsShares: pulumi.String("string"),
Folder: pulumi.String("string"),
ForceEvacuateOnDestroy: pulumi.Bool(false),
HaAdmissionControlFailoverHostSystemIds: pulumi.StringArray{
pulumi.String("string"),
},
HaAdmissionControlHostFailureTolerance: pulumi.Int(0),
HaAdmissionControlPerformanceTolerance: pulumi.Int(0),
HaAdmissionControlPolicy: pulumi.String("string"),
HaAdmissionControlResourcePercentageAutoCompute: pulumi.Bool(false),
HaAdmissionControlResourcePercentageCpu: pulumi.Int(0),
HaAdmissionControlResourcePercentageMemory: pulumi.Int(0),
HaAdmissionControlSlotPolicyExplicitCpu: pulumi.Int(0),
HaAdmissionControlSlotPolicyExplicitMemory: pulumi.Int(0),
HaAdmissionControlSlotPolicyUseExplicitSize: pulumi.Bool(false),
HaAdvancedOptions: pulumi.StringMap{
"string": pulumi.String("string"),
},
HaDatastoreApdRecoveryAction: pulumi.String("string"),
HaDatastoreApdResponse: pulumi.String("string"),
HaDatastoreApdResponseDelay: pulumi.Int(0),
HaDatastorePdlResponse: pulumi.String("string"),
HaEnabled: pulumi.Bool(false),
HaHeartbeatDatastoreIds: pulumi.StringArray{
pulumi.String("string"),
},
HaHeartbeatDatastorePolicy: pulumi.String("string"),
HaHostIsolationResponse: pulumi.String("string"),
HaHostMonitoring: pulumi.String("string"),
HaVmComponentProtection: pulumi.String("string"),
HaVmDependencyRestartCondition: pulumi.String("string"),
HaVmFailureInterval: pulumi.Int(0),
HaVmMaximumFailureWindow: pulumi.Int(0),
HaVmMaximumResets: pulumi.Int(0),
HaVmMinimumUptime: pulumi.Int(0),
HaVmMonitoring: pulumi.String("string"),
HaVmRestartAdditionalDelay: pulumi.Int(0),
HaVmRestartPriority: pulumi.String("string"),
HaVmRestartTimeout: pulumi.Int(0),
HostClusterExitTimeout: pulumi.Int(0),
HostImage: &vsphere.ComputeClusterHostImageArgs{
Components: vsphere.ComputeClusterHostImageComponentArray{
&vsphere.ComputeClusterHostImageComponentArgs{
Key: pulumi.String("string"),
Version: pulumi.String("string"),
},
},
EsxVersion: pulumi.String("string"),
},
HostManaged: pulumi.Bool(false),
HostSystemIds: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
ProactiveHaAutomationLevel: pulumi.String("string"),
ProactiveHaEnabled: pulumi.Bool(false),
ProactiveHaModerateRemediation: pulumi.String("string"),
ProactiveHaProviderIds: pulumi.StringArray{
pulumi.String("string"),
},
ProactiveHaSevereRemediation: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
VsanCompressionEnabled: pulumi.Bool(false),
VsanDedupEnabled: pulumi.Bool(false),
VsanDiskGroups: vsphere.ComputeClusterVsanDiskGroupArray{
&vsphere.ComputeClusterVsanDiskGroupArgs{
Cache: pulumi.String("string"),
Storages: pulumi.StringArray{
pulumi.String("string"),
},
},
},
VsanDitEncryptionEnabled: pulumi.Bool(false),
VsanDitRekeyInterval: pulumi.Int(0),
VsanEnabled: pulumi.Bool(false),
VsanEsaEnabled: pulumi.Bool(false),
VsanFaultDomains: vsphere.ComputeClusterVsanFaultDomainArray{
&vsphere.ComputeClusterVsanFaultDomainArgs{
FaultDomains: vsphere.ComputeClusterVsanFaultDomainFaultDomainArray{
&vsphere.ComputeClusterVsanFaultDomainFaultDomainArgs{
HostIds: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
},
},
},
},
VsanNetworkDiagnosticModeEnabled: pulumi.Bool(false),
VsanPerformanceEnabled: pulumi.Bool(false),
VsanRemoteDatastoreIds: pulumi.StringArray{
pulumi.String("string"),
},
VsanStretchedCluster: &vsphere.ComputeClusterVsanStretchedClusterArgs{
PreferredFaultDomainHostIds: pulumi.StringArray{
pulumi.String("string"),
},
SecondaryFaultDomainHostIds: pulumi.StringArray{
pulumi.String("string"),
},
WitnessNode: pulumi.String("string"),
PreferredFaultDomainName: pulumi.String("string"),
SecondaryFaultDomainName: pulumi.String("string"),
},
VsanUnmapEnabled: pulumi.Bool(false),
VsanVerboseModeEnabled: pulumi.Bool(false),
})
var computeClusterResource = new ComputeCluster("computeClusterResource", ComputeClusterArgs.builder()
.datacenterId("string")
.customAttributes(Map.of("string", "string"))
.dpmAutomationLevel("string")
.dpmEnabled(false)
.dpmThreshold(0)
.drsAdvancedOptions(Map.of("string", "string"))
.drsAutomationLevel("string")
.drsEnablePredictiveDrs(false)
.drsEnableVmOverrides(false)
.drsEnabled(false)
.drsMigrationThreshold(0)
.drsScaleDescendantsShares("string")
.folder("string")
.forceEvacuateOnDestroy(false)
.haAdmissionControlFailoverHostSystemIds("string")
.haAdmissionControlHostFailureTolerance(0)
.haAdmissionControlPerformanceTolerance(0)
.haAdmissionControlPolicy("string")
.haAdmissionControlResourcePercentageAutoCompute(false)
.haAdmissionControlResourcePercentageCpu(0)
.haAdmissionControlResourcePercentageMemory(0)
.haAdmissionControlSlotPolicyExplicitCpu(0)
.haAdmissionControlSlotPolicyExplicitMemory(0)
.haAdmissionControlSlotPolicyUseExplicitSize(false)
.haAdvancedOptions(Map.of("string", "string"))
.haDatastoreApdRecoveryAction("string")
.haDatastoreApdResponse("string")
.haDatastoreApdResponseDelay(0)
.haDatastorePdlResponse("string")
.haEnabled(false)
.haHeartbeatDatastoreIds("string")
.haHeartbeatDatastorePolicy("string")
.haHostIsolationResponse("string")
.haHostMonitoring("string")
.haVmComponentProtection("string")
.haVmDependencyRestartCondition("string")
.haVmFailureInterval(0)
.haVmMaximumFailureWindow(0)
.haVmMaximumResets(0)
.haVmMinimumUptime(0)
.haVmMonitoring("string")
.haVmRestartAdditionalDelay(0)
.haVmRestartPriority("string")
.haVmRestartTimeout(0)
.hostClusterExitTimeout(0)
.hostImage(ComputeClusterHostImageArgs.builder()
.components(ComputeClusterHostImageComponentArgs.builder()
.key("string")
.version("string")
.build())
.esxVersion("string")
.build())
.hostManaged(false)
.hostSystemIds("string")
.name("string")
.proactiveHaAutomationLevel("string")
.proactiveHaEnabled(false)
.proactiveHaModerateRemediation("string")
.proactiveHaProviderIds("string")
.proactiveHaSevereRemediation("string")
.tags("string")
.vsanCompressionEnabled(false)
.vsanDedupEnabled(false)
.vsanDiskGroups(ComputeClusterVsanDiskGroupArgs.builder()
.cache("string")
.storages("string")
.build())
.vsanDitEncryptionEnabled(false)
.vsanDitRekeyInterval(0)
.vsanEnabled(false)
.vsanEsaEnabled(false)
.vsanFaultDomains(ComputeClusterVsanFaultDomainArgs.builder()
.faultDomains(ComputeClusterVsanFaultDomainFaultDomainArgs.builder()
.hostIds("string")
.name("string")
.build())
.build())
.vsanNetworkDiagnosticModeEnabled(false)
.vsanPerformanceEnabled(false)
.vsanRemoteDatastoreIds("string")
.vsanStretchedCluster(ComputeClusterVsanStretchedClusterArgs.builder()
.preferredFaultDomainHostIds("string")
.secondaryFaultDomainHostIds("string")
.witnessNode("string")
.preferredFaultDomainName("string")
.secondaryFaultDomainName("string")
.build())
.vsanUnmapEnabled(false)
.vsanVerboseModeEnabled(false)
.build());
compute_cluster_resource = vsphere.ComputeCluster("computeClusterResource",
datacenter_id="string",
custom_attributes={
"string": "string",
},
dpm_automation_level="string",
dpm_enabled=False,
dpm_threshold=0,
drs_advanced_options={
"string": "string",
},
drs_automation_level="string",
drs_enable_predictive_drs=False,
drs_enable_vm_overrides=False,
drs_enabled=False,
drs_migration_threshold=0,
drs_scale_descendants_shares="string",
folder="string",
force_evacuate_on_destroy=False,
ha_admission_control_failover_host_system_ids=["string"],
ha_admission_control_host_failure_tolerance=0,
ha_admission_control_performance_tolerance=0,
ha_admission_control_policy="string",
ha_admission_control_resource_percentage_auto_compute=False,
ha_admission_control_resource_percentage_cpu=0,
ha_admission_control_resource_percentage_memory=0,
ha_admission_control_slot_policy_explicit_cpu=0,
ha_admission_control_slot_policy_explicit_memory=0,
ha_admission_control_slot_policy_use_explicit_size=False,
ha_advanced_options={
"string": "string",
},
ha_datastore_apd_recovery_action="string",
ha_datastore_apd_response="string",
ha_datastore_apd_response_delay=0,
ha_datastore_pdl_response="string",
ha_enabled=False,
ha_heartbeat_datastore_ids=["string"],
ha_heartbeat_datastore_policy="string",
ha_host_isolation_response="string",
ha_host_monitoring="string",
ha_vm_component_protection="string",
ha_vm_dependency_restart_condition="string",
ha_vm_failure_interval=0,
ha_vm_maximum_failure_window=0,
ha_vm_maximum_resets=0,
ha_vm_minimum_uptime=0,
ha_vm_monitoring="string",
ha_vm_restart_additional_delay=0,
ha_vm_restart_priority="string",
ha_vm_restart_timeout=0,
host_cluster_exit_timeout=0,
host_image={
"components": [{
"key": "string",
"version": "string",
}],
"esx_version": "string",
},
host_managed=False,
host_system_ids=["string"],
name="string",
proactive_ha_automation_level="string",
proactive_ha_enabled=False,
proactive_ha_moderate_remediation="string",
proactive_ha_provider_ids=["string"],
proactive_ha_severe_remediation="string",
tags=["string"],
vsan_compression_enabled=False,
vsan_dedup_enabled=False,
vsan_disk_groups=[{
"cache": "string",
"storages": ["string"],
}],
vsan_dit_encryption_enabled=False,
vsan_dit_rekey_interval=0,
vsan_enabled=False,
vsan_esa_enabled=False,
vsan_fault_domains=[{
"fault_domains": [{
"host_ids": ["string"],
"name": "string",
}],
}],
vsan_network_diagnostic_mode_enabled=False,
vsan_performance_enabled=False,
vsan_remote_datastore_ids=["string"],
vsan_stretched_cluster={
"preferred_fault_domain_host_ids": ["string"],
"secondary_fault_domain_host_ids": ["string"],
"witness_node": "string",
"preferred_fault_domain_name": "string",
"secondary_fault_domain_name": "string",
},
vsan_unmap_enabled=False,
vsan_verbose_mode_enabled=False)
const computeClusterResource = new vsphere.ComputeCluster("computeClusterResource", {
datacenterId: "string",
customAttributes: {
string: "string",
},
dpmAutomationLevel: "string",
dpmEnabled: false,
dpmThreshold: 0,
drsAdvancedOptions: {
string: "string",
},
drsAutomationLevel: "string",
drsEnablePredictiveDrs: false,
drsEnableVmOverrides: false,
drsEnabled: false,
drsMigrationThreshold: 0,
drsScaleDescendantsShares: "string",
folder: "string",
forceEvacuateOnDestroy: false,
haAdmissionControlFailoverHostSystemIds: ["string"],
haAdmissionControlHostFailureTolerance: 0,
haAdmissionControlPerformanceTolerance: 0,
haAdmissionControlPolicy: "string",
haAdmissionControlResourcePercentageAutoCompute: false,
haAdmissionControlResourcePercentageCpu: 0,
haAdmissionControlResourcePercentageMemory: 0,
haAdmissionControlSlotPolicyExplicitCpu: 0,
haAdmissionControlSlotPolicyExplicitMemory: 0,
haAdmissionControlSlotPolicyUseExplicitSize: false,
haAdvancedOptions: {
string: "string",
},
haDatastoreApdRecoveryAction: "string",
haDatastoreApdResponse: "string",
haDatastoreApdResponseDelay: 0,
haDatastorePdlResponse: "string",
haEnabled: false,
haHeartbeatDatastoreIds: ["string"],
haHeartbeatDatastorePolicy: "string",
haHostIsolationResponse: "string",
haHostMonitoring: "string",
haVmComponentProtection: "string",
haVmDependencyRestartCondition: "string",
haVmFailureInterval: 0,
haVmMaximumFailureWindow: 0,
haVmMaximumResets: 0,
haVmMinimumUptime: 0,
haVmMonitoring: "string",
haVmRestartAdditionalDelay: 0,
haVmRestartPriority: "string",
haVmRestartTimeout: 0,
hostClusterExitTimeout: 0,
hostImage: {
components: [{
key: "string",
version: "string",
}],
esxVersion: "string",
},
hostManaged: false,
hostSystemIds: ["string"],
name: "string",
proactiveHaAutomationLevel: "string",
proactiveHaEnabled: false,
proactiveHaModerateRemediation: "string",
proactiveHaProviderIds: ["string"],
proactiveHaSevereRemediation: "string",
tags: ["string"],
vsanCompressionEnabled: false,
vsanDedupEnabled: false,
vsanDiskGroups: [{
cache: "string",
storages: ["string"],
}],
vsanDitEncryptionEnabled: false,
vsanDitRekeyInterval: 0,
vsanEnabled: false,
vsanEsaEnabled: false,
vsanFaultDomains: [{
faultDomains: [{
hostIds: ["string"],
name: "string",
}],
}],
vsanNetworkDiagnosticModeEnabled: false,
vsanPerformanceEnabled: false,
vsanRemoteDatastoreIds: ["string"],
vsanStretchedCluster: {
preferredFaultDomainHostIds: ["string"],
secondaryFaultDomainHostIds: ["string"],
witnessNode: "string",
preferredFaultDomainName: "string",
secondaryFaultDomainName: "string",
},
vsanUnmapEnabled: false,
vsanVerboseModeEnabled: false,
});
type: vsphere:ComputeCluster
properties:
customAttributes:
string: string
datacenterId: string
dpmAutomationLevel: string
dpmEnabled: false
dpmThreshold: 0
drsAdvancedOptions:
string: string
drsAutomationLevel: string
drsEnablePredictiveDrs: false
drsEnableVmOverrides: false
drsEnabled: false
drsMigrationThreshold: 0
drsScaleDescendantsShares: string
folder: string
forceEvacuateOnDestroy: false
haAdmissionControlFailoverHostSystemIds:
- string
haAdmissionControlHostFailureTolerance: 0
haAdmissionControlPerformanceTolerance: 0
haAdmissionControlPolicy: string
haAdmissionControlResourcePercentageAutoCompute: false
haAdmissionControlResourcePercentageCpu: 0
haAdmissionControlResourcePercentageMemory: 0
haAdmissionControlSlotPolicyExplicitCpu: 0
haAdmissionControlSlotPolicyExplicitMemory: 0
haAdmissionControlSlotPolicyUseExplicitSize: false
haAdvancedOptions:
string: string
haDatastoreApdRecoveryAction: string
haDatastoreApdResponse: string
haDatastoreApdResponseDelay: 0
haDatastorePdlResponse: string
haEnabled: false
haHeartbeatDatastoreIds:
- string
haHeartbeatDatastorePolicy: string
haHostIsolationResponse: string
haHostMonitoring: string
haVmComponentProtection: string
haVmDependencyRestartCondition: string
haVmFailureInterval: 0
haVmMaximumFailureWindow: 0
haVmMaximumResets: 0
haVmMinimumUptime: 0
haVmMonitoring: string
haVmRestartAdditionalDelay: 0
haVmRestartPriority: string
haVmRestartTimeout: 0
hostClusterExitTimeout: 0
hostImage:
components:
- key: string
version: string
esxVersion: string
hostManaged: false
hostSystemIds:
- string
name: string
proactiveHaAutomationLevel: string
proactiveHaEnabled: false
proactiveHaModerateRemediation: string
proactiveHaProviderIds:
- string
proactiveHaSevereRemediation: string
tags:
- string
vsanCompressionEnabled: false
vsanDedupEnabled: false
vsanDiskGroups:
- cache: string
storages:
- string
vsanDitEncryptionEnabled: false
vsanDitRekeyInterval: 0
vsanEnabled: false
vsanEsaEnabled: false
vsanFaultDomains:
- faultDomains:
- hostIds:
- string
name: string
vsanNetworkDiagnosticModeEnabled: false
vsanPerformanceEnabled: false
vsanRemoteDatastoreIds:
- string
vsanStretchedCluster:
preferredFaultDomainHostIds:
- string
preferredFaultDomainName: string
secondaryFaultDomainHostIds:
- string
secondaryFaultDomainName: string
witnessNode: string
vsanUnmapEnabled: false
vsanVerboseModeEnabled: false
ComputeCluster Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ComputeCluster resource accepts the following input properties:
- Datacenter
Id string - The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
- Custom
Attributes Dictionary<string, string> A map of custom attribute ids to attribute value strings to set for the datastore cluster.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter Server.
- Dpm
Automation stringLevel - The automation level for host power operations in this cluster. Can be one of manual or automated.
- Dpm
Enabled bool - Enable DPM support for DRS. This allows you to dynamically control the power of hosts depending on the needs of virtual machines in the cluster. Requires that DRS be enabled.
- Dpm
Threshold 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.
- Drs
Advanced Dictionary<string, string>Options - Advanced configuration options for DRS and DPM.
- Drs
Automation stringLevel - The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated.
- Drs
Enable boolPredictive Drs - When true, enables DRS to use data from vRealize Operations Manager to make proactive DRS recommendations.
- Drs
Enable boolVm Overrides - When true, allows individual VM overrides within this cluster to be set.
- Drs
Enabled bool - Enable DRS for this cluster.
- Drs
Migration intThreshold - 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.
- string
- Enable scalable shares for all descendants of this cluster.
- 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 providedfolder
offoo/bar
, The provider will place a cluster namedcompute-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 boolOn Destroy - Force removal of all hosts in the cluster during destroy and make them standalone hosts. Use of this flag mainly exists for testing and is not recommended in normal use.
- Ha
Admission List<string>Control Failover Host System Ids - When ha_admission_control_policy is failoverHosts, this 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 intControl Host Failure Tolerance - 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.
- Ha
Admission intControl Performance Tolerance - The percentage of resource reduction that a cluster of VMs can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting.
- Ha
Admission stringControl Policy - The type of admission control policy to use with vSphere HA, which controls whether or not specific VM operations are permitted in the cluster in order to protect the reliability of the cluster. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Note that disabling admission control is not recommended and can lead to service issues.
- Ha
Admission boolControl Resource Percentage Auto Compute - When ha_admission_control_policy is resourcePercentage, 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.
- Ha
Admission intControl Resource Percentage Cpu - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of CPU resources in the cluster to reserve for failover.
- Ha
Admission intControl Resource Percentage Memory - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of memory resources in the cluster to reserve for failover.
- Ha
Admission intControl Slot Policy Explicit Cpu - When ha_admission_control_policy is slotPolicy, this controls the user-defined CPU slot size, in MHz.
- Ha
Admission intControl Slot Policy Explicit Memory - When ha_admission_control_policy is slotPolicy, this controls the user-defined memory slot size, in MB.
- Ha
Admission boolControl Slot Policy Use Explicit Size - When ha_admission_control_policy is slotPolicy, this setting controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is to gather a automatic average based on all powered-on virtual machines currently in the cluster.
- Ha
Advanced Dictionary<string, string>Options - Advanced configuration options for vSphere HA.
- Ha
Datastore stringApd Recovery Action - When ha_vm_component_protection is enabled, 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.
- Ha
Datastore stringApd Response - When ha_vm_component_protection is enabled, 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.
- Ha
Datastore intApd Response Delay - When ha_vm_component_protection is enabled, controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response.
- Ha
Datastore stringPdl Response - When ha_vm_component_protection is enabled, 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.
- Ha
Enabled bool - Enable vSphere HA for this cluster.
- Ha
Heartbeat List<string>Datastore Ids - 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 stringDatastore Policy - The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference.
- Ha
Host stringIsolation Response - 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.
- Ha
Host stringMonitoring - Global setting that controls whether vSphere HA remediates VMs on host failure. Can be one of enabled or disabled.
- Ha
Vm stringComponent Protection - Controls vSphere VM component protection for virtual machines in this cluster. This allows vSphere HA to react to failures between hosts and specific virtual machine components, such as datastores. Can be one of enabled or disabled.
- Ha
Vm stringDependency Restart Condition - The condition used to determine whether or not VMs in a certain restart priority class are online, allowing HA to move on to restarting VMs on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen.
- Ha
Vm intFailure Interval - 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.
- Ha
Vm intMaximum Failure Window - 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.
- Ha
Vm intMaximum Resets - The maximum number of resets that HA will perform to a virtual machine when responding to a failure event.
- Ha
Vm intMinimum Uptime - The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats.
- Ha
Vm stringMonitoring - The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
- Ha
Vm intRestart Additional Delay - Additional delay in seconds after ready condition is met. A VM is considered ready at this point.
- Ha
Vm stringRestart Priority - The default restart priority for affected VMs when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest.
- Ha
Vm intRestart Timeout - 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.
- Host
Cluster intExit Timeout - The timeout for each host maintenance mode operation when removing hosts from a cluster.
- Host
Image Pulumi.VSphere. Inputs. Compute Cluster Host Image - Details about the host image which should be applied to the cluster.
- Host
Managed bool - Must be set if cluster enrollment is managed from host resource.
- Host
System List<string>Ids - The managed object IDs of the hosts to put in the cluster.
- Name string
- The name of the cluster.
- Proactive
Ha stringAutomation Level - The DRS behavior for proactive HA recommendations. Can be one of Automated or Manual.
- Proactive
Ha boolEnabled - Enables proactive HA, allowing for vSphere to get HA data from external providers and use DRS to perform remediation.
- Proactive
Ha stringModerate Remediation - 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.
- Proactive
Ha List<string>Provider Ids - The list of IDs for health update providers configured for this cluster.
- Proactive
Ha stringSevere Remediation - 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.
- List<string>
- The IDs of any tags to attach to this resource.
- Vsan
Compression boolEnabled - Whether the vSAN compression service is enabled for the cluster.
- Vsan
Dedup boolEnabled - Whether the vSAN deduplication service is enabled for the cluster.
- Vsan
Disk List<Pulumi.Groups VSphere. Inputs. Compute Cluster Vsan Disk Group> - A list of disk UUIDs to add to the vSAN cluster.
- Vsan
Dit boolEncryption Enabled - Whether the vSAN data-in-transit encryption is enabled for the cluster.
- Vsan
Dit intRekey Interval - When vsan_dit_encryption_enabled is enabled, sets the rekey interval of data-in-transit encryption (in minutes).
- Vsan
Enabled bool - Whether the vSAN service is enabled for the cluster.
- Vsan
Esa boolEnabled - Whether the vSAN ESA service is enabled for the cluster.
- Vsan
Fault List<Pulumi.Domains VSphere. Inputs. Compute Cluster Vsan Fault Domain> - The configuration for vSAN fault domains.
- Vsan
Network boolDiagnostic Mode Enabled - Whether the vSAN network diagnostic mode is enabled for the cluster.
- Vsan
Performance boolEnabled - Whether the vSAN performance service is enabled for the cluster.
- Vsan
Remote List<string>Datastore Ids - The managed object IDs of the vSAN datastore to be mounted on the cluster.
- Vsan
Stretched Pulumi.Cluster VSphere. Inputs. Compute Cluster Vsan Stretched Cluster - The configuration for stretched cluster.
- Vsan
Unmap boolEnabled - Whether the vSAN unmap service is enabled for the cluster.
- Vsan
Verbose boolMode Enabled - Whether the vSAN verbose mode is enabled for the cluster.
- Datacenter
Id string - The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
- Custom
Attributes map[string]string A map of custom attribute ids to attribute value strings to set for the datastore cluster.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter Server.
- Dpm
Automation stringLevel - The automation level for host power operations in this cluster. Can be one of manual or automated.
- Dpm
Enabled bool - Enable DPM support for DRS. This allows you to dynamically control the power of hosts depending on the needs of virtual machines in the cluster. Requires that DRS be enabled.
- Dpm
Threshold 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.
- Drs
Advanced map[string]stringOptions - Advanced configuration options for DRS and DPM.
- Drs
Automation stringLevel - The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated.
- Drs
Enable boolPredictive Drs - When true, enables DRS to use data from vRealize Operations Manager to make proactive DRS recommendations.
- Drs
Enable boolVm Overrides - When true, allows individual VM overrides within this cluster to be set.
- Drs
Enabled bool - Enable DRS for this cluster.
- Drs
Migration intThreshold - 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.
- string
- Enable scalable shares for all descendants of this cluster.
- 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 providedfolder
offoo/bar
, The provider will place a cluster namedcompute-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 boolOn Destroy - Force removal of all hosts in the cluster during destroy and make them standalone hosts. Use of this flag mainly exists for testing and is not recommended in normal use.
- Ha
Admission []stringControl Failover Host System Ids - When ha_admission_control_policy is failoverHosts, this 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 intControl Host Failure Tolerance - 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.
- Ha
Admission intControl Performance Tolerance - The percentage of resource reduction that a cluster of VMs can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting.
- Ha
Admission stringControl Policy - The type of admission control policy to use with vSphere HA, which controls whether or not specific VM operations are permitted in the cluster in order to protect the reliability of the cluster. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Note that disabling admission control is not recommended and can lead to service issues.
- Ha
Admission boolControl Resource Percentage Auto Compute - When ha_admission_control_policy is resourcePercentage, 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.
- Ha
Admission intControl Resource Percentage Cpu - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of CPU resources in the cluster to reserve for failover.
- Ha
Admission intControl Resource Percentage Memory - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of memory resources in the cluster to reserve for failover.
- Ha
Admission intControl Slot Policy Explicit Cpu - When ha_admission_control_policy is slotPolicy, this controls the user-defined CPU slot size, in MHz.
- Ha
Admission intControl Slot Policy Explicit Memory - When ha_admission_control_policy is slotPolicy, this controls the user-defined memory slot size, in MB.
- Ha
Admission boolControl Slot Policy Use Explicit Size - When ha_admission_control_policy is slotPolicy, this setting controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is to gather a automatic average based on all powered-on virtual machines currently in the cluster.
- Ha
Advanced map[string]stringOptions - Advanced configuration options for vSphere HA.
- Ha
Datastore stringApd Recovery Action - When ha_vm_component_protection is enabled, 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.
- Ha
Datastore stringApd Response - When ha_vm_component_protection is enabled, 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.
- Ha
Datastore intApd Response Delay - When ha_vm_component_protection is enabled, controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response.
- Ha
Datastore stringPdl Response - When ha_vm_component_protection is enabled, 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.
- Ha
Enabled bool - Enable vSphere HA for this cluster.
- Ha
Heartbeat []stringDatastore Ids - 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 stringDatastore Policy - The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference.
- Ha
Host stringIsolation Response - 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.
- Ha
Host stringMonitoring - Global setting that controls whether vSphere HA remediates VMs on host failure. Can be one of enabled or disabled.
- Ha
Vm stringComponent Protection - Controls vSphere VM component protection for virtual machines in this cluster. This allows vSphere HA to react to failures between hosts and specific virtual machine components, such as datastores. Can be one of enabled or disabled.
- Ha
Vm stringDependency Restart Condition - The condition used to determine whether or not VMs in a certain restart priority class are online, allowing HA to move on to restarting VMs on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen.
- Ha
Vm intFailure Interval - 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.
- Ha
Vm intMaximum Failure Window - 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.
- Ha
Vm intMaximum Resets - The maximum number of resets that HA will perform to a virtual machine when responding to a failure event.
- Ha
Vm intMinimum Uptime - The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats.
- Ha
Vm stringMonitoring - The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
- Ha
Vm intRestart Additional Delay - Additional delay in seconds after ready condition is met. A VM is considered ready at this point.
- Ha
Vm stringRestart Priority - The default restart priority for affected VMs when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest.
- Ha
Vm intRestart Timeout - 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.
- Host
Cluster intExit Timeout - The timeout for each host maintenance mode operation when removing hosts from a cluster.
- Host
Image ComputeCluster Host Image Args - Details about the host image which should be applied to the cluster.
- Host
Managed bool - Must be set if cluster enrollment is managed from host resource.
- Host
System []stringIds - The managed object IDs of the hosts to put in the cluster.
- Name string
- The name of the cluster.
- Proactive
Ha stringAutomation Level - The DRS behavior for proactive HA recommendations. Can be one of Automated or Manual.
- Proactive
Ha boolEnabled - Enables proactive HA, allowing for vSphere to get HA data from external providers and use DRS to perform remediation.
- Proactive
Ha stringModerate Remediation - 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.
- Proactive
Ha []stringProvider Ids - The list of IDs for health update providers configured for this cluster.
- Proactive
Ha stringSevere Remediation - 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.
- []string
- The IDs of any tags to attach to this resource.
- Vsan
Compression boolEnabled - Whether the vSAN compression service is enabled for the cluster.
- Vsan
Dedup boolEnabled - Whether the vSAN deduplication service is enabled for the cluster.
- Vsan
Disk []ComputeGroups Cluster Vsan Disk Group Args - A list of disk UUIDs to add to the vSAN cluster.
- Vsan
Dit boolEncryption Enabled - Whether the vSAN data-in-transit encryption is enabled for the cluster.
- Vsan
Dit intRekey Interval - When vsan_dit_encryption_enabled is enabled, sets the rekey interval of data-in-transit encryption (in minutes).
- Vsan
Enabled bool - Whether the vSAN service is enabled for the cluster.
- Vsan
Esa boolEnabled - Whether the vSAN ESA service is enabled for the cluster.
- Vsan
Fault []ComputeDomains Cluster Vsan Fault Domain Args - The configuration for vSAN fault domains.
- Vsan
Network boolDiagnostic Mode Enabled - Whether the vSAN network diagnostic mode is enabled for the cluster.
- Vsan
Performance boolEnabled - Whether the vSAN performance service is enabled for the cluster.
- Vsan
Remote []stringDatastore Ids - The managed object IDs of the vSAN datastore to be mounted on the cluster.
- Vsan
Stretched ComputeCluster Cluster Vsan Stretched Cluster Args - The configuration for stretched cluster.
- Vsan
Unmap boolEnabled - Whether the vSAN unmap service is enabled for the cluster.
- Vsan
Verbose boolMode Enabled - Whether the vSAN verbose mode is enabled for the cluster.
- datacenter
Id String - The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
- custom
Attributes Map<String,String> A map of custom attribute ids to attribute value strings to set for the datastore cluster.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter Server.
- dpm
Automation StringLevel - The automation level for host power operations in this cluster. Can be one of manual or automated.
- dpm
Enabled Boolean - Enable DPM support for DRS. This allows you to dynamically control the power of hosts depending on the needs of virtual machines in the cluster. Requires that DRS be enabled.
- dpm
Threshold Integer - 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.
- drs
Advanced Map<String,String>Options - Advanced configuration options for DRS and DPM.
- drs
Automation StringLevel - The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated.
- drs
Enable BooleanPredictive Drs - When true, enables DRS to use data from vRealize Operations Manager to make proactive DRS recommendations.
- drs
Enable BooleanVm Overrides - When true, allows individual VM overrides within this cluster to be set.
- drs
Enabled Boolean - Enable DRS for this cluster.
- drs
Migration IntegerThreshold - 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.
- String
- Enable scalable shares for all descendants of this cluster.
- 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 providedfolder
offoo/bar
, The provider will place a cluster namedcompute-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 BooleanOn Destroy - Force removal of all hosts in the cluster during destroy and make them standalone hosts. Use of this flag mainly exists for testing and is not recommended in normal use.
- ha
Admission List<String>Control Failover Host System Ids - When ha_admission_control_policy is failoverHosts, this 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 IntegerControl Host Failure Tolerance - 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.
- ha
Admission IntegerControl Performance Tolerance - The percentage of resource reduction that a cluster of VMs can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting.
- ha
Admission StringControl Policy - The type of admission control policy to use with vSphere HA, which controls whether or not specific VM operations are permitted in the cluster in order to protect the reliability of the cluster. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Note that disabling admission control is not recommended and can lead to service issues.
- ha
Admission BooleanControl Resource Percentage Auto Compute - When ha_admission_control_policy is resourcePercentage, 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.
- ha
Admission IntegerControl Resource Percentage Cpu - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of CPU resources in the cluster to reserve for failover.
- ha
Admission IntegerControl Resource Percentage Memory - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of memory resources in the cluster to reserve for failover.
- ha
Admission IntegerControl Slot Policy Explicit Cpu - When ha_admission_control_policy is slotPolicy, this controls the user-defined CPU slot size, in MHz.
- ha
Admission IntegerControl Slot Policy Explicit Memory - When ha_admission_control_policy is slotPolicy, this controls the user-defined memory slot size, in MB.
- ha
Admission BooleanControl Slot Policy Use Explicit Size - When ha_admission_control_policy is slotPolicy, this setting controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is to gather a automatic average based on all powered-on virtual machines currently in the cluster.
- ha
Advanced Map<String,String>Options - Advanced configuration options for vSphere HA.
- ha
Datastore StringApd Recovery Action - When ha_vm_component_protection is enabled, 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.
- ha
Datastore StringApd Response - When ha_vm_component_protection is enabled, 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.
- ha
Datastore IntegerApd Response Delay - When ha_vm_component_protection is enabled, controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response.
- ha
Datastore StringPdl Response - When ha_vm_component_protection is enabled, 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.
- ha
Enabled Boolean - Enable vSphere HA for this cluster.
- ha
Heartbeat List<String>Datastore Ids - 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 StringDatastore Policy - The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference.
- ha
Host StringIsolation Response - 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.
- ha
Host StringMonitoring - Global setting that controls whether vSphere HA remediates VMs on host failure. Can be one of enabled or disabled.
- ha
Vm StringComponent Protection - Controls vSphere VM component protection for virtual machines in this cluster. This allows vSphere HA to react to failures between hosts and specific virtual machine components, such as datastores. Can be one of enabled or disabled.
- ha
Vm StringDependency Restart Condition - The condition used to determine whether or not VMs in a certain restart priority class are online, allowing HA to move on to restarting VMs on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen.
- ha
Vm IntegerFailure Interval - 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.
- ha
Vm IntegerMaximum Failure Window - 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.
- ha
Vm IntegerMaximum Resets - The maximum number of resets that HA will perform to a virtual machine when responding to a failure event.
- ha
Vm IntegerMinimum Uptime - The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats.
- ha
Vm StringMonitoring - The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
- ha
Vm IntegerRestart Additional Delay - Additional delay in seconds after ready condition is met. A VM is considered ready at this point.
- ha
Vm StringRestart Priority - The default restart priority for affected VMs when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest.
- ha
Vm IntegerRestart Timeout - 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.
- host
Cluster IntegerExit Timeout - The timeout for each host maintenance mode operation when removing hosts from a cluster.
- host
Image ComputeCluster Host Image - Details about the host image which should be applied to the cluster.
- host
Managed Boolean - Must be set if cluster enrollment is managed from host resource.
- host
System List<String>Ids - The managed object IDs of the hosts to put in the cluster.
- name String
- The name of the cluster.
- proactive
Ha StringAutomation Level - The DRS behavior for proactive HA recommendations. Can be one of Automated or Manual.
- proactive
Ha BooleanEnabled - Enables proactive HA, allowing for vSphere to get HA data from external providers and use DRS to perform remediation.
- proactive
Ha StringModerate Remediation - 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.
- proactive
Ha List<String>Provider Ids - The list of IDs for health update providers configured for this cluster.
- proactive
Ha StringSevere Remediation - 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.
- List<String>
- The IDs of any tags to attach to this resource.
- vsan
Compression BooleanEnabled - Whether the vSAN compression service is enabled for the cluster.
- vsan
Dedup BooleanEnabled - Whether the vSAN deduplication service is enabled for the cluster.
- vsan
Disk List<ComputeGroups Cluster Vsan Disk Group> - A list of disk UUIDs to add to the vSAN cluster.
- vsan
Dit BooleanEncryption Enabled - Whether the vSAN data-in-transit encryption is enabled for the cluster.
- vsan
Dit IntegerRekey Interval - When vsan_dit_encryption_enabled is enabled, sets the rekey interval of data-in-transit encryption (in minutes).
- vsan
Enabled Boolean - Whether the vSAN service is enabled for the cluster.
- vsan
Esa BooleanEnabled - Whether the vSAN ESA service is enabled for the cluster.
- vsan
Fault List<ComputeDomains Cluster Vsan Fault Domain> - The configuration for vSAN fault domains.
- vsan
Network BooleanDiagnostic Mode Enabled - Whether the vSAN network diagnostic mode is enabled for the cluster.
- vsan
Performance BooleanEnabled - Whether the vSAN performance service is enabled for the cluster.
- vsan
Remote List<String>Datastore Ids - The managed object IDs of the vSAN datastore to be mounted on the cluster.
- vsan
Stretched ComputeCluster Cluster Vsan Stretched Cluster - The configuration for stretched cluster.
- vsan
Unmap BooleanEnabled - Whether the vSAN unmap service is enabled for the cluster.
- vsan
Verbose BooleanMode Enabled - Whether the vSAN verbose mode is enabled for the cluster.
- datacenter
Id string - The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
- custom
Attributes {[key: string]: string} A map of custom attribute ids to attribute value strings to set for the datastore cluster.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter Server.
- dpm
Automation stringLevel - The automation level for host power operations in this cluster. Can be one of manual or automated.
- dpm
Enabled boolean - Enable DPM support for DRS. This allows you to dynamically control the power of hosts depending on the needs of virtual machines in the cluster. Requires that DRS be enabled.
- dpm
Threshold 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.
- drs
Advanced {[key: string]: string}Options - Advanced configuration options for DRS and DPM.
- drs
Automation stringLevel - The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated.
- drs
Enable booleanPredictive Drs - When true, enables DRS to use data from vRealize Operations Manager to make proactive DRS recommendations.
- drs
Enable booleanVm Overrides - When true, allows individual VM overrides within this cluster to be set.
- drs
Enabled boolean - Enable DRS for this cluster.
- drs
Migration numberThreshold - 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.
- string
- Enable scalable shares for all descendants of this cluster.
- 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 providedfolder
offoo/bar
, The provider will place a cluster namedcompute-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 booleanOn Destroy - Force removal of all hosts in the cluster during destroy and make them standalone hosts. Use of this flag mainly exists for testing and is not recommended in normal use.
- ha
Admission string[]Control Failover Host System Ids - When ha_admission_control_policy is failoverHosts, this 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 numberControl Host Failure Tolerance - 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.
- ha
Admission numberControl Performance Tolerance - The percentage of resource reduction that a cluster of VMs can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting.
- ha
Admission stringControl Policy - The type of admission control policy to use with vSphere HA, which controls whether or not specific VM operations are permitted in the cluster in order to protect the reliability of the cluster. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Note that disabling admission control is not recommended and can lead to service issues.
- ha
Admission booleanControl Resource Percentage Auto Compute - When ha_admission_control_policy is resourcePercentage, 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.
- ha
Admission numberControl Resource Percentage Cpu - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of CPU resources in the cluster to reserve for failover.
- ha
Admission numberControl Resource Percentage Memory - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of memory resources in the cluster to reserve for failover.
- ha
Admission numberControl Slot Policy Explicit Cpu - When ha_admission_control_policy is slotPolicy, this controls the user-defined CPU slot size, in MHz.
- ha
Admission numberControl Slot Policy Explicit Memory - When ha_admission_control_policy is slotPolicy, this controls the user-defined memory slot size, in MB.
- ha
Admission booleanControl Slot Policy Use Explicit Size - When ha_admission_control_policy is slotPolicy, this setting controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is to gather a automatic average based on all powered-on virtual machines currently in the cluster.
- ha
Advanced {[key: string]: string}Options - Advanced configuration options for vSphere HA.
- ha
Datastore stringApd Recovery Action - When ha_vm_component_protection is enabled, 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.
- ha
Datastore stringApd Response - When ha_vm_component_protection is enabled, 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.
- ha
Datastore numberApd Response Delay - When ha_vm_component_protection is enabled, controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response.
- ha
Datastore stringPdl Response - When ha_vm_component_protection is enabled, 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.
- ha
Enabled boolean - Enable vSphere HA for this cluster.
- ha
Heartbeat string[]Datastore Ids - 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 stringDatastore Policy - The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference.
- ha
Host stringIsolation Response - 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.
- ha
Host stringMonitoring - Global setting that controls whether vSphere HA remediates VMs on host failure. Can be one of enabled or disabled.
- ha
Vm stringComponent Protection - Controls vSphere VM component protection for virtual machines in this cluster. This allows vSphere HA to react to failures between hosts and specific virtual machine components, such as datastores. Can be one of enabled or disabled.
- ha
Vm stringDependency Restart Condition - The condition used to determine whether or not VMs in a certain restart priority class are online, allowing HA to move on to restarting VMs on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen.
- ha
Vm numberFailure Interval - 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.
- ha
Vm numberMaximum Failure Window - 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.
- ha
Vm numberMaximum Resets - The maximum number of resets that HA will perform to a virtual machine when responding to a failure event.
- ha
Vm numberMinimum Uptime - The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats.
- ha
Vm stringMonitoring - The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
- ha
Vm numberRestart Additional Delay - Additional delay in seconds after ready condition is met. A VM is considered ready at this point.
- ha
Vm stringRestart Priority - The default restart priority for affected VMs when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest.
- ha
Vm numberRestart Timeout - 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.
- host
Cluster numberExit Timeout - The timeout for each host maintenance mode operation when removing hosts from a cluster.
- host
Image ComputeCluster Host Image - Details about the host image which should be applied to the cluster.
- host
Managed boolean - Must be set if cluster enrollment is managed from host resource.
- host
System string[]Ids - The managed object IDs of the hosts to put in the cluster.
- name string
- The name of the cluster.
- proactive
Ha stringAutomation Level - The DRS behavior for proactive HA recommendations. Can be one of Automated or Manual.
- proactive
Ha booleanEnabled - Enables proactive HA, allowing for vSphere to get HA data from external providers and use DRS to perform remediation.
- proactive
Ha stringModerate Remediation - 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.
- proactive
Ha string[]Provider Ids - The list of IDs for health update providers configured for this cluster.
- proactive
Ha stringSevere Remediation - 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.
- string[]
- The IDs of any tags to attach to this resource.
- vsan
Compression booleanEnabled - Whether the vSAN compression service is enabled for the cluster.
- vsan
Dedup booleanEnabled - Whether the vSAN deduplication service is enabled for the cluster.
- vsan
Disk ComputeGroups Cluster Vsan Disk Group[] - A list of disk UUIDs to add to the vSAN cluster.
- vsan
Dit booleanEncryption Enabled - Whether the vSAN data-in-transit encryption is enabled for the cluster.
- vsan
Dit numberRekey Interval - When vsan_dit_encryption_enabled is enabled, sets the rekey interval of data-in-transit encryption (in minutes).
- vsan
Enabled boolean - Whether the vSAN service is enabled for the cluster.
- vsan
Esa booleanEnabled - Whether the vSAN ESA service is enabled for the cluster.
- vsan
Fault ComputeDomains Cluster Vsan Fault Domain[] - The configuration for vSAN fault domains.
- vsan
Network booleanDiagnostic Mode Enabled - Whether the vSAN network diagnostic mode is enabled for the cluster.
- vsan
Performance booleanEnabled - Whether the vSAN performance service is enabled for the cluster.
- vsan
Remote string[]Datastore Ids - The managed object IDs of the vSAN datastore to be mounted on the cluster.
- vsan
Stretched ComputeCluster Cluster Vsan Stretched Cluster - The configuration for stretched cluster.
- vsan
Unmap booleanEnabled - Whether the vSAN unmap service is enabled for the cluster.
- vsan
Verbose booleanMode Enabled - Whether the vSAN verbose mode is enabled for the cluster.
- datacenter_
id str - The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
- custom_
attributes Mapping[str, str] A map of custom attribute ids to attribute value strings to set for the datastore cluster.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter Server.
- dpm_
automation_ strlevel - The automation level for host power operations in this cluster. Can be one of manual or automated.
- dpm_
enabled bool - Enable DPM support for DRS. This allows you to dynamically control the power of hosts depending on the needs of virtual machines in the cluster. Requires that DRS be enabled.
- dpm_
threshold 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.
- drs_
advanced_ Mapping[str, str]options - Advanced configuration options for DRS and DPM.
- drs_
automation_ strlevel - The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated.
- drs_
enable_ boolpredictive_ drs - When true, enables DRS to use data from vRealize Operations Manager to make proactive DRS recommendations.
- drs_
enable_ boolvm_ overrides - When true, allows individual VM overrides within this cluster to be set.
- drs_
enabled bool - Enable DRS for this cluster.
- drs_
migration_ intthreshold - 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.
- str
- Enable scalable shares for all descendants of this cluster.
- 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 providedfolder
offoo/bar
, The provider will place a cluster namedcompute-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_ boolon_ destroy - Force removal of all hosts in the cluster during destroy and make them standalone hosts. Use of this flag mainly exists for testing and is not recommended in normal use.
- ha_
admission_ Sequence[str]control_ failover_ host_ system_ ids - When ha_admission_control_policy is failoverHosts, this 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_ intcontrol_ host_ failure_ tolerance - 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.
- ha_
admission_ intcontrol_ performance_ tolerance - The percentage of resource reduction that a cluster of VMs can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting.
- ha_
admission_ strcontrol_ policy - The type of admission control policy to use with vSphere HA, which controls whether or not specific VM operations are permitted in the cluster in order to protect the reliability of the cluster. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Note that disabling admission control is not recommended and can lead to service issues.
- ha_
admission_ boolcontrol_ resource_ percentage_ auto_ compute - When ha_admission_control_policy is resourcePercentage, 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.
- ha_
admission_ intcontrol_ resource_ percentage_ cpu - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of CPU resources in the cluster to reserve for failover.
- ha_
admission_ intcontrol_ resource_ percentage_ memory - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of memory resources in the cluster to reserve for failover.
- ha_
admission_ intcontrol_ slot_ policy_ explicit_ cpu - When ha_admission_control_policy is slotPolicy, this controls the user-defined CPU slot size, in MHz.
- ha_
admission_ intcontrol_ slot_ policy_ explicit_ memory - When ha_admission_control_policy is slotPolicy, this controls the user-defined memory slot size, in MB.
- ha_
admission_ boolcontrol_ slot_ policy_ use_ explicit_ size - When ha_admission_control_policy is slotPolicy, this setting controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is to gather a automatic average based on all powered-on virtual machines currently in the cluster.
- ha_
advanced_ Mapping[str, str]options - Advanced configuration options for vSphere HA.
- ha_
datastore_ strapd_ recovery_ action - When ha_vm_component_protection is enabled, 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.
- ha_
datastore_ strapd_ response - When ha_vm_component_protection is enabled, 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.
- ha_
datastore_ intapd_ response_ delay - When ha_vm_component_protection is enabled, controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response.
- ha_
datastore_ strpdl_ response - When ha_vm_component_protection is enabled, 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.
- ha_
enabled bool - Enable vSphere HA for this cluster.
- ha_
heartbeat_ Sequence[str]datastore_ ids - 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_ strdatastore_ policy - The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference.
- ha_
host_ strisolation_ response - 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.
- ha_
host_ strmonitoring - Global setting that controls whether vSphere HA remediates VMs on host failure. Can be one of enabled or disabled.
- ha_
vm_ strcomponent_ protection - Controls vSphere VM component protection for virtual machines in this cluster. This allows vSphere HA to react to failures between hosts and specific virtual machine components, such as datastores. Can be one of enabled or disabled.
- ha_
vm_ strdependency_ restart_ condition - The condition used to determine whether or not VMs in a certain restart priority class are online, allowing HA to move on to restarting VMs on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen.
- ha_
vm_ intfailure_ interval - 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.
- ha_
vm_ intmaximum_ failure_ window - 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.
- ha_
vm_ intmaximum_ resets - The maximum number of resets that HA will perform to a virtual machine when responding to a failure event.
- ha_
vm_ intminimum_ uptime - The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats.
- ha_
vm_ strmonitoring - The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
- ha_
vm_ intrestart_ additional_ delay - Additional delay in seconds after ready condition is met. A VM is considered ready at this point.
- ha_
vm_ strrestart_ priority - The default restart priority for affected VMs when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest.
- ha_
vm_ intrestart_ timeout - 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.
- host_
cluster_ intexit_ timeout - The timeout for each host maintenance mode operation when removing hosts from a cluster.
- host_
image ComputeCluster Host Image Args - Details about the host image which should be applied to the cluster.
- host_
managed bool - Must be set if cluster enrollment is managed from host resource.
- host_
system_ Sequence[str]ids - The managed object IDs of the hosts to put in the cluster.
- name str
- The name of the cluster.
- proactive_
ha_ strautomation_ level - The DRS behavior for proactive HA recommendations. Can be one of Automated or Manual.
- proactive_
ha_ boolenabled - Enables proactive HA, allowing for vSphere to get HA data from external providers and use DRS to perform remediation.
- proactive_
ha_ strmoderate_ remediation - 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.
- proactive_
ha_ Sequence[str]provider_ ids - The list of IDs for health update providers configured for this cluster.
- proactive_
ha_ strsevere_ remediation - 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.
- Sequence[str]
- The IDs of any tags to attach to this resource.
- vsan_
compression_ boolenabled - Whether the vSAN compression service is enabled for the cluster.
- vsan_
dedup_ boolenabled - Whether the vSAN deduplication service is enabled for the cluster.
- vsan_
disk_ Sequence[Computegroups Cluster Vsan Disk Group Args] - A list of disk UUIDs to add to the vSAN cluster.
- vsan_
dit_ boolencryption_ enabled - Whether the vSAN data-in-transit encryption is enabled for the cluster.
- vsan_
dit_ intrekey_ interval - When vsan_dit_encryption_enabled is enabled, sets the rekey interval of data-in-transit encryption (in minutes).
- vsan_
enabled bool - Whether the vSAN service is enabled for the cluster.
- vsan_
esa_ boolenabled - Whether the vSAN ESA service is enabled for the cluster.
- vsan_
fault_ Sequence[Computedomains Cluster Vsan Fault Domain Args] - The configuration for vSAN fault domains.
- vsan_
network_ booldiagnostic_ mode_ enabled - Whether the vSAN network diagnostic mode is enabled for the cluster.
- vsan_
performance_ boolenabled - Whether the vSAN performance service is enabled for the cluster.
- vsan_
remote_ Sequence[str]datastore_ ids - The managed object IDs of the vSAN datastore to be mounted on the cluster.
- vsan_
stretched_ Computecluster Cluster Vsan Stretched Cluster Args - The configuration for stretched cluster.
- vsan_
unmap_ boolenabled - Whether the vSAN unmap service is enabled for the cluster.
- vsan_
verbose_ boolmode_ enabled - Whether the vSAN verbose mode is enabled for the cluster.
- datacenter
Id String - The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
- custom
Attributes Map<String> A map of custom attribute ids to attribute value strings to set for the datastore cluster.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter Server.
- dpm
Automation StringLevel - The automation level for host power operations in this cluster. Can be one of manual or automated.
- dpm
Enabled Boolean - Enable DPM support for DRS. This allows you to dynamically control the power of hosts depending on the needs of virtual machines in the cluster. Requires that DRS be enabled.
- dpm
Threshold 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.
- drs
Advanced Map<String>Options - Advanced configuration options for DRS and DPM.
- drs
Automation StringLevel - The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated.
- drs
Enable BooleanPredictive Drs - When true, enables DRS to use data from vRealize Operations Manager to make proactive DRS recommendations.
- drs
Enable BooleanVm Overrides - When true, allows individual VM overrides within this cluster to be set.
- drs
Enabled Boolean - Enable DRS for this cluster.
- drs
Migration NumberThreshold - 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.
- String
- Enable scalable shares for all descendants of this cluster.
- 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 providedfolder
offoo/bar
, The provider will place a cluster namedcompute-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 BooleanOn Destroy - Force removal of all hosts in the cluster during destroy and make them standalone hosts. Use of this flag mainly exists for testing and is not recommended in normal use.
- ha
Admission List<String>Control Failover Host System Ids - When ha_admission_control_policy is failoverHosts, this 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 NumberControl Host Failure Tolerance - 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.
- ha
Admission NumberControl Performance Tolerance - The percentage of resource reduction that a cluster of VMs can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting.
- ha
Admission StringControl Policy - The type of admission control policy to use with vSphere HA, which controls whether or not specific VM operations are permitted in the cluster in order to protect the reliability of the cluster. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Note that disabling admission control is not recommended and can lead to service issues.
- ha
Admission BooleanControl Resource Percentage Auto Compute - When ha_admission_control_policy is resourcePercentage, 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.
- ha
Admission NumberControl Resource Percentage Cpu - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of CPU resources in the cluster to reserve for failover.
- ha
Admission NumberControl Resource Percentage Memory - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of memory resources in the cluster to reserve for failover.
- ha
Admission NumberControl Slot Policy Explicit Cpu - When ha_admission_control_policy is slotPolicy, this controls the user-defined CPU slot size, in MHz.
- ha
Admission NumberControl Slot Policy Explicit Memory - When ha_admission_control_policy is slotPolicy, this controls the user-defined memory slot size, in MB.
- ha
Admission BooleanControl Slot Policy Use Explicit Size - When ha_admission_control_policy is slotPolicy, this setting controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is to gather a automatic average based on all powered-on virtual machines currently in the cluster.
- ha
Advanced Map<String>Options - Advanced configuration options for vSphere HA.
- ha
Datastore StringApd Recovery Action - When ha_vm_component_protection is enabled, 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.
- ha
Datastore StringApd Response - When ha_vm_component_protection is enabled, 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.
- ha
Datastore NumberApd Response Delay - When ha_vm_component_protection is enabled, controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response.
- ha
Datastore StringPdl Response - When ha_vm_component_protection is enabled, 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.
- ha
Enabled Boolean - Enable vSphere HA for this cluster.
- ha
Heartbeat List<String>Datastore Ids - 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 StringDatastore Policy - The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference.
- ha
Host StringIsolation Response - 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.
- ha
Host StringMonitoring - Global setting that controls whether vSphere HA remediates VMs on host failure. Can be one of enabled or disabled.
- ha
Vm StringComponent Protection - Controls vSphere VM component protection for virtual machines in this cluster. This allows vSphere HA to react to failures between hosts and specific virtual machine components, such as datastores. Can be one of enabled or disabled.
- ha
Vm StringDependency Restart Condition - The condition used to determine whether or not VMs in a certain restart priority class are online, allowing HA to move on to restarting VMs on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen.
- ha
Vm NumberFailure Interval - 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.
- ha
Vm NumberMaximum Failure Window - 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.
- ha
Vm NumberMaximum Resets - The maximum number of resets that HA will perform to a virtual machine when responding to a failure event.
- ha
Vm NumberMinimum Uptime - The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats.
- ha
Vm StringMonitoring - The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
- ha
Vm NumberRestart Additional Delay - Additional delay in seconds after ready condition is met. A VM is considered ready at this point.
- ha
Vm StringRestart Priority - The default restart priority for affected VMs when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest.
- ha
Vm NumberRestart Timeout - 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.
- host
Cluster NumberExit Timeout - The timeout for each host maintenance mode operation when removing hosts from a cluster.
- host
Image Property Map - Details about the host image which should be applied to the cluster.
- host
Managed Boolean - Must be set if cluster enrollment is managed from host resource.
- host
System List<String>Ids - The managed object IDs of the hosts to put in the cluster.
- name String
- The name of the cluster.
- proactive
Ha StringAutomation Level - The DRS behavior for proactive HA recommendations. Can be one of Automated or Manual.
- proactive
Ha BooleanEnabled - Enables proactive HA, allowing for vSphere to get HA data from external providers and use DRS to perform remediation.
- proactive
Ha StringModerate Remediation - 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.
- proactive
Ha List<String>Provider Ids - The list of IDs for health update providers configured for this cluster.
- proactive
Ha StringSevere Remediation - 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.
- List<String>
- The IDs of any tags to attach to this resource.
- vsan
Compression BooleanEnabled - Whether the vSAN compression service is enabled for the cluster.
- vsan
Dedup BooleanEnabled - Whether the vSAN deduplication service is enabled for the cluster.
- vsan
Disk List<Property Map>Groups - A list of disk UUIDs to add to the vSAN cluster.
- vsan
Dit BooleanEncryption Enabled - Whether the vSAN data-in-transit encryption is enabled for the cluster.
- vsan
Dit NumberRekey Interval - When vsan_dit_encryption_enabled is enabled, sets the rekey interval of data-in-transit encryption (in minutes).
- vsan
Enabled Boolean - Whether the vSAN service is enabled for the cluster.
- vsan
Esa BooleanEnabled - Whether the vSAN ESA service is enabled for the cluster.
- vsan
Fault List<Property Map>Domains - The configuration for vSAN fault domains.
- vsan
Network BooleanDiagnostic Mode Enabled - Whether the vSAN network diagnostic mode is enabled for the cluster.
- vsan
Performance BooleanEnabled - Whether the vSAN performance service is enabled for the cluster.
- vsan
Remote List<String>Datastore Ids - The managed object IDs of the vSAN datastore to be mounted on the cluster.
- vsan
Stretched Property MapCluster - The configuration for stretched cluster.
- vsan
Unmap BooleanEnabled - Whether the vSAN unmap service is enabled for the cluster.
- vsan
Verbose BooleanMode Enabled - Whether the vSAN verbose mode is enabled for the cluster.
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.
- Resource
Pool stringId - The managed object ID of the primary
resource pool for this cluster. This can be passed directly to the
resource_pool_id
attribute of thevsphere.VirtualMachine
resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Resource
Pool stringId - The managed object ID of the primary
resource pool for this cluster. This can be passed directly to the
resource_pool_id
attribute of thevsphere.VirtualMachine
resource.
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Pool StringId - The managed object ID of the primary
resource pool for this cluster. This can be passed directly to the
resource_pool_id
attribute of thevsphere.VirtualMachine
resource.
- id string
- The provider-assigned unique ID for this managed resource.
- resource
Pool stringId - The managed object ID of the primary
resource pool for this cluster. This can be passed directly to the
resource_pool_id
attribute of thevsphere.VirtualMachine
resource.
- id str
- The provider-assigned unique ID for this managed resource.
- resource_
pool_ strid - The managed object ID of the primary
resource pool for this cluster. This can be passed directly to the
resource_pool_id
attribute of thevsphere.VirtualMachine
resource.
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Pool StringId - The managed object ID of the primary
resource pool for this cluster. This can be passed directly to the
resource_pool_id
attribute of thevsphere.VirtualMachine
resource.
Look up 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
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
custom_attributes: Optional[Mapping[str, str]] = None,
datacenter_id: Optional[str] = None,
dpm_automation_level: Optional[str] = None,
dpm_enabled: Optional[bool] = None,
dpm_threshold: Optional[int] = None,
drs_advanced_options: Optional[Mapping[str, str]] = None,
drs_automation_level: Optional[str] = None,
drs_enable_predictive_drs: Optional[bool] = None,
drs_enable_vm_overrides: Optional[bool] = None,
drs_enabled: Optional[bool] = None,
drs_migration_threshold: Optional[int] = None,
drs_scale_descendants_shares: Optional[str] = None,
folder: Optional[str] = None,
force_evacuate_on_destroy: Optional[bool] = None,
ha_admission_control_failover_host_system_ids: Optional[Sequence[str]] = None,
ha_admission_control_host_failure_tolerance: Optional[int] = None,
ha_admission_control_performance_tolerance: Optional[int] = None,
ha_admission_control_policy: Optional[str] = None,
ha_admission_control_resource_percentage_auto_compute: Optional[bool] = None,
ha_admission_control_resource_percentage_cpu: Optional[int] = None,
ha_admission_control_resource_percentage_memory: Optional[int] = None,
ha_admission_control_slot_policy_explicit_cpu: Optional[int] = None,
ha_admission_control_slot_policy_explicit_memory: Optional[int] = None,
ha_admission_control_slot_policy_use_explicit_size: Optional[bool] = None,
ha_advanced_options: Optional[Mapping[str, str]] = None,
ha_datastore_apd_recovery_action: Optional[str] = None,
ha_datastore_apd_response: Optional[str] = None,
ha_datastore_apd_response_delay: Optional[int] = None,
ha_datastore_pdl_response: Optional[str] = None,
ha_enabled: Optional[bool] = None,
ha_heartbeat_datastore_ids: Optional[Sequence[str]] = None,
ha_heartbeat_datastore_policy: Optional[str] = None,
ha_host_isolation_response: Optional[str] = None,
ha_host_monitoring: Optional[str] = None,
ha_vm_component_protection: Optional[str] = None,
ha_vm_dependency_restart_condition: Optional[str] = None,
ha_vm_failure_interval: Optional[int] = None,
ha_vm_maximum_failure_window: Optional[int] = None,
ha_vm_maximum_resets: Optional[int] = None,
ha_vm_minimum_uptime: Optional[int] = None,
ha_vm_monitoring: Optional[str] = None,
ha_vm_restart_additional_delay: Optional[int] = None,
ha_vm_restart_priority: Optional[str] = None,
ha_vm_restart_timeout: Optional[int] = None,
host_cluster_exit_timeout: Optional[int] = None,
host_image: Optional[ComputeClusterHostImageArgs] = None,
host_managed: Optional[bool] = None,
host_system_ids: Optional[Sequence[str]] = None,
name: Optional[str] = None,
proactive_ha_automation_level: Optional[str] = None,
proactive_ha_enabled: Optional[bool] = None,
proactive_ha_moderate_remediation: Optional[str] = None,
proactive_ha_provider_ids: Optional[Sequence[str]] = None,
proactive_ha_severe_remediation: Optional[str] = None,
resource_pool_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
vsan_compression_enabled: Optional[bool] = None,
vsan_dedup_enabled: Optional[bool] = None,
vsan_disk_groups: Optional[Sequence[ComputeClusterVsanDiskGroupArgs]] = None,
vsan_dit_encryption_enabled: Optional[bool] = None,
vsan_dit_rekey_interval: Optional[int] = None,
vsan_enabled: Optional[bool] = None,
vsan_esa_enabled: Optional[bool] = None,
vsan_fault_domains: Optional[Sequence[ComputeClusterVsanFaultDomainArgs]] = None,
vsan_network_diagnostic_mode_enabled: Optional[bool] = None,
vsan_performance_enabled: Optional[bool] = None,
vsan_remote_datastore_ids: Optional[Sequence[str]] = None,
vsan_stretched_cluster: Optional[ComputeClusterVsanStretchedClusterArgs] = None,
vsan_unmap_enabled: Optional[bool] = None,
vsan_verbose_mode_enabled: Optional[bool] = None) -> ComputeCluster
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)
public static ComputeCluster get(String name, Output<String> id, ComputeClusterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Custom
Attributes Dictionary<string, string> A map of custom attribute ids to attribute value strings to set for the datastore cluster.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter Server.
- Datacenter
Id string - The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
- Dpm
Automation stringLevel - The automation level for host power operations in this cluster. Can be one of manual or automated.
- Dpm
Enabled bool - Enable DPM support for DRS. This allows you to dynamically control the power of hosts depending on the needs of virtual machines in the cluster. Requires that DRS be enabled.
- Dpm
Threshold 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.
- Drs
Advanced Dictionary<string, string>Options - Advanced configuration options for DRS and DPM.
- Drs
Automation stringLevel - The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated.
- Drs
Enable boolPredictive Drs - When true, enables DRS to use data from vRealize Operations Manager to make proactive DRS recommendations.
- Drs
Enable boolVm Overrides - When true, allows individual VM overrides within this cluster to be set.
- Drs
Enabled bool - Enable DRS for this cluster.
- Drs
Migration intThreshold - 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.
- string
- Enable scalable shares for all descendants of this cluster.
- 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 providedfolder
offoo/bar
, The provider will place a cluster namedcompute-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 boolOn Destroy - Force removal of all hosts in the cluster during destroy and make them standalone hosts. Use of this flag mainly exists for testing and is not recommended in normal use.
- Ha
Admission List<string>Control Failover Host System Ids - When ha_admission_control_policy is failoverHosts, this 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 intControl Host Failure Tolerance - 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.
- Ha
Admission intControl Performance Tolerance - The percentage of resource reduction that a cluster of VMs can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting.
- Ha
Admission stringControl Policy - The type of admission control policy to use with vSphere HA, which controls whether or not specific VM operations are permitted in the cluster in order to protect the reliability of the cluster. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Note that disabling admission control is not recommended and can lead to service issues.
- Ha
Admission boolControl Resource Percentage Auto Compute - When ha_admission_control_policy is resourcePercentage, 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.
- Ha
Admission intControl Resource Percentage Cpu - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of CPU resources in the cluster to reserve for failover.
- Ha
Admission intControl Resource Percentage Memory - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of memory resources in the cluster to reserve for failover.
- Ha
Admission intControl Slot Policy Explicit Cpu - When ha_admission_control_policy is slotPolicy, this controls the user-defined CPU slot size, in MHz.
- Ha
Admission intControl Slot Policy Explicit Memory - When ha_admission_control_policy is slotPolicy, this controls the user-defined memory slot size, in MB.
- Ha
Admission boolControl Slot Policy Use Explicit Size - When ha_admission_control_policy is slotPolicy, this setting controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is to gather a automatic average based on all powered-on virtual machines currently in the cluster.
- Ha
Advanced Dictionary<string, string>Options - Advanced configuration options for vSphere HA.
- Ha
Datastore stringApd Recovery Action - When ha_vm_component_protection is enabled, 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.
- Ha
Datastore stringApd Response - When ha_vm_component_protection is enabled, 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.
- Ha
Datastore intApd Response Delay - When ha_vm_component_protection is enabled, controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response.
- Ha
Datastore stringPdl Response - When ha_vm_component_protection is enabled, 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.
- Ha
Enabled bool - Enable vSphere HA for this cluster.
- Ha
Heartbeat List<string>Datastore Ids - 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 stringDatastore Policy - The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference.
- Ha
Host stringIsolation Response - 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.
- Ha
Host stringMonitoring - Global setting that controls whether vSphere HA remediates VMs on host failure. Can be one of enabled or disabled.
- Ha
Vm stringComponent Protection - Controls vSphere VM component protection for virtual machines in this cluster. This allows vSphere HA to react to failures between hosts and specific virtual machine components, such as datastores. Can be one of enabled or disabled.
- Ha
Vm stringDependency Restart Condition - The condition used to determine whether or not VMs in a certain restart priority class are online, allowing HA to move on to restarting VMs on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen.
- Ha
Vm intFailure Interval - 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.
- Ha
Vm intMaximum Failure Window - 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.
- Ha
Vm intMaximum Resets - The maximum number of resets that HA will perform to a virtual machine when responding to a failure event.
- Ha
Vm intMinimum Uptime - The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats.
- Ha
Vm stringMonitoring - The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
- Ha
Vm intRestart Additional Delay - Additional delay in seconds after ready condition is met. A VM is considered ready at this point.
- Ha
Vm stringRestart Priority - The default restart priority for affected VMs when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest.
- Ha
Vm intRestart Timeout - 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.
- Host
Cluster intExit Timeout - The timeout for each host maintenance mode operation when removing hosts from a cluster.
- Host
Image Pulumi.VSphere. Inputs. Compute Cluster Host Image - Details about the host image which should be applied to the cluster.
- Host
Managed bool - Must be set if cluster enrollment is managed from host resource.
- Host
System List<string>Ids - The managed object IDs of the hosts to put in the cluster.
- Name string
- The name of the cluster.
- Proactive
Ha stringAutomation Level - The DRS behavior for proactive HA recommendations. Can be one of Automated or Manual.
- Proactive
Ha boolEnabled - Enables proactive HA, allowing for vSphere to get HA data from external providers and use DRS to perform remediation.
- Proactive
Ha stringModerate Remediation - 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.
- Proactive
Ha List<string>Provider Ids - The list of IDs for health update providers configured for this cluster.
- Proactive
Ha stringSevere Remediation - 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.
- Resource
Pool stringId - The managed object ID of the primary
resource pool for this cluster. This can be passed directly to the
resource_pool_id
attribute of thevsphere.VirtualMachine
resource. - List<string>
- The IDs of any tags to attach to this resource.
- Vsan
Compression boolEnabled - Whether the vSAN compression service is enabled for the cluster.
- Vsan
Dedup boolEnabled - Whether the vSAN deduplication service is enabled for the cluster.
- Vsan
Disk List<Pulumi.Groups VSphere. Inputs. Compute Cluster Vsan Disk Group> - A list of disk UUIDs to add to the vSAN cluster.
- Vsan
Dit boolEncryption Enabled - Whether the vSAN data-in-transit encryption is enabled for the cluster.
- Vsan
Dit intRekey Interval - When vsan_dit_encryption_enabled is enabled, sets the rekey interval of data-in-transit encryption (in minutes).
- Vsan
Enabled bool - Whether the vSAN service is enabled for the cluster.
- Vsan
Esa boolEnabled - Whether the vSAN ESA service is enabled for the cluster.
- Vsan
Fault List<Pulumi.Domains VSphere. Inputs. Compute Cluster Vsan Fault Domain> - The configuration for vSAN fault domains.
- Vsan
Network boolDiagnostic Mode Enabled - Whether the vSAN network diagnostic mode is enabled for the cluster.
- Vsan
Performance boolEnabled - Whether the vSAN performance service is enabled for the cluster.
- Vsan
Remote List<string>Datastore Ids - The managed object IDs of the vSAN datastore to be mounted on the cluster.
- Vsan
Stretched Pulumi.Cluster VSphere. Inputs. Compute Cluster Vsan Stretched Cluster - The configuration for stretched cluster.
- Vsan
Unmap boolEnabled - Whether the vSAN unmap service is enabled for the cluster.
- Vsan
Verbose boolMode Enabled - Whether the vSAN verbose mode is enabled for the cluster.
- Custom
Attributes map[string]string A map of custom attribute ids to attribute value strings to set for the datastore cluster.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter Server.
- Datacenter
Id string - The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
- Dpm
Automation stringLevel - The automation level for host power operations in this cluster. Can be one of manual or automated.
- Dpm
Enabled bool - Enable DPM support for DRS. This allows you to dynamically control the power of hosts depending on the needs of virtual machines in the cluster. Requires that DRS be enabled.
- Dpm
Threshold 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.
- Drs
Advanced map[string]stringOptions - Advanced configuration options for DRS and DPM.
- Drs
Automation stringLevel - The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated.
- Drs
Enable boolPredictive Drs - When true, enables DRS to use data from vRealize Operations Manager to make proactive DRS recommendations.
- Drs
Enable boolVm Overrides - When true, allows individual VM overrides within this cluster to be set.
- Drs
Enabled bool - Enable DRS for this cluster.
- Drs
Migration intThreshold - 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.
- string
- Enable scalable shares for all descendants of this cluster.
- 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 providedfolder
offoo/bar
, The provider will place a cluster namedcompute-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 boolOn Destroy - Force removal of all hosts in the cluster during destroy and make them standalone hosts. Use of this flag mainly exists for testing and is not recommended in normal use.
- Ha
Admission []stringControl Failover Host System Ids - When ha_admission_control_policy is failoverHosts, this 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 intControl Host Failure Tolerance - 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.
- Ha
Admission intControl Performance Tolerance - The percentage of resource reduction that a cluster of VMs can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting.
- Ha
Admission stringControl Policy - The type of admission control policy to use with vSphere HA, which controls whether or not specific VM operations are permitted in the cluster in order to protect the reliability of the cluster. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Note that disabling admission control is not recommended and can lead to service issues.
- Ha
Admission boolControl Resource Percentage Auto Compute - When ha_admission_control_policy is resourcePercentage, 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.
- Ha
Admission intControl Resource Percentage Cpu - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of CPU resources in the cluster to reserve for failover.
- Ha
Admission intControl Resource Percentage Memory - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of memory resources in the cluster to reserve for failover.
- Ha
Admission intControl Slot Policy Explicit Cpu - When ha_admission_control_policy is slotPolicy, this controls the user-defined CPU slot size, in MHz.
- Ha
Admission intControl Slot Policy Explicit Memory - When ha_admission_control_policy is slotPolicy, this controls the user-defined memory slot size, in MB.
- Ha
Admission boolControl Slot Policy Use Explicit Size - When ha_admission_control_policy is slotPolicy, this setting controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is to gather a automatic average based on all powered-on virtual machines currently in the cluster.
- Ha
Advanced map[string]stringOptions - Advanced configuration options for vSphere HA.
- Ha
Datastore stringApd Recovery Action - When ha_vm_component_protection is enabled, 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.
- Ha
Datastore stringApd Response - When ha_vm_component_protection is enabled, 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.
- Ha
Datastore intApd Response Delay - When ha_vm_component_protection is enabled, controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response.
- Ha
Datastore stringPdl Response - When ha_vm_component_protection is enabled, 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.
- Ha
Enabled bool - Enable vSphere HA for this cluster.
- Ha
Heartbeat []stringDatastore Ids - 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 stringDatastore Policy - The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference.
- Ha
Host stringIsolation Response - 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.
- Ha
Host stringMonitoring - Global setting that controls whether vSphere HA remediates VMs on host failure. Can be one of enabled or disabled.
- Ha
Vm stringComponent Protection - Controls vSphere VM component protection for virtual machines in this cluster. This allows vSphere HA to react to failures between hosts and specific virtual machine components, such as datastores. Can be one of enabled or disabled.
- Ha
Vm stringDependency Restart Condition - The condition used to determine whether or not VMs in a certain restart priority class are online, allowing HA to move on to restarting VMs on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen.
- Ha
Vm intFailure Interval - 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.
- Ha
Vm intMaximum Failure Window - 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.
- Ha
Vm intMaximum Resets - The maximum number of resets that HA will perform to a virtual machine when responding to a failure event.
- Ha
Vm intMinimum Uptime - The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats.
- Ha
Vm stringMonitoring - The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
- Ha
Vm intRestart Additional Delay - Additional delay in seconds after ready condition is met. A VM is considered ready at this point.
- Ha
Vm stringRestart Priority - The default restart priority for affected VMs when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest.
- Ha
Vm intRestart Timeout - 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.
- Host
Cluster intExit Timeout - The timeout for each host maintenance mode operation when removing hosts from a cluster.
- Host
Image ComputeCluster Host Image Args - Details about the host image which should be applied to the cluster.
- Host
Managed bool - Must be set if cluster enrollment is managed from host resource.
- Host
System []stringIds - The managed object IDs of the hosts to put in the cluster.
- Name string
- The name of the cluster.
- Proactive
Ha stringAutomation Level - The DRS behavior for proactive HA recommendations. Can be one of Automated or Manual.
- Proactive
Ha boolEnabled - Enables proactive HA, allowing for vSphere to get HA data from external providers and use DRS to perform remediation.
- Proactive
Ha stringModerate Remediation - 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.
- Proactive
Ha []stringProvider Ids - The list of IDs for health update providers configured for this cluster.
- Proactive
Ha stringSevere Remediation - 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.
- Resource
Pool stringId - The managed object ID of the primary
resource pool for this cluster. This can be passed directly to the
resource_pool_id
attribute of thevsphere.VirtualMachine
resource. - []string
- The IDs of any tags to attach to this resource.
- Vsan
Compression boolEnabled - Whether the vSAN compression service is enabled for the cluster.
- Vsan
Dedup boolEnabled - Whether the vSAN deduplication service is enabled for the cluster.
- Vsan
Disk []ComputeGroups Cluster Vsan Disk Group Args - A list of disk UUIDs to add to the vSAN cluster.
- Vsan
Dit boolEncryption Enabled - Whether the vSAN data-in-transit encryption is enabled for the cluster.
- Vsan
Dit intRekey Interval - When vsan_dit_encryption_enabled is enabled, sets the rekey interval of data-in-transit encryption (in minutes).
- Vsan
Enabled bool - Whether the vSAN service is enabled for the cluster.
- Vsan
Esa boolEnabled - Whether the vSAN ESA service is enabled for the cluster.
- Vsan
Fault []ComputeDomains Cluster Vsan Fault Domain Args - The configuration for vSAN fault domains.
- Vsan
Network boolDiagnostic Mode Enabled - Whether the vSAN network diagnostic mode is enabled for the cluster.
- Vsan
Performance boolEnabled - Whether the vSAN performance service is enabled for the cluster.
- Vsan
Remote []stringDatastore Ids - The managed object IDs of the vSAN datastore to be mounted on the cluster.
- Vsan
Stretched ComputeCluster Cluster Vsan Stretched Cluster Args - The configuration for stretched cluster.
- Vsan
Unmap boolEnabled - Whether the vSAN unmap service is enabled for the cluster.
- Vsan
Verbose boolMode Enabled - Whether the vSAN verbose mode is enabled for the cluster.
- custom
Attributes Map<String,String> A map of custom attribute ids to attribute value strings to set for the datastore cluster.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter Server.
- datacenter
Id String - The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
- dpm
Automation StringLevel - The automation level for host power operations in this cluster. Can be one of manual or automated.
- dpm
Enabled Boolean - Enable DPM support for DRS. This allows you to dynamically control the power of hosts depending on the needs of virtual machines in the cluster. Requires that DRS be enabled.
- dpm
Threshold Integer - 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.
- drs
Advanced Map<String,String>Options - Advanced configuration options for DRS and DPM.
- drs
Automation StringLevel - The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated.
- drs
Enable BooleanPredictive Drs - When true, enables DRS to use data from vRealize Operations Manager to make proactive DRS recommendations.
- drs
Enable BooleanVm Overrides - When true, allows individual VM overrides within this cluster to be set.
- drs
Enabled Boolean - Enable DRS for this cluster.
- drs
Migration IntegerThreshold - 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.
- String
- Enable scalable shares for all descendants of this cluster.
- 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 providedfolder
offoo/bar
, The provider will place a cluster namedcompute-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 BooleanOn Destroy - Force removal of all hosts in the cluster during destroy and make them standalone hosts. Use of this flag mainly exists for testing and is not recommended in normal use.
- ha
Admission List<String>Control Failover Host System Ids - When ha_admission_control_policy is failoverHosts, this 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 IntegerControl Host Failure Tolerance - 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.
- ha
Admission IntegerControl Performance Tolerance - The percentage of resource reduction that a cluster of VMs can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting.
- ha
Admission StringControl Policy - The type of admission control policy to use with vSphere HA, which controls whether or not specific VM operations are permitted in the cluster in order to protect the reliability of the cluster. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Note that disabling admission control is not recommended and can lead to service issues.
- ha
Admission BooleanControl Resource Percentage Auto Compute - When ha_admission_control_policy is resourcePercentage, 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.
- ha
Admission IntegerControl Resource Percentage Cpu - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of CPU resources in the cluster to reserve for failover.
- ha
Admission IntegerControl Resource Percentage Memory - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of memory resources in the cluster to reserve for failover.
- ha
Admission IntegerControl Slot Policy Explicit Cpu - When ha_admission_control_policy is slotPolicy, this controls the user-defined CPU slot size, in MHz.
- ha
Admission IntegerControl Slot Policy Explicit Memory - When ha_admission_control_policy is slotPolicy, this controls the user-defined memory slot size, in MB.
- ha
Admission BooleanControl Slot Policy Use Explicit Size - When ha_admission_control_policy is slotPolicy, this setting controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is to gather a automatic average based on all powered-on virtual machines currently in the cluster.
- ha
Advanced Map<String,String>Options - Advanced configuration options for vSphere HA.
- ha
Datastore StringApd Recovery Action - When ha_vm_component_protection is enabled, 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.
- ha
Datastore StringApd Response - When ha_vm_component_protection is enabled, 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.
- ha
Datastore IntegerApd Response Delay - When ha_vm_component_protection is enabled, controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response.
- ha
Datastore StringPdl Response - When ha_vm_component_protection is enabled, 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.
- ha
Enabled Boolean - Enable vSphere HA for this cluster.
- ha
Heartbeat List<String>Datastore Ids - 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 StringDatastore Policy - The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference.
- ha
Host StringIsolation Response - 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.
- ha
Host StringMonitoring - Global setting that controls whether vSphere HA remediates VMs on host failure. Can be one of enabled or disabled.
- ha
Vm StringComponent Protection - Controls vSphere VM component protection for virtual machines in this cluster. This allows vSphere HA to react to failures between hosts and specific virtual machine components, such as datastores. Can be one of enabled or disabled.
- ha
Vm StringDependency Restart Condition - The condition used to determine whether or not VMs in a certain restart priority class are online, allowing HA to move on to restarting VMs on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen.
- ha
Vm IntegerFailure Interval - 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.
- ha
Vm IntegerMaximum Failure Window - 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.
- ha
Vm IntegerMaximum Resets - The maximum number of resets that HA will perform to a virtual machine when responding to a failure event.
- ha
Vm IntegerMinimum Uptime - The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats.
- ha
Vm StringMonitoring - The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
- ha
Vm IntegerRestart Additional Delay - Additional delay in seconds after ready condition is met. A VM is considered ready at this point.
- ha
Vm StringRestart Priority - The default restart priority for affected VMs when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest.
- ha
Vm IntegerRestart Timeout - 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.
- host
Cluster IntegerExit Timeout - The timeout for each host maintenance mode operation when removing hosts from a cluster.
- host
Image ComputeCluster Host Image - Details about the host image which should be applied to the cluster.
- host
Managed Boolean - Must be set if cluster enrollment is managed from host resource.
- host
System List<String>Ids - The managed object IDs of the hosts to put in the cluster.
- name String
- The name of the cluster.
- proactive
Ha StringAutomation Level - The DRS behavior for proactive HA recommendations. Can be one of Automated or Manual.
- proactive
Ha BooleanEnabled - Enables proactive HA, allowing for vSphere to get HA data from external providers and use DRS to perform remediation.
- proactive
Ha StringModerate Remediation - 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.
- proactive
Ha List<String>Provider Ids - The list of IDs for health update providers configured for this cluster.
- proactive
Ha StringSevere Remediation - 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.
- resource
Pool StringId - The managed object ID of the primary
resource pool for this cluster. This can be passed directly to the
resource_pool_id
attribute of thevsphere.VirtualMachine
resource. - List<String>
- The IDs of any tags to attach to this resource.
- vsan
Compression BooleanEnabled - Whether the vSAN compression service is enabled for the cluster.
- vsan
Dedup BooleanEnabled - Whether the vSAN deduplication service is enabled for the cluster.
- vsan
Disk List<ComputeGroups Cluster Vsan Disk Group> - A list of disk UUIDs to add to the vSAN cluster.
- vsan
Dit BooleanEncryption Enabled - Whether the vSAN data-in-transit encryption is enabled for the cluster.
- vsan
Dit IntegerRekey Interval - When vsan_dit_encryption_enabled is enabled, sets the rekey interval of data-in-transit encryption (in minutes).
- vsan
Enabled Boolean - Whether the vSAN service is enabled for the cluster.
- vsan
Esa BooleanEnabled - Whether the vSAN ESA service is enabled for the cluster.
- vsan
Fault List<ComputeDomains Cluster Vsan Fault Domain> - The configuration for vSAN fault domains.
- vsan
Network BooleanDiagnostic Mode Enabled - Whether the vSAN network diagnostic mode is enabled for the cluster.
- vsan
Performance BooleanEnabled - Whether the vSAN performance service is enabled for the cluster.
- vsan
Remote List<String>Datastore Ids - The managed object IDs of the vSAN datastore to be mounted on the cluster.
- vsan
Stretched ComputeCluster Cluster Vsan Stretched Cluster - The configuration for stretched cluster.
- vsan
Unmap BooleanEnabled - Whether the vSAN unmap service is enabled for the cluster.
- vsan
Verbose BooleanMode Enabled - Whether the vSAN verbose mode is enabled for the cluster.
- custom
Attributes {[key: string]: string} A map of custom attribute ids to attribute value strings to set for the datastore cluster.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter Server.
- datacenter
Id string - The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
- dpm
Automation stringLevel - The automation level for host power operations in this cluster. Can be one of manual or automated.
- dpm
Enabled boolean - Enable DPM support for DRS. This allows you to dynamically control the power of hosts depending on the needs of virtual machines in the cluster. Requires that DRS be enabled.
- dpm
Threshold 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.
- drs
Advanced {[key: string]: string}Options - Advanced configuration options for DRS and DPM.
- drs
Automation stringLevel - The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated.
- drs
Enable booleanPredictive Drs - When true, enables DRS to use data from vRealize Operations Manager to make proactive DRS recommendations.
- drs
Enable booleanVm Overrides - When true, allows individual VM overrides within this cluster to be set.
- drs
Enabled boolean - Enable DRS for this cluster.
- drs
Migration numberThreshold - 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.
- string
- Enable scalable shares for all descendants of this cluster.
- 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 providedfolder
offoo/bar
, The provider will place a cluster namedcompute-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 booleanOn Destroy - Force removal of all hosts in the cluster during destroy and make them standalone hosts. Use of this flag mainly exists for testing and is not recommended in normal use.
- ha
Admission string[]Control Failover Host System Ids - When ha_admission_control_policy is failoverHosts, this 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 numberControl Host Failure Tolerance - 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.
- ha
Admission numberControl Performance Tolerance - The percentage of resource reduction that a cluster of VMs can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting.
- ha
Admission stringControl Policy - The type of admission control policy to use with vSphere HA, which controls whether or not specific VM operations are permitted in the cluster in order to protect the reliability of the cluster. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Note that disabling admission control is not recommended and can lead to service issues.
- ha
Admission booleanControl Resource Percentage Auto Compute - When ha_admission_control_policy is resourcePercentage, 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.
- ha
Admission numberControl Resource Percentage Cpu - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of CPU resources in the cluster to reserve for failover.
- ha
Admission numberControl Resource Percentage Memory - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of memory resources in the cluster to reserve for failover.
- ha
Admission numberControl Slot Policy Explicit Cpu - When ha_admission_control_policy is slotPolicy, this controls the user-defined CPU slot size, in MHz.
- ha
Admission numberControl Slot Policy Explicit Memory - When ha_admission_control_policy is slotPolicy, this controls the user-defined memory slot size, in MB.
- ha
Admission booleanControl Slot Policy Use Explicit Size - When ha_admission_control_policy is slotPolicy, this setting controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is to gather a automatic average based on all powered-on virtual machines currently in the cluster.
- ha
Advanced {[key: string]: string}Options - Advanced configuration options for vSphere HA.
- ha
Datastore stringApd Recovery Action - When ha_vm_component_protection is enabled, 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.
- ha
Datastore stringApd Response - When ha_vm_component_protection is enabled, 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.
- ha
Datastore numberApd Response Delay - When ha_vm_component_protection is enabled, controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response.
- ha
Datastore stringPdl Response - When ha_vm_component_protection is enabled, 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.
- ha
Enabled boolean - Enable vSphere HA for this cluster.
- ha
Heartbeat string[]Datastore Ids - 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 stringDatastore Policy - The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference.
- ha
Host stringIsolation Response - 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.
- ha
Host stringMonitoring - Global setting that controls whether vSphere HA remediates VMs on host failure. Can be one of enabled or disabled.
- ha
Vm stringComponent Protection - Controls vSphere VM component protection for virtual machines in this cluster. This allows vSphere HA to react to failures between hosts and specific virtual machine components, such as datastores. Can be one of enabled or disabled.
- ha
Vm stringDependency Restart Condition - The condition used to determine whether or not VMs in a certain restart priority class are online, allowing HA to move on to restarting VMs on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen.
- ha
Vm numberFailure Interval - 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.
- ha
Vm numberMaximum Failure Window - 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.
- ha
Vm numberMaximum Resets - The maximum number of resets that HA will perform to a virtual machine when responding to a failure event.
- ha
Vm numberMinimum Uptime - The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats.
- ha
Vm stringMonitoring - The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
- ha
Vm numberRestart Additional Delay - Additional delay in seconds after ready condition is met. A VM is considered ready at this point.
- ha
Vm stringRestart Priority - The default restart priority for affected VMs when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest.
- ha
Vm numberRestart Timeout - 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.
- host
Cluster numberExit Timeout - The timeout for each host maintenance mode operation when removing hosts from a cluster.
- host
Image ComputeCluster Host Image - Details about the host image which should be applied to the cluster.
- host
Managed boolean - Must be set if cluster enrollment is managed from host resource.
- host
System string[]Ids - The managed object IDs of the hosts to put in the cluster.
- name string
- The name of the cluster.
- proactive
Ha stringAutomation Level - The DRS behavior for proactive HA recommendations. Can be one of Automated or Manual.
- proactive
Ha booleanEnabled - Enables proactive HA, allowing for vSphere to get HA data from external providers and use DRS to perform remediation.
- proactive
Ha stringModerate Remediation - 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.
- proactive
Ha string[]Provider Ids - The list of IDs for health update providers configured for this cluster.
- proactive
Ha stringSevere Remediation - 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.
- resource
Pool stringId - The managed object ID of the primary
resource pool for this cluster. This can be passed directly to the
resource_pool_id
attribute of thevsphere.VirtualMachine
resource. - string[]
- The IDs of any tags to attach to this resource.
- vsan
Compression booleanEnabled - Whether the vSAN compression service is enabled for the cluster.
- vsan
Dedup booleanEnabled - Whether the vSAN deduplication service is enabled for the cluster.
- vsan
Disk ComputeGroups Cluster Vsan Disk Group[] - A list of disk UUIDs to add to the vSAN cluster.
- vsan
Dit booleanEncryption Enabled - Whether the vSAN data-in-transit encryption is enabled for the cluster.
- vsan
Dit numberRekey Interval - When vsan_dit_encryption_enabled is enabled, sets the rekey interval of data-in-transit encryption (in minutes).
- vsan
Enabled boolean - Whether the vSAN service is enabled for the cluster.
- vsan
Esa booleanEnabled - Whether the vSAN ESA service is enabled for the cluster.
- vsan
Fault ComputeDomains Cluster Vsan Fault Domain[] - The configuration for vSAN fault domains.
- vsan
Network booleanDiagnostic Mode Enabled - Whether the vSAN network diagnostic mode is enabled for the cluster.
- vsan
Performance booleanEnabled - Whether the vSAN performance service is enabled for the cluster.
- vsan
Remote string[]Datastore Ids - The managed object IDs of the vSAN datastore to be mounted on the cluster.
- vsan
Stretched ComputeCluster Cluster Vsan Stretched Cluster - The configuration for stretched cluster.
- vsan
Unmap booleanEnabled - Whether the vSAN unmap service is enabled for the cluster.
- vsan
Verbose booleanMode Enabled - Whether the vSAN verbose mode is enabled for the cluster.
- custom_
attributes Mapping[str, str] A map of custom attribute ids to attribute value strings to set for the datastore cluster.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter Server.
- datacenter_
id str - The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
- dpm_
automation_ strlevel - The automation level for host power operations in this cluster. Can be one of manual or automated.
- dpm_
enabled bool - Enable DPM support for DRS. This allows you to dynamically control the power of hosts depending on the needs of virtual machines in the cluster. Requires that DRS be enabled.
- dpm_
threshold 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.
- drs_
advanced_ Mapping[str, str]options - Advanced configuration options for DRS and DPM.
- drs_
automation_ strlevel - The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated.
- drs_
enable_ boolpredictive_ drs - When true, enables DRS to use data from vRealize Operations Manager to make proactive DRS recommendations.
- drs_
enable_ boolvm_ overrides - When true, allows individual VM overrides within this cluster to be set.
- drs_
enabled bool - Enable DRS for this cluster.
- drs_
migration_ intthreshold - 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.
- str
- Enable scalable shares for all descendants of this cluster.
- 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 providedfolder
offoo/bar
, The provider will place a cluster namedcompute-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_ boolon_ destroy - Force removal of all hosts in the cluster during destroy and make them standalone hosts. Use of this flag mainly exists for testing and is not recommended in normal use.
- ha_
admission_ Sequence[str]control_ failover_ host_ system_ ids - When ha_admission_control_policy is failoverHosts, this 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_ intcontrol_ host_ failure_ tolerance - 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.
- ha_
admission_ intcontrol_ performance_ tolerance - The percentage of resource reduction that a cluster of VMs can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting.
- ha_
admission_ strcontrol_ policy - The type of admission control policy to use with vSphere HA, which controls whether or not specific VM operations are permitted in the cluster in order to protect the reliability of the cluster. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Note that disabling admission control is not recommended and can lead to service issues.
- ha_
admission_ boolcontrol_ resource_ percentage_ auto_ compute - When ha_admission_control_policy is resourcePercentage, 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.
- ha_
admission_ intcontrol_ resource_ percentage_ cpu - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of CPU resources in the cluster to reserve for failover.
- ha_
admission_ intcontrol_ resource_ percentage_ memory - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of memory resources in the cluster to reserve for failover.
- ha_
admission_ intcontrol_ slot_ policy_ explicit_ cpu - When ha_admission_control_policy is slotPolicy, this controls the user-defined CPU slot size, in MHz.
- ha_
admission_ intcontrol_ slot_ policy_ explicit_ memory - When ha_admission_control_policy is slotPolicy, this controls the user-defined memory slot size, in MB.
- ha_
admission_ boolcontrol_ slot_ policy_ use_ explicit_ size - When ha_admission_control_policy is slotPolicy, this setting controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is to gather a automatic average based on all powered-on virtual machines currently in the cluster.
- ha_
advanced_ Mapping[str, str]options - Advanced configuration options for vSphere HA.
- ha_
datastore_ strapd_ recovery_ action - When ha_vm_component_protection is enabled, 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.
- ha_
datastore_ strapd_ response - When ha_vm_component_protection is enabled, 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.
- ha_
datastore_ intapd_ response_ delay - When ha_vm_component_protection is enabled, controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response.
- ha_
datastore_ strpdl_ response - When ha_vm_component_protection is enabled, 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.
- ha_
enabled bool - Enable vSphere HA for this cluster.
- ha_
heartbeat_ Sequence[str]datastore_ ids - 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_ strdatastore_ policy - The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference.
- ha_
host_ strisolation_ response - 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.
- ha_
host_ strmonitoring - Global setting that controls whether vSphere HA remediates VMs on host failure. Can be one of enabled or disabled.
- ha_
vm_ strcomponent_ protection - Controls vSphere VM component protection for virtual machines in this cluster. This allows vSphere HA to react to failures between hosts and specific virtual machine components, such as datastores. Can be one of enabled or disabled.
- ha_
vm_ strdependency_ restart_ condition - The condition used to determine whether or not VMs in a certain restart priority class are online, allowing HA to move on to restarting VMs on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen.
- ha_
vm_ intfailure_ interval - 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.
- ha_
vm_ intmaximum_ failure_ window - 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.
- ha_
vm_ intmaximum_ resets - The maximum number of resets that HA will perform to a virtual machine when responding to a failure event.
- ha_
vm_ intminimum_ uptime - The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats.
- ha_
vm_ strmonitoring - The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
- ha_
vm_ intrestart_ additional_ delay - Additional delay in seconds after ready condition is met. A VM is considered ready at this point.
- ha_
vm_ strrestart_ priority - The default restart priority for affected VMs when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest.
- ha_
vm_ intrestart_ timeout - 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.
- host_
cluster_ intexit_ timeout - The timeout for each host maintenance mode operation when removing hosts from a cluster.
- host_
image ComputeCluster Host Image Args - Details about the host image which should be applied to the cluster.
- host_
managed bool - Must be set if cluster enrollment is managed from host resource.
- host_
system_ Sequence[str]ids - The managed object IDs of the hosts to put in the cluster.
- name str
- The name of the cluster.
- proactive_
ha_ strautomation_ level - The DRS behavior for proactive HA recommendations. Can be one of Automated or Manual.
- proactive_
ha_ boolenabled - Enables proactive HA, allowing for vSphere to get HA data from external providers and use DRS to perform remediation.
- proactive_
ha_ strmoderate_ remediation - 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.
- proactive_
ha_ Sequence[str]provider_ ids - The list of IDs for health update providers configured for this cluster.
- proactive_
ha_ strsevere_ remediation - 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.
- resource_
pool_ strid - The managed object ID of the primary
resource pool for this cluster. This can be passed directly to the
resource_pool_id
attribute of thevsphere.VirtualMachine
resource. - Sequence[str]
- The IDs of any tags to attach to this resource.
- vsan_
compression_ boolenabled - Whether the vSAN compression service is enabled for the cluster.
- vsan_
dedup_ boolenabled - Whether the vSAN deduplication service is enabled for the cluster.
- vsan_
disk_ Sequence[Computegroups Cluster Vsan Disk Group Args] - A list of disk UUIDs to add to the vSAN cluster.
- vsan_
dit_ boolencryption_ enabled - Whether the vSAN data-in-transit encryption is enabled for the cluster.
- vsan_
dit_ intrekey_ interval - When vsan_dit_encryption_enabled is enabled, sets the rekey interval of data-in-transit encryption (in minutes).
- vsan_
enabled bool - Whether the vSAN service is enabled for the cluster.
- vsan_
esa_ boolenabled - Whether the vSAN ESA service is enabled for the cluster.
- vsan_
fault_ Sequence[Computedomains Cluster Vsan Fault Domain Args] - The configuration for vSAN fault domains.
- vsan_
network_ booldiagnostic_ mode_ enabled - Whether the vSAN network diagnostic mode is enabled for the cluster.
- vsan_
performance_ boolenabled - Whether the vSAN performance service is enabled for the cluster.
- vsan_
remote_ Sequence[str]datastore_ ids - The managed object IDs of the vSAN datastore to be mounted on the cluster.
- vsan_
stretched_ Computecluster Cluster Vsan Stretched Cluster Args - The configuration for stretched cluster.
- vsan_
unmap_ boolenabled - Whether the vSAN unmap service is enabled for the cluster.
- vsan_
verbose_ boolmode_ enabled - Whether the vSAN verbose mode is enabled for the cluster.
- custom
Attributes Map<String> A map of custom attribute ids to attribute value strings to set for the datastore cluster.
NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter Server.
- datacenter
Id String - The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.
- dpm
Automation StringLevel - The automation level for host power operations in this cluster. Can be one of manual or automated.
- dpm
Enabled Boolean - Enable DPM support for DRS. This allows you to dynamically control the power of hosts depending on the needs of virtual machines in the cluster. Requires that DRS be enabled.
- dpm
Threshold 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.
- drs
Advanced Map<String>Options - Advanced configuration options for DRS and DPM.
- drs
Automation StringLevel - The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated.
- drs
Enable BooleanPredictive Drs - When true, enables DRS to use data from vRealize Operations Manager to make proactive DRS recommendations.
- drs
Enable BooleanVm Overrides - When true, allows individual VM overrides within this cluster to be set.
- drs
Enabled Boolean - Enable DRS for this cluster.
- drs
Migration NumberThreshold - 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.
- String
- Enable scalable shares for all descendants of this cluster.
- 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 providedfolder
offoo/bar
, The provider will place a cluster namedcompute-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 BooleanOn Destroy - Force removal of all hosts in the cluster during destroy and make them standalone hosts. Use of this flag mainly exists for testing and is not recommended in normal use.
- ha
Admission List<String>Control Failover Host System Ids - When ha_admission_control_policy is failoverHosts, this 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 NumberControl Host Failure Tolerance - 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.
- ha
Admission NumberControl Performance Tolerance - The percentage of resource reduction that a cluster of VMs can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting.
- ha
Admission StringControl Policy - The type of admission control policy to use with vSphere HA, which controls whether or not specific VM operations are permitted in the cluster in order to protect the reliability of the cluster. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Note that disabling admission control is not recommended and can lead to service issues.
- ha
Admission BooleanControl Resource Percentage Auto Compute - When ha_admission_control_policy is resourcePercentage, 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.
- ha
Admission NumberControl Resource Percentage Cpu - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of CPU resources in the cluster to reserve for failover.
- ha
Admission NumberControl Resource Percentage Memory - When ha_admission_control_policy is resourcePercentage, this controls the user-defined percentage of memory resources in the cluster to reserve for failover.
- ha
Admission NumberControl Slot Policy Explicit Cpu - When ha_admission_control_policy is slotPolicy, this controls the user-defined CPU slot size, in MHz.
- ha
Admission NumberControl Slot Policy Explicit Memory - When ha_admission_control_policy is slotPolicy, this controls the user-defined memory slot size, in MB.
- ha
Admission BooleanControl Slot Policy Use Explicit Size - When ha_admission_control_policy is slotPolicy, this setting controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is to gather a automatic average based on all powered-on virtual machines currently in the cluster.
- ha
Advanced Map<String>Options - Advanced configuration options for vSphere HA.
- ha
Datastore StringApd Recovery Action - When ha_vm_component_protection is enabled, 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.
- ha
Datastore StringApd Response - When ha_vm_component_protection is enabled, 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.
- ha
Datastore NumberApd Response Delay - When ha_vm_component_protection is enabled, controls the delay in seconds to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response.
- ha
Datastore StringPdl Response - When ha_vm_component_protection is enabled, 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.
- ha
Enabled Boolean - Enable vSphere HA for this cluster.
- ha
Heartbeat List<String>Datastore Ids - 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 StringDatastore Policy - The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference.
- ha
Host StringIsolation Response - 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.
- ha
Host StringMonitoring - Global setting that controls whether vSphere HA remediates VMs on host failure. Can be one of enabled or disabled.
- ha
Vm StringComponent Protection - Controls vSphere VM component protection for virtual machines in this cluster. This allows vSphere HA to react to failures between hosts and specific virtual machine components, such as datastores. Can be one of enabled or disabled.
- ha
Vm StringDependency Restart Condition - The condition used to determine whether or not VMs in a certain restart priority class are online, allowing HA to move on to restarting VMs on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen.
- ha
Vm NumberFailure Interval - 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.
- ha
Vm NumberMaximum Failure Window - 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.
- ha
Vm NumberMaximum Resets - The maximum number of resets that HA will perform to a virtual machine when responding to a failure event.
- ha
Vm NumberMinimum Uptime - The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats.
- ha
Vm StringMonitoring - The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring.
- ha
Vm NumberRestart Additional Delay - Additional delay in seconds after ready condition is met. A VM is considered ready at this point.
- ha
Vm StringRestart Priority - The default restart priority for affected VMs when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest.
- ha
Vm NumberRestart Timeout - 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.
- host
Cluster NumberExit Timeout - The timeout for each host maintenance mode operation when removing hosts from a cluster.
- host
Image Property Map - Details about the host image which should be applied to the cluster.
- host
Managed Boolean - Must be set if cluster enrollment is managed from host resource.
- host
System List<String>Ids - The managed object IDs of the hosts to put in the cluster.
- name String
- The name of the cluster.
- proactive
Ha StringAutomation Level - The DRS behavior for proactive HA recommendations. Can be one of Automated or Manual.
- proactive
Ha BooleanEnabled - Enables proactive HA, allowing for vSphere to get HA data from external providers and use DRS to perform remediation.
- proactive
Ha StringModerate Remediation - 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.
- proactive
Ha List<String>Provider Ids - The list of IDs for health update providers configured for this cluster.
- proactive
Ha StringSevere Remediation - 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.
- resource
Pool StringId - The managed object ID of the primary
resource pool for this cluster. This can be passed directly to the
resource_pool_id
attribute of thevsphere.VirtualMachine
resource. - List<String>
- The IDs of any tags to attach to this resource.
- vsan
Compression BooleanEnabled - Whether the vSAN compression service is enabled for the cluster.
- vsan
Dedup BooleanEnabled - Whether the vSAN deduplication service is enabled for the cluster.
- vsan
Disk List<Property Map>Groups - A list of disk UUIDs to add to the vSAN cluster.
- vsan
Dit BooleanEncryption Enabled - Whether the vSAN data-in-transit encryption is enabled for the cluster.
- vsan
Dit NumberRekey Interval - When vsan_dit_encryption_enabled is enabled, sets the rekey interval of data-in-transit encryption (in minutes).
- vsan
Enabled Boolean - Whether the vSAN service is enabled for the cluster.
- vsan
Esa BooleanEnabled - Whether the vSAN ESA service is enabled for the cluster.
- vsan
Fault List<Property Map>Domains - The configuration for vSAN fault domains.
- vsan
Network BooleanDiagnostic Mode Enabled - Whether the vSAN network diagnostic mode is enabled for the cluster.
- vsan
Performance BooleanEnabled - Whether the vSAN performance service is enabled for the cluster.
- vsan
Remote List<String>Datastore Ids - The managed object IDs of the vSAN datastore to be mounted on the cluster.
- vsan
Stretched Property MapCluster - The configuration for stretched cluster.
- vsan
Unmap BooleanEnabled - Whether the vSAN unmap service is enabled for the cluster.
- vsan
Verbose BooleanMode Enabled - Whether the vSAN verbose mode is enabled for the cluster.
Supporting Types
ComputeClusterHostImage, ComputeClusterHostImageArgs
- Components
List<Pulumi.
VSphere. Inputs. Compute Cluster Host Image Component> - List of custom components.
- Esx
Version string - The ESXi version which the image is based on.
- Components
[]Compute
Cluster Host Image Component - List of custom components.
- Esx
Version string - The ESXi version which the image is based on.
- components
List<Compute
Cluster Host Image Component> - List of custom components.
- esx
Version String - The ESXi version which the image is based on.
- components
Compute
Cluster Host Image Component[] - List of custom components.
- esx
Version string - The ESXi version which the image is based on.
- components
Sequence[Compute
Cluster Host Image Component] - List of custom components.
- esx_
version str - The ESXi version which the image is based on.
- components List<Property Map>
- List of custom components.
- esx
Version String - The ESXi version which the image is based on.
ComputeClusterHostImageComponent, ComputeClusterHostImageComponentArgs
ComputeClusterVsanDiskGroup, ComputeClusterVsanDiskGroupArgs
ComputeClusterVsanFaultDomain, ComputeClusterVsanFaultDomainArgs
- Fault
Domains List<Pulumi.VSphere. Inputs. Compute Cluster Vsan Fault Domain Fault Domain> - The configuration for single fault domain.
- Fault
Domains []ComputeCluster Vsan Fault Domain Fault Domain - The configuration for single fault domain.
- fault
Domains List<ComputeCluster Vsan Fault Domain Fault Domain> - The configuration for single fault domain.
- fault
Domains ComputeCluster Vsan Fault Domain Fault Domain[] - The configuration for single fault domain.
- fault_
domains Sequence[ComputeCluster Vsan Fault Domain Fault Domain] - The configuration for single fault domain.
- fault
Domains List<Property Map> - The configuration for single fault domain.
ComputeClusterVsanFaultDomainFaultDomain, ComputeClusterVsanFaultDomainFaultDomainArgs
ComputeClusterVsanStretchedCluster, ComputeClusterVsanStretchedClusterArgs
- Preferred
Fault List<string>Domain Host Ids - The managed object IDs of the hosts to put in the first fault domain.
- Secondary
Fault List<string>Domain Host Ids - The managed object IDs of the hosts to put in the second fault domain.
- Witness
Node string - The managed object IDs of the host selected as witness node when enable stretched cluster.
- Preferred
Fault stringDomain Name - The name of prepferred fault domain.
- Secondary
Fault stringDomain Name - The name of secondary fault domain.
- Preferred
Fault []stringDomain Host Ids - The managed object IDs of the hosts to put in the first fault domain.
- Secondary
Fault []stringDomain Host Ids - The managed object IDs of the hosts to put in the second fault domain.
- Witness
Node string - The managed object IDs of the host selected as witness node when enable stretched cluster.
- Preferred
Fault stringDomain Name - The name of prepferred fault domain.
- Secondary
Fault stringDomain Name - The name of secondary fault domain.
- preferred
Fault List<String>Domain Host Ids - The managed object IDs of the hosts to put in the first fault domain.
- secondary
Fault List<String>Domain Host Ids - The managed object IDs of the hosts to put in the second fault domain.
- witness
Node String - The managed object IDs of the host selected as witness node when enable stretched cluster.
- preferred
Fault StringDomain Name - The name of prepferred fault domain.
- secondary
Fault StringDomain Name - The name of secondary fault domain.
- preferred
Fault string[]Domain Host Ids - The managed object IDs of the hosts to put in the first fault domain.
- secondary
Fault string[]Domain Host Ids - The managed object IDs of the hosts to put in the second fault domain.
- witness
Node string - The managed object IDs of the host selected as witness node when enable stretched cluster.
- preferred
Fault stringDomain Name - The name of prepferred fault domain.
- secondary
Fault stringDomain Name - The name of secondary fault domain.
- preferred_
fault_ Sequence[str]domain_ host_ ids - The managed object IDs of the hosts to put in the first fault domain.
- secondary_
fault_ Sequence[str]domain_ host_ ids - The managed object IDs of the hosts to put in the second fault domain.
- witness_
node str - The managed object IDs of the host selected as witness node when enable stretched cluster.
- preferred_
fault_ strdomain_ name - The name of prepferred fault domain.
- secondary_
fault_ strdomain_ name - The name of secondary fault domain.
- preferred
Fault List<String>Domain Host Ids - The managed object IDs of the hosts to put in the first fault domain.
- secondary
Fault List<String>Domain Host Ids - The managed object IDs of the hosts to put in the second fault domain.
- witness
Node String - The managed object IDs of the host selected as witness node when enable stretched cluster.
- preferred
Fault StringDomain Name - The name of prepferred fault domain.
- secondary
Fault StringDomain Name - The name of secondary fault domain.
Import
An existing cluster can be imported into this resource via the
path to the cluster, via the following command:
hcl
variable “datacenter” {
default = “dc-01”
}
data “vsphere_datacenter” “datacenter” {
name = var.datacenter
}
resource “vsphere_compute_cluster” “compute_cluster” {
name = “cluster-01”
datacenter_id = data.vsphere_datacenter.datacenter.id
}
hcl
resource “vsphere_compute_cluster” “compute_cluster” {
name = “cluster-01”
datacenter_id = data.vsphere_datacenter.datacenter.id
vsan_enabled = true
vsan_performance_enabled = true
host_system_ids = [for host in data.vsphere_host.host : host.id]
dpm_automation_level = “automated”
drs_automation_level = “fullyAutomated”
drs_enabled = true
ha_datastore_apd_response = “restartConservative”
ha_datastore_pdl_response = “restartAggressive”
… etc.
console
$ pulumi import vsphere:index/computeCluster:ComputeCluster compute_cluster /dc-01/host/cluster-01
The above would import the cluster named cluster-01
that is located in
the dc-01
datacenter.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- vSphere pulumi/pulumi-vsphere
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vsphere
Terraform Provider.