1. Docs
  2. Reference
  3. API
  4. vSphere
  5. DatastoreCluster

DatastoreCluster

The vsphere..DatastoreCluster resource can be used to create and manage datastore clusters. This can be used to create groups of datastores with a shared management interface, allowing for resource control and load balancing through Storage DRS.

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

NOTE: This resource requires vCenter and is not available on direct ESXi connections.

NOTE: Storage DRS requires a vSphere Enterprise Plus license.

Create a DatastoreCluster Resource

new DatastoreCluster(name: string, args: DatastoreClusterArgs, opts?: CustomResourceOptions);
def DatastoreCluster(resource_name, opts=None, custom_attributes=None, datacenter_id=None, folder=None, name=None, sdrs_advanced_options=None, sdrs_automation_level=None, sdrs_default_intra_vm_affinity=None, sdrs_enabled=None, sdrs_free_space_threshold=None, sdrs_free_space_threshold_mode=None, sdrs_free_space_utilization_difference=None, sdrs_io_balance_automation_level=None, sdrs_io_latency_threshold=None, sdrs_io_load_balance_enabled=None, sdrs_io_load_imbalance_threshold=None, sdrs_io_reservable_iops_threshold=None, sdrs_io_reservable_percent_threshold=None, sdrs_io_reservable_threshold_mode=None, sdrs_load_balance_interval=None, sdrs_policy_enforcement_automation_level=None, sdrs_rule_enforcement_automation_level=None, sdrs_space_balance_automation_level=None, sdrs_space_utilization_threshold=None, sdrs_vm_evacuation_automation_level=None, tags=None, __props__=None);
func NewDatastoreCluster(ctx *Context, name string, args DatastoreClusterArgs, opts ...ResourceOption) (*DatastoreCluster, error)
public DatastoreCluster(string name, DatastoreClusterArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args DatastoreClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DatastoreClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatastoreClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

DatastoreCluster Resource Properties

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

Inputs

The DatastoreCluster resource accepts the following input properties:

DatacenterId string

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

CustomAttributes Dictionary<string, string>

A map of custom attribute ids to attribute value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

Folder string

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

Name string

The name of the datastore cluster.

SdrsAdvancedOptions Dictionary<string, string>

A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.

SdrsAutomationLevel string

The global automation level for all virtual machines in this datastore cluster. Default: manual.

SdrsDefaultIntraVmAffinity bool

When true, all disks in a single virtual machine will be kept on the same datastore. Default: true.

SdrsEnabled bool

Enable Storage DRS for this datastore cluster. Default: false.

SdrsFreeSpaceThreshold int

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used. Default: utilization.

SdrsFreeSpaceThresholdMode string

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used.

SdrsFreeSpaceUtilizationDifference int

The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space. Default: 5 percent.

SdrsIoBalanceAutomationLevel string

Overrides the default automation settings when correcting I/O load imbalances.

SdrsIoLatencyThreshold int

The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore. Default: 15 seconds.

SdrsIoLoadBalanceEnabled bool

Enable I/O load balancing for this datastore cluster. Default: true.

SdrsIoLoadImbalanceThreshold int

The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default: 5 percent.

SdrsIoReservableIopsThreshold int

The threshold of reservable IOPS of all virtual machines on the datastore before storage DRS makes recommendations to move VMs off of a datastore. Note that this setting should only be set if sdrs_io_reservable_percent_threshold cannot make an accurate estimate of the capacity of the datastores in your cluster, and should be set to roughly 50-60% of the worst case peak performance of the backing LUNs.

SdrsIoReservablePercentThreshold int

The threshold, in percent, of actual estimated performance of the datastore (in IOPS) that storage DRS uses to make recommendations to move VMs off of a datastore when the total reservable IOPS exceeds the threshold. Default: 60 percent.

SdrsIoReservableThresholdMode string

The reservable IOPS threshold setting to use, sdrs_io_reservable_percent_threshold in the event of automatic, or sdrs_io_reservable_iops_threshold in the event of manual. Default: automatic.

SdrsLoadBalanceInterval int

The storage DRS poll interval, in minutes. Default: 480 minutes.

SdrsPolicyEnforcementAutomationLevel string

Overrides the default automation settings when correcting storage and VM policy violations.

SdrsRuleEnforcementAutomationLevel string

Overrides the default automation settings when correcting affinity rule violations.

SdrsSpaceBalanceAutomationLevel string

Overrides the default automation settings when correcting disk space imbalances.

SdrsSpaceUtilizationThreshold int

The threshold, in percent of used space, that storage DRS uses to make decisions to migrate VMs out of a datastore.

SdrsVmEvacuationAutomationLevel string

Overrides the default automation settings when generating recommendations for datastore evacuation.

Tags List<string>

The IDs of any tags to attach to this resource.

DatacenterId string

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

CustomAttributes map[string]string

A map of custom attribute ids to attribute value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

Folder string

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

Name string

The name of the datastore cluster.

SdrsAdvancedOptions map[string]string

A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.

SdrsAutomationLevel string

The global automation level for all virtual machines in this datastore cluster. Default: manual.

SdrsDefaultIntraVmAffinity bool

When true, all disks in a single virtual machine will be kept on the same datastore. Default: true.

SdrsEnabled bool

Enable Storage DRS for this datastore cluster. Default: false.

SdrsFreeSpaceThreshold int

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used. Default: utilization.

SdrsFreeSpaceThresholdMode string

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used.

SdrsFreeSpaceUtilizationDifference int

The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space. Default: 5 percent.

SdrsIoBalanceAutomationLevel string

Overrides the default automation settings when correcting I/O load imbalances.

SdrsIoLatencyThreshold int

The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore. Default: 15 seconds.

SdrsIoLoadBalanceEnabled bool

Enable I/O load balancing for this datastore cluster. Default: true.

SdrsIoLoadImbalanceThreshold int

The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default: 5 percent.

SdrsIoReservableIopsThreshold int

The threshold of reservable IOPS of all virtual machines on the datastore before storage DRS makes recommendations to move VMs off of a datastore. Note that this setting should only be set if sdrs_io_reservable_percent_threshold cannot make an accurate estimate of the capacity of the datastores in your cluster, and should be set to roughly 50-60% of the worst case peak performance of the backing LUNs.

SdrsIoReservablePercentThreshold int

The threshold, in percent, of actual estimated performance of the datastore (in IOPS) that storage DRS uses to make recommendations to move VMs off of a datastore when the total reservable IOPS exceeds the threshold. Default: 60 percent.

SdrsIoReservableThresholdMode string

The reservable IOPS threshold setting to use, sdrs_io_reservable_percent_threshold in the event of automatic, or sdrs_io_reservable_iops_threshold in the event of manual. Default: automatic.

SdrsLoadBalanceInterval int

The storage DRS poll interval, in minutes. Default: 480 minutes.

SdrsPolicyEnforcementAutomationLevel string

Overrides the default automation settings when correcting storage and VM policy violations.

SdrsRuleEnforcementAutomationLevel string

Overrides the default automation settings when correcting affinity rule violations.

SdrsSpaceBalanceAutomationLevel string

Overrides the default automation settings when correcting disk space imbalances.

SdrsSpaceUtilizationThreshold int

The threshold, in percent of used space, that storage DRS uses to make decisions to migrate VMs out of a datastore.

SdrsVmEvacuationAutomationLevel string

Overrides the default automation settings when generating recommendations for datastore evacuation.

Tags []string

The IDs of any tags to attach to this resource.

datacenterId string

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

customAttributes {[key: string]: string}

A map of custom attribute ids to attribute value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

folder string

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

name string

The name of the datastore cluster.

sdrsAdvancedOptions {[key: string]: string}

A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.

sdrsAutomationLevel string

The global automation level for all virtual machines in this datastore cluster. Default: manual.

sdrsDefaultIntraVmAffinity boolean

When true, all disks in a single virtual machine will be kept on the same datastore. Default: true.

sdrsEnabled boolean

Enable Storage DRS for this datastore cluster. Default: false.

sdrsFreeSpaceThreshold number

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used. Default: utilization.

sdrsFreeSpaceThresholdMode string

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used.

sdrsFreeSpaceUtilizationDifference number

The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space. Default: 5 percent.

sdrsIoBalanceAutomationLevel string

Overrides the default automation settings when correcting I/O load imbalances.

sdrsIoLatencyThreshold number

The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore. Default: 15 seconds.

sdrsIoLoadBalanceEnabled boolean

Enable I/O load balancing for this datastore cluster. Default: true.

sdrsIoLoadImbalanceThreshold number

The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default: 5 percent.

sdrsIoReservableIopsThreshold number

The threshold of reservable IOPS of all virtual machines on the datastore before storage DRS makes recommendations to move VMs off of a datastore. Note that this setting should only be set if sdrs_io_reservable_percent_threshold cannot make an accurate estimate of the capacity of the datastores in your cluster, and should be set to roughly 50-60% of the worst case peak performance of the backing LUNs.

sdrsIoReservablePercentThreshold number

The threshold, in percent, of actual estimated performance of the datastore (in IOPS) that storage DRS uses to make recommendations to move VMs off of a datastore when the total reservable IOPS exceeds the threshold. Default: 60 percent.

sdrsIoReservableThresholdMode string

The reservable IOPS threshold setting to use, sdrs_io_reservable_percent_threshold in the event of automatic, or sdrs_io_reservable_iops_threshold in the event of manual. Default: automatic.

sdrsLoadBalanceInterval number

The storage DRS poll interval, in minutes. Default: 480 minutes.

sdrsPolicyEnforcementAutomationLevel string

Overrides the default automation settings when correcting storage and VM policy violations.

sdrsRuleEnforcementAutomationLevel string

Overrides the default automation settings when correcting affinity rule violations.

sdrsSpaceBalanceAutomationLevel string

Overrides the default automation settings when correcting disk space imbalances.

sdrsSpaceUtilizationThreshold number

The threshold, in percent of used space, that storage DRS uses to make decisions to migrate VMs out of a datastore.

sdrsVmEvacuationAutomationLevel string

Overrides the default automation settings when generating recommendations for datastore evacuation.

tags string[]

The IDs of any tags to attach to this resource.

datacenter_id str

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

custom_attributes Dict[str, str]

A map of custom attribute ids to attribute value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

folder str

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

name str

The name of the datastore cluster.

sdrs_advanced_options Dict[str, str]

A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.

sdrs_automation_level str

The global automation level for all virtual machines in this datastore cluster. Default: manual.

sdrs_default_intra_vm_affinity bool

When true, all disks in a single virtual machine will be kept on the same datastore. Default: true.

sdrs_enabled bool

Enable Storage DRS for this datastore cluster. Default: false.

sdrs_free_space_threshold float

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used. Default: utilization.

sdrs_free_space_threshold_mode str

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used.

sdrs_free_space_utilization_difference float

The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space. Default: 5 percent.

sdrs_io_balance_automation_level str

Overrides the default automation settings when correcting I/O load imbalances.

sdrs_io_latency_threshold float

The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore. Default: 15 seconds.

sdrs_io_load_balance_enabled bool

Enable I/O load balancing for this datastore cluster. Default: true.

sdrs_io_load_imbalance_threshold float

The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default: 5 percent.

sdrs_io_reservable_iops_threshold float

The threshold of reservable IOPS of all virtual machines on the datastore before storage DRS makes recommendations to move VMs off of a datastore. Note that this setting should only be set if sdrs_io_reservable_percent_threshold cannot make an accurate estimate of the capacity of the datastores in your cluster, and should be set to roughly 50-60% of the worst case peak performance of the backing LUNs.

sdrs_io_reservable_percent_threshold float

The threshold, in percent, of actual estimated performance of the datastore (in IOPS) that storage DRS uses to make recommendations to move VMs off of a datastore when the total reservable IOPS exceeds the threshold. Default: 60 percent.

sdrs_io_reservable_threshold_mode str

The reservable IOPS threshold setting to use, sdrs_io_reservable_percent_threshold in the event of automatic, or sdrs_io_reservable_iops_threshold in the event of manual. Default: automatic.

sdrs_load_balance_interval float

The storage DRS poll interval, in minutes. Default: 480 minutes.

sdrs_policy_enforcement_automation_level str

Overrides the default automation settings when correcting storage and VM policy violations.

sdrs_rule_enforcement_automation_level str

Overrides the default automation settings when correcting affinity rule violations.

sdrs_space_balance_automation_level str

Overrides the default automation settings when correcting disk space imbalances.

sdrs_space_utilization_threshold float

The threshold, in percent of used space, that storage DRS uses to make decisions to migrate VMs out of a datastore.

sdrs_vm_evacuation_automation_level str

Overrides the default automation settings when generating recommendations for datastore evacuation.

tags List[str]

The IDs of any tags to attach to this resource.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing DatastoreCluster Resource

Get an existing DatastoreCluster 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?: DatastoreClusterState, opts?: CustomResourceOptions): DatastoreCluster
static get(resource_name, id, opts=None, custom_attributes=None, datacenter_id=None, folder=None, name=None, sdrs_advanced_options=None, sdrs_automation_level=None, sdrs_default_intra_vm_affinity=None, sdrs_enabled=None, sdrs_free_space_threshold=None, sdrs_free_space_threshold_mode=None, sdrs_free_space_utilization_difference=None, sdrs_io_balance_automation_level=None, sdrs_io_latency_threshold=None, sdrs_io_load_balance_enabled=None, sdrs_io_load_imbalance_threshold=None, sdrs_io_reservable_iops_threshold=None, sdrs_io_reservable_percent_threshold=None, sdrs_io_reservable_threshold_mode=None, sdrs_load_balance_interval=None, sdrs_policy_enforcement_automation_level=None, sdrs_rule_enforcement_automation_level=None, sdrs_space_balance_automation_level=None, sdrs_space_utilization_threshold=None, sdrs_vm_evacuation_automation_level=None, tags=None, __props__=None);
func GetDatastoreCluster(ctx *Context, name string, id IDInput, state *DatastoreClusterState, opts ...ResourceOption) (*DatastoreCluster, error)
public static DatastoreCluster Get(string name, Input<string> id, DatastoreClusterState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

CustomAttributes Dictionary<string, string>

A map of custom attribute ids to attribute value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

DatacenterId string

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

Folder string

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

Name string

The name of the datastore cluster.

SdrsAdvancedOptions Dictionary<string, string>

A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.

SdrsAutomationLevel string

The global automation level for all virtual machines in this datastore cluster. Default: manual.

SdrsDefaultIntraVmAffinity bool

When true, all disks in a single virtual machine will be kept on the same datastore. Default: true.

SdrsEnabled bool

Enable Storage DRS for this datastore cluster. Default: false.

SdrsFreeSpaceThreshold int

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used. Default: utilization.

SdrsFreeSpaceThresholdMode string

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used.

SdrsFreeSpaceUtilizationDifference int

The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space. Default: 5 percent.

SdrsIoBalanceAutomationLevel string

Overrides the default automation settings when correcting I/O load imbalances.

SdrsIoLatencyThreshold int

The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore. Default: 15 seconds.

SdrsIoLoadBalanceEnabled bool

Enable I/O load balancing for this datastore cluster. Default: true.

SdrsIoLoadImbalanceThreshold int

The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default: 5 percent.

SdrsIoReservableIopsThreshold int

The threshold of reservable IOPS of all virtual machines on the datastore before storage DRS makes recommendations to move VMs off of a datastore. Note that this setting should only be set if sdrs_io_reservable_percent_threshold cannot make an accurate estimate of the capacity of the datastores in your cluster, and should be set to roughly 50-60% of the worst case peak performance of the backing LUNs.

SdrsIoReservablePercentThreshold int

The threshold, in percent, of actual estimated performance of the datastore (in IOPS) that storage DRS uses to make recommendations to move VMs off of a datastore when the total reservable IOPS exceeds the threshold. Default: 60 percent.

SdrsIoReservableThresholdMode string

The reservable IOPS threshold setting to use, sdrs_io_reservable_percent_threshold in the event of automatic, or sdrs_io_reservable_iops_threshold in the event of manual. Default: automatic.

SdrsLoadBalanceInterval int

The storage DRS poll interval, in minutes. Default: 480 minutes.

SdrsPolicyEnforcementAutomationLevel string

Overrides the default automation settings when correcting storage and VM policy violations.

SdrsRuleEnforcementAutomationLevel string

Overrides the default automation settings when correcting affinity rule violations.

SdrsSpaceBalanceAutomationLevel string

Overrides the default automation settings when correcting disk space imbalances.

SdrsSpaceUtilizationThreshold int

The threshold, in percent of used space, that storage DRS uses to make decisions to migrate VMs out of a datastore.

SdrsVmEvacuationAutomationLevel string

Overrides the default automation settings when generating recommendations for datastore evacuation.

Tags List<string>

The IDs of any tags to attach to this resource.

CustomAttributes map[string]string

A map of custom attribute ids to attribute value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

DatacenterId string

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

Folder string

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

Name string

The name of the datastore cluster.

SdrsAdvancedOptions map[string]string

A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.

SdrsAutomationLevel string

The global automation level for all virtual machines in this datastore cluster. Default: manual.

SdrsDefaultIntraVmAffinity bool

When true, all disks in a single virtual machine will be kept on the same datastore. Default: true.

SdrsEnabled bool

Enable Storage DRS for this datastore cluster. Default: false.

SdrsFreeSpaceThreshold int

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used. Default: utilization.

SdrsFreeSpaceThresholdMode string

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used.

SdrsFreeSpaceUtilizationDifference int

The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space. Default: 5 percent.

SdrsIoBalanceAutomationLevel string

Overrides the default automation settings when correcting I/O load imbalances.

SdrsIoLatencyThreshold int

The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore. Default: 15 seconds.

SdrsIoLoadBalanceEnabled bool

Enable I/O load balancing for this datastore cluster. Default: true.

SdrsIoLoadImbalanceThreshold int

The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default: 5 percent.

SdrsIoReservableIopsThreshold int

The threshold of reservable IOPS of all virtual machines on the datastore before storage DRS makes recommendations to move VMs off of a datastore. Note that this setting should only be set if sdrs_io_reservable_percent_threshold cannot make an accurate estimate of the capacity of the datastores in your cluster, and should be set to roughly 50-60% of the worst case peak performance of the backing LUNs.

SdrsIoReservablePercentThreshold int

The threshold, in percent, of actual estimated performance of the datastore (in IOPS) that storage DRS uses to make recommendations to move VMs off of a datastore when the total reservable IOPS exceeds the threshold. Default: 60 percent.

SdrsIoReservableThresholdMode string

The reservable IOPS threshold setting to use, sdrs_io_reservable_percent_threshold in the event of automatic, or sdrs_io_reservable_iops_threshold in the event of manual. Default: automatic.

SdrsLoadBalanceInterval int

The storage DRS poll interval, in minutes. Default: 480 minutes.

SdrsPolicyEnforcementAutomationLevel string

Overrides the default automation settings when correcting storage and VM policy violations.

SdrsRuleEnforcementAutomationLevel string

Overrides the default automation settings when correcting affinity rule violations.

SdrsSpaceBalanceAutomationLevel string

Overrides the default automation settings when correcting disk space imbalances.

SdrsSpaceUtilizationThreshold int

The threshold, in percent of used space, that storage DRS uses to make decisions to migrate VMs out of a datastore.

SdrsVmEvacuationAutomationLevel string

Overrides the default automation settings when generating recommendations for datastore evacuation.

Tags []string

The IDs of any tags to attach to this resource.

customAttributes {[key: string]: string}

A map of custom attribute ids to attribute value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

datacenterId string

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

folder string

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

name string

The name of the datastore cluster.

sdrsAdvancedOptions {[key: string]: string}

A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.

sdrsAutomationLevel string

The global automation level for all virtual machines in this datastore cluster. Default: manual.

sdrsDefaultIntraVmAffinity boolean

When true, all disks in a single virtual machine will be kept on the same datastore. Default: true.

sdrsEnabled boolean

Enable Storage DRS for this datastore cluster. Default: false.

sdrsFreeSpaceThreshold number

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used. Default: utilization.

sdrsFreeSpaceThresholdMode string

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used.

sdrsFreeSpaceUtilizationDifference number

The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space. Default: 5 percent.

sdrsIoBalanceAutomationLevel string

Overrides the default automation settings when correcting I/O load imbalances.

sdrsIoLatencyThreshold number

The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore. Default: 15 seconds.

sdrsIoLoadBalanceEnabled boolean

Enable I/O load balancing for this datastore cluster. Default: true.

sdrsIoLoadImbalanceThreshold number

The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default: 5 percent.

sdrsIoReservableIopsThreshold number

The threshold of reservable IOPS of all virtual machines on the datastore before storage DRS makes recommendations to move VMs off of a datastore. Note that this setting should only be set if sdrs_io_reservable_percent_threshold cannot make an accurate estimate of the capacity of the datastores in your cluster, and should be set to roughly 50-60% of the worst case peak performance of the backing LUNs.

sdrsIoReservablePercentThreshold number

The threshold, in percent, of actual estimated performance of the datastore (in IOPS) that storage DRS uses to make recommendations to move VMs off of a datastore when the total reservable IOPS exceeds the threshold. Default: 60 percent.

sdrsIoReservableThresholdMode string

The reservable IOPS threshold setting to use, sdrs_io_reservable_percent_threshold in the event of automatic, or sdrs_io_reservable_iops_threshold in the event of manual. Default: automatic.

sdrsLoadBalanceInterval number

The storage DRS poll interval, in minutes. Default: 480 minutes.

sdrsPolicyEnforcementAutomationLevel string

Overrides the default automation settings when correcting storage and VM policy violations.

sdrsRuleEnforcementAutomationLevel string

Overrides the default automation settings when correcting affinity rule violations.

sdrsSpaceBalanceAutomationLevel string

Overrides the default automation settings when correcting disk space imbalances.

sdrsSpaceUtilizationThreshold number

The threshold, in percent of used space, that storage DRS uses to make decisions to migrate VMs out of a datastore.

sdrsVmEvacuationAutomationLevel string

Overrides the default automation settings when generating recommendations for datastore evacuation.

tags string[]

The IDs of any tags to attach to this resource.

custom_attributes Dict[str, str]

A map of custom attribute ids to attribute value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

datacenter_id str

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

folder str

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

name str

The name of the datastore cluster.

sdrs_advanced_options Dict[str, str]

A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.

sdrs_automation_level str

The global automation level for all virtual machines in this datastore cluster. Default: manual.

sdrs_default_intra_vm_affinity bool

When true, all disks in a single virtual machine will be kept on the same datastore. Default: true.

sdrs_enabled bool

Enable Storage DRS for this datastore cluster. Default: false.

sdrs_free_space_threshold float

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used. Default: utilization.

sdrs_free_space_threshold_mode str

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used.

sdrs_free_space_utilization_difference float

The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space. Default: 5 percent.

sdrs_io_balance_automation_level str

Overrides the default automation settings when correcting I/O load imbalances.

sdrs_io_latency_threshold float

The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore. Default: 15 seconds.

sdrs_io_load_balance_enabled bool

Enable I/O load balancing for this datastore cluster. Default: true.

sdrs_io_load_imbalance_threshold float

The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default: 5 percent.

sdrs_io_reservable_iops_threshold float

The threshold of reservable IOPS of all virtual machines on the datastore before storage DRS makes recommendations to move VMs off of a datastore. Note that this setting should only be set if sdrs_io_reservable_percent_threshold cannot make an accurate estimate of the capacity of the datastores in your cluster, and should be set to roughly 50-60% of the worst case peak performance of the backing LUNs.

sdrs_io_reservable_percent_threshold float

The threshold, in percent, of actual estimated performance of the datastore (in IOPS) that storage DRS uses to make recommendations to move VMs off of a datastore when the total reservable IOPS exceeds the threshold. Default: 60 percent.

sdrs_io_reservable_threshold_mode str

The reservable IOPS threshold setting to use, sdrs_io_reservable_percent_threshold in the event of automatic, or sdrs_io_reservable_iops_threshold in the event of manual. Default: automatic.

sdrs_load_balance_interval float

The storage DRS poll interval, in minutes. Default: 480 minutes.

sdrs_policy_enforcement_automation_level str

Overrides the default automation settings when correcting storage and VM policy violations.

sdrs_rule_enforcement_automation_level str

Overrides the default automation settings when correcting affinity rule violations.

sdrs_space_balance_automation_level str

Overrides the default automation settings when correcting disk space imbalances.

sdrs_space_utilization_threshold float

The threshold, in percent of used space, that storage DRS uses to make decisions to migrate VMs out of a datastore.

sdrs_vm_evacuation_automation_level str

Overrides the default automation settings when generating recommendations for datastore evacuation.

tags List[str]

The IDs of any tags to attach to this resource.

Package Details

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