Class ComputeClusterState

Inheritance

System.Object

InputArgs

ResourceArgs

ComputeClusterState

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.VSphere

Assembly: Pulumi.VSphere.dll

Syntax

public sealed class ComputeClusterState : ResourceArgs

Constructors

ComputeClusterState()

Declaration

public ComputeClusterState()

Properties

CustomAttributes

A map of custom attribute ids to attribute value strings to set for the datastore cluster.

Declaration

public InputMap<string> CustomAttributes { get; set; }

Property Value

Type	Description
InputMap<System.String>

DatacenterId

The managed object ID of the datacenter to create the cluster in. Forces a new resource if changed.

Declaration

public Input<string> DatacenterId { get; set; }

Property Value

Type	Description
Input<System.String>

DpmAutomationLevel

The automation level for host power operations in this cluster. Can be one of manual or automated. Default: manual.

Declaration

public Input<string> DpmAutomationLevel { get; set; }

Property Value

Type	Description
Input<System.String>

DpmEnabled

Enable DPM support for DRS in this cluster. Requires drs_enabled to be true in order to be effective. Default: false.

Declaration

public Input<bool> DpmEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

DpmThreshold

A value between 1 and 5 indicating the threshold of load within the cluster that influences host power operations. This affects both power on and power off operations - a lower setting will tolerate more of a surplus/deficit than a higher setting. Default: 3.

Declaration

public Input<int> DpmThreshold { get; set; }

Property Value

Type	Description
Input<System.Int32>

DrsAdvancedOptions

A key/value map that specifies advanced options for DRS and DPM.

Declaration

public InputMap<string> DrsAdvancedOptions { get; set; }

Property Value

Type	Description
InputMap<System.String>

DrsAutomationLevel

The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

Declaration

public Input<string> DrsAutomationLevel { get; set; }

Property Value

Type	Description
Input<System.String>

DrsEnabled

Enable DRS for this cluster. Default: false.

Declaration

public Input<bool> DrsEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

DrsEnablePredictiveDrs

When true, enables DRS to use data from [vRealize Operations Manager][ref-vsphere-vro] to make proactive DRS recommendations. ^*

Declaration

public Input<bool> DrsEnablePredictiveDrs { get; set; }

Property Value

Type	Description
Input<System.Boolean>

DrsEnableVmOverrides

Allow individual DRS overrides to be set for virtual machines in the cluster. Default: true.

Declaration

public Input<bool> DrsEnableVmOverrides { get; set; }

Property Value

Type	Description
Input<System.Boolean>

DrsMigrationThreshold

A value between 1 and 5 indicating the threshold of imbalance tolerated between hosts. A lower setting will tolerate more imbalance while a higher setting will tolerate less. Default: 3.

Declaration

public Input<int> DrsMigrationThreshold { get; set; }

Property Value

Type	Description
Input<System.Int32>

Folder

The relative path to a folder to put this cluster in. This is a path relative to the datacenter you are deploying the cluster to. Example: for the dc1 datacenter, and a provided folder of foo/bar, The provider will place a cluster named compute-cluster-test in a host folder located at /dc1/host/foo/bar, with the final inventory path being /dc1/host/foo/bar/datastore-cluster-test.

Declaration

public Input<string> Folder { get; set; }

Property Value

Type	Description
Input<System.String>

ForceEvacuateOnDestroy

When destroying the resource, setting this to true will auto-remove any hosts that are currently a member of the cluster, as if they were removed by taking their entry out of host_system_ids (see below). This is an advanced option and should only be used for testing. Default: false.

Declaration

public Input<bool> ForceEvacuateOnDestroy { get; set; }

Property Value

Type	Description
Input<System.Boolean>

HaAdmissionControlFailoverHostSystemIds

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.

Declaration

public InputList<string> HaAdmissionControlFailoverHostSystemIds { get; set; }

Property Value

Type	Description
InputList<System.String>

HaAdmissionControlHostFailureTolerance

The maximum number of failed hosts that admission control tolerates when making decisions on whether to permit virtual machine operations. The maximum is one less than the number of hosts in the cluster. Default: 1. ^*

Declaration

public Input<int> HaAdmissionControlHostFailureTolerance { get; set; }

Property Value

Type	Description
Input<System.Int32>

HaAdmissionControlPerformanceTolerance

The percentage of resource reduction that a cluster of virtual machines can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting. Default: 100 (disabled).

Declaration

public Input<int> HaAdmissionControlPerformanceTolerance { get; set; }

Property Value

Type	Description
Input<System.Int32>

HaAdmissionControlPolicy

The type of admission control policy to use with vSphere HA. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Default: resourcePercentage.

Declaration

public Input<string> HaAdmissionControlPolicy { get; set; }

Property Value

Type	Description
Input<System.String>

HaAdmissionControlResourcePercentageAutoCompute

Automatically determine available resource percentages by subtracting the average number of host resources represented by the ha_admission_control_host_failure_tolerance setting from the total amount of resources in the cluster. Disable to supply user-defined values. Default: true. ^*

Declaration

public Input<bool> HaAdmissionControlResourcePercentageAutoCompute { get; set; }

Property Value

Type	Description
Input<System.Boolean>

HaAdmissionControlResourcePercentageCpu

Controls the user-defined percentage of CPU resources in the cluster to reserve for failover. Default: 100.

Declaration

public Input<int> HaAdmissionControlResourcePercentageCpu { get; set; }

Property Value

Type	Description
Input<System.Int32>

HaAdmissionControlResourcePercentageMemory

Controls the user-defined percentage of memory resources in the cluster to reserve for failover. Default: 100.

Declaration

public Input<int> HaAdmissionControlResourcePercentageMemory { get; set; }

Property Value

Type	Description
Input<System.Int32>

HaAdmissionControlSlotPolicyExplicitCpu

Controls the user-defined CPU slot size, in MHz. Default: 32.

Declaration

public Input<int> HaAdmissionControlSlotPolicyExplicitCpu { get; set; }

Property Value

Type	Description
Input<System.Int32>

HaAdmissionControlSlotPolicyExplicitMemory

Controls the user-defined memory slot size, in MB. Default: 100.

Declaration

public Input<int> HaAdmissionControlSlotPolicyExplicitMemory { get; set; }

Property Value

Type	Description
Input<System.Int32>

HaAdmissionControlSlotPolicyUseExplicitSize

Controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is false, which tells vSphere to gather a automatic average based on all powered-on virtual machines currently in the cluster.

Declaration

public Input<bool> HaAdmissionControlSlotPolicyUseExplicitSize { get; set; }

Property Value

Type	Description
Input<System.Boolean>

HaAdvancedOptions

A key/value map that specifies advanced options for vSphere HA.

Declaration

public InputMap<string> HaAdvancedOptions { get; set; }

Property Value

Type	Description
InputMap<System.String>

HaDatastoreApdRecoveryAction

Controls the action to take on virtual machines if an APD status on an affected datastore clears in the middle of an APD event. Can be one of none or reset. Default: none. ^*

Declaration

public Input<string> HaDatastoreApdRecoveryAction { get; set; }

Property Value

Type	Description
Input<System.String>

HaDatastoreApdResponse

Controls the action to take on virtual machines when the cluster has detected loss to all paths to a relevant datastore. Can be one of disabled, warning, restartConservative, or restartAggressive. Default: disabled. ^*

Declaration

public Input<string> HaDatastoreApdResponse { get; set; }

Property Value

Type	Description
Input<System.String>

HaDatastoreApdResponseDelay

Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Default: 3 minutes. ^*

Declaration

public Input<int> HaDatastoreApdResponseDelay { get; set; }

Property Value

Type	Description
Input<System.Int32>

HaDatastorePdlResponse

Controls the action to take on virtual machines when the cluster has detected a permanent device loss to a relevant datastore. Can be one of disabled, warning, or restartAggressive. Default: disabled. ^*

Declaration

public Input<string> HaDatastorePdlResponse { get; set; }

Property Value

Type	Description
Input<System.String>

HaEnabled

Enable vSphere HA for this cluster. Default: false.

Declaration

public Input<bool> HaEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

HaHeartbeatDatastoreIds

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.

Declaration

public InputList<string> HaHeartbeatDatastoreIds { get; set; }

Property Value

Type	Description
InputList<System.String>

HaHeartbeatDatastorePolicy

The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference. Default: allFeasibleDsWithUserPreference.

Declaration

public Input<string> HaHeartbeatDatastorePolicy { get; set; }

Property Value

Type	Description
Input<System.String>

HaHostIsolationResponse

The action to take on virtual machines when a host has detected that it has been isolated from the rest of the cluster. Can be one of none, powerOff, or shutdown. Default: none.

Declaration

public Input<string> HaHostIsolationResponse { get; set; }

Property Value

Type	Description
Input<System.String>

HaHostMonitoring

Global setting that controls whether vSphere HA remediates virtual machines on host failure. Can be one of enabled or disabled. Default: enabled.

Declaration

public Input<string> HaHostMonitoring { get; set; }

Property Value

Type	Description
Input<System.String>

HaVmComponentProtection

Controls vSphere VM component protection for virtual machines in this cluster. Can be one of enabled or disabled. Default: enabled. ^*

Declaration

public Input<string> HaVmComponentProtection { get; set; }

Property Value

Type	Description
Input<System.String>

HaVmDependencyRestartCondition

The condition used to determine whether or not virtual machines in a certain restart priority class are online, allowing HA to move on to restarting virtual machines on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen. The default is none, which means that a virtual machine is considered ready immediately after a host is found to start it on. ^*

Declaration

public Input<string> HaVmDependencyRestartCondition { get; set; }

Property Value

Type	Description
Input<System.String>

HaVmFailureInterval

If a heartbeat from a virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.

Declaration

public Input<int> HaVmFailureInterval { get; set; }

Property Value

Type	Description
Input<System.Int32>

HaVmMaximumFailureWindow

The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).

Declaration

public Input<int> HaVmMaximumFailureWindow { get; set; }

Property Value

Type	Description
Input<System.Int32>

HaVmMaximumResets

The maximum number of resets that HA will perform to a virtual machine when responding to a failure event. Default: 3

Declaration

public Input<int> HaVmMaximumResets { get; set; }

Property Value

Type	Description
Input<System.Int32>

HaVmMinimumUptime

The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).

Declaration

public Input<int> HaVmMinimumUptime { get; set; }

Property Value

Type	Description
Input<System.Int32>

HaVmMonitoring

The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.

Declaration

public Input<string> HaVmMonitoring { get; set; }

Property Value

Type	Description
Input<System.String>

HaVmRestartAdditionalDelay

Additional delay in seconds after ready condition is met. A VM is considered ready at this point. Default: 0 (no delay). ^*

Declaration

public Input<int> HaVmRestartAdditionalDelay { get; set; }

Property Value

Type	Description
Input<System.Int32>

HaVmRestartPriority

The default restart priority for affected virtual machines when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest. Default: medium.

Declaration

public Input<string> HaVmRestartPriority { get; set; }

Property Value

Type	Description
Input<System.String>

HaVmRestartTimeout

The maximum time, in seconds, that vSphere HA will wait for virtual machines in one priority to be ready before proceeding with the next priority. Default: 600 (10 minutes). ^*

Declaration

public Input<int> HaVmRestartTimeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

HostClusterExitTimeout

The timeout for each host maintenance mode operation when removing hosts from a cluster. The value is specified in seconds. Default: 3600 (1 hour).

Declaration

public Input<int> HostClusterExitTimeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

HostManaged

Can be set to true if compute cluster membership will be managed through the host resource rather than the compute_cluster resource. Conflicts with: host_system_ids.

v1.18.3

Declaration

public Input<bool> HostManaged { get; set; }

Property Value

Type	Description
Input<System.Boolean>

HostSystemIds

The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster. Conflicts with: host_managed.

Declaration

public InputList<string> HostSystemIds { get; set; }

Property Value

Type	Description
InputList<System.String>

Name

The name of the cluster.

Declaration

public Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

ProactiveHaAutomationLevel

Determines how the host quarantine, maintenance mode, or virtual machine migration recommendations made by proactive HA are to be handled. Can be one of Automated or Manual. Default: Manual. ^*

Declaration

public Input<string> ProactiveHaAutomationLevel { get; set; }

Property Value

Type	Description
Input<System.String>

ProactiveHaEnabled

Enables Proactive HA. Default: false. ^*

Declaration

public Input<bool> ProactiveHaEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

ProactiveHaModerateRemediation

The configured remediation for moderately degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to MaintenanceMode when proactive_ha_severe_remediation is set to QuarantineMode. Default: QuarantineMode. ^*

Declaration

public Input<string> ProactiveHaModerateRemediation { get; set; }

Property Value

Type	Description
Input<System.String>

ProactiveHaProviderIds

The list of IDs for health update providers configured for this cluster. ^*

Declaration

public InputList<string> ProactiveHaProviderIds { get; set; }

Property Value

Type	Description
InputList<System.String>

ProactiveHaSevereRemediation

The configured remediation for severely degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to QuarantineMode when proactive_ha_moderate_remediation is set to MaintenanceMode. Default: QuarantineMode. ^*

Declaration

public Input<string> ProactiveHaSevereRemediation { get; set; }

Property Value

Type	Description
Input<System.String>

ResourcePoolId

The managed object ID of the cluster's root resource pool.

Declaration

public Input<string> ResourcePoolId { get; set; }

Property Value

Type	Description
Input<System.String>

Tags

The IDs of any tags to attach to this resource.

Declaration

public InputList<string> Tags { get; set; }

Property Value

Type	Description
InputList<System.String>