Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vsphere Provider
  3. API Docs
  4. DatastoreCluster
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

vsphere.DatastoreCluster

Explore with Pulumi AI

vsphere logo
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

    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 DatastoreCluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DatastoreCluster(name: string, args: DatastoreClusterArgs, opts?: CustomResourceOptions);
    @overload
def DatastoreCluster(resource_name: str,
                     args: DatastoreClusterArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def DatastoreCluster(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     datacenter_id: Optional[str] = None,
                     sdrs_io_latency_threshold: Optional[int] = None,
                     sdrs_enabled: Optional[bool] = None,
                     name: Optional[str] = None,
                     sdrs_advanced_options: Optional[Mapping[str, str]] = None,
                     sdrs_automation_level: Optional[str] = None,
                     sdrs_default_intra_vm_affinity: Optional[bool] = None,
                     custom_attributes: Optional[Mapping[str, str]] = None,
                     sdrs_free_space_threshold: Optional[int] = None,
                     sdrs_free_space_threshold_mode: Optional[str] = None,
                     sdrs_free_space_utilization_difference: Optional[int] = None,
                     folder: Optional[str] = None,
                     sdrs_io_balance_automation_level: Optional[str] = None,
                     sdrs_io_reservable_threshold_mode: Optional[str] = None,
                     sdrs_io_load_imbalance_threshold: Optional[int] = None,
                     sdrs_io_reservable_iops_threshold: Optional[int] = None,
                     sdrs_io_reservable_percent_threshold: Optional[int] = None,
                     sdrs_io_load_balance_enabled: Optional[bool] = None,
                     sdrs_load_balance_interval: Optional[int] = None,
                     sdrs_policy_enforcement_automation_level: Optional[str] = None,
                     sdrs_rule_enforcement_automation_level: Optional[str] = None,
                     sdrs_space_balance_automation_level: Optional[str] = None,
                     sdrs_space_utilization_threshold: Optional[int] = None,
                     sdrs_vm_evacuation_automation_level: Optional[str] = None,
                     tags: Optional[Sequence[str]] = None)
    func NewDatastoreCluster(ctx *Context, name string, args DatastoreClusterArgs, opts ...ResourceOption) (*DatastoreCluster, error)
    public DatastoreCluster(string name, DatastoreClusterArgs args, CustomResourceOptions? opts = null)
    public DatastoreCluster(String name, DatastoreClusterArgs args)
public DatastoreCluster(String name, DatastoreClusterArgs args, CustomResourceOptions options)

    type: vsphere:DatastoreCluster
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 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.
    args DatastoreClusterArgs
    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 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.
    name String
    The unique name of the resource.
    args DatastoreClusterArgs
    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 datastoreClusterResource = new VSphere.DatastoreCluster("datastoreClusterResource", new()
{
    DatacenterId = "string",
    SdrsIoLatencyThreshold = 0,
    SdrsEnabled = false,
    Name = "string",
    SdrsAdvancedOptions = 
    {
        { "string", "string" },
    },
    SdrsAutomationLevel = "string",
    SdrsDefaultIntraVmAffinity = false,
    CustomAttributes = 
    {
        { "string", "string" },
    },
    SdrsFreeSpaceThreshold = 0,
    SdrsFreeSpaceThresholdMode = "string",
    SdrsFreeSpaceUtilizationDifference = 0,
    Folder = "string",
    SdrsIoBalanceAutomationLevel = "string",
    SdrsIoReservableThresholdMode = "string",
    SdrsIoLoadImbalanceThreshold = 0,
    SdrsIoReservableIopsThreshold = 0,
    SdrsIoReservablePercentThreshold = 0,
    SdrsIoLoadBalanceEnabled = false,
    SdrsLoadBalanceInterval = 0,
    SdrsPolicyEnforcementAutomationLevel = "string",
    SdrsRuleEnforcementAutomationLevel = "string",
    SdrsSpaceBalanceAutomationLevel = "string",
    SdrsSpaceUtilizationThreshold = 0,
    SdrsVmEvacuationAutomationLevel = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := vsphere.NewDatastoreCluster(ctx, "datastoreClusterResource", &vsphere.DatastoreClusterArgs{
	DatacenterId:           pulumi.String("string"),
	SdrsIoLatencyThreshold: pulumi.Int(0),
	SdrsEnabled:            pulumi.Bool(false),
	Name:                   pulumi.String("string"),
	SdrsAdvancedOptions: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SdrsAutomationLevel:        pulumi.String("string"),
	SdrsDefaultIntraVmAffinity: pulumi.Bool(false),
	CustomAttributes: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SdrsFreeSpaceThreshold:               pulumi.Int(0),
	SdrsFreeSpaceThresholdMode:           pulumi.String("string"),
	SdrsFreeSpaceUtilizationDifference:   pulumi.Int(0),
	Folder:                               pulumi.String("string"),
	SdrsIoBalanceAutomationLevel:         pulumi.String("string"),
	SdrsIoReservableThresholdMode:        pulumi.String("string"),
	SdrsIoLoadImbalanceThreshold:         pulumi.Int(0),
	SdrsIoReservableIopsThreshold:        pulumi.Int(0),
	SdrsIoReservablePercentThreshold:     pulumi.Int(0),
	SdrsIoLoadBalanceEnabled:             pulumi.Bool(false),
	SdrsLoadBalanceInterval:              pulumi.Int(0),
	SdrsPolicyEnforcementAutomationLevel: pulumi.String("string"),
	SdrsRuleEnforcementAutomationLevel:   pulumi.String("string"),
	SdrsSpaceBalanceAutomationLevel:      pulumi.String("string"),
	SdrsSpaceUtilizationThreshold:        pulumi.Int(0),
	SdrsVmEvacuationAutomationLevel:      pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var datastoreClusterResource = new DatastoreCluster("datastoreClusterResource", DatastoreClusterArgs.builder()
    .datacenterId("string")
    .sdrsIoLatencyThreshold(0)
    .sdrsEnabled(false)
    .name("string")
    .sdrsAdvancedOptions(Map.of("string", "string"))
    .sdrsAutomationLevel("string")
    .sdrsDefaultIntraVmAffinity(false)
    .customAttributes(Map.of("string", "string"))
    .sdrsFreeSpaceThreshold(0)
    .sdrsFreeSpaceThresholdMode("string")
    .sdrsFreeSpaceUtilizationDifference(0)
    .folder("string")
    .sdrsIoBalanceAutomationLevel("string")
    .sdrsIoReservableThresholdMode("string")
    .sdrsIoLoadImbalanceThreshold(0)
    .sdrsIoReservableIopsThreshold(0)
    .sdrsIoReservablePercentThreshold(0)
    .sdrsIoLoadBalanceEnabled(false)
    .sdrsLoadBalanceInterval(0)
    .sdrsPolicyEnforcementAutomationLevel("string")
    .sdrsRuleEnforcementAutomationLevel("string")
    .sdrsSpaceBalanceAutomationLevel("string")
    .sdrsSpaceUtilizationThreshold(0)
    .sdrsVmEvacuationAutomationLevel("string")
    .tags("string")
    .build());

    datastore_cluster_resource = vsphere.DatastoreCluster("datastoreClusterResource",
    datacenter_id="string",
    sdrs_io_latency_threshold=0,
    sdrs_enabled=False,
    name="string",
    sdrs_advanced_options={
        "string": "string",
    },
    sdrs_automation_level="string",
    sdrs_default_intra_vm_affinity=False,
    custom_attributes={
        "string": "string",
    },
    sdrs_free_space_threshold=0,
    sdrs_free_space_threshold_mode="string",
    sdrs_free_space_utilization_difference=0,
    folder="string",
    sdrs_io_balance_automation_level="string",
    sdrs_io_reservable_threshold_mode="string",
    sdrs_io_load_imbalance_threshold=0,
    sdrs_io_reservable_iops_threshold=0,
    sdrs_io_reservable_percent_threshold=0,
    sdrs_io_load_balance_enabled=False,
    sdrs_load_balance_interval=0,
    sdrs_policy_enforcement_automation_level="string",
    sdrs_rule_enforcement_automation_level="string",
    sdrs_space_balance_automation_level="string",
    sdrs_space_utilization_threshold=0,
    sdrs_vm_evacuation_automation_level="string",
    tags=["string"])

    const datastoreClusterResource = new vsphere.DatastoreCluster("datastoreClusterResource", {
    datacenterId: "string",
    sdrsIoLatencyThreshold: 0,
    sdrsEnabled: false,
    name: "string",
    sdrsAdvancedOptions: {
        string: "string",
    },
    sdrsAutomationLevel: "string",
    sdrsDefaultIntraVmAffinity: false,
    customAttributes: {
        string: "string",
    },
    sdrsFreeSpaceThreshold: 0,
    sdrsFreeSpaceThresholdMode: "string",
    sdrsFreeSpaceUtilizationDifference: 0,
    folder: "string",
    sdrsIoBalanceAutomationLevel: "string",
    sdrsIoReservableThresholdMode: "string",
    sdrsIoLoadImbalanceThreshold: 0,
    sdrsIoReservableIopsThreshold: 0,
    sdrsIoReservablePercentThreshold: 0,
    sdrsIoLoadBalanceEnabled: false,
    sdrsLoadBalanceInterval: 0,
    sdrsPolicyEnforcementAutomationLevel: "string",
    sdrsRuleEnforcementAutomationLevel: "string",
    sdrsSpaceBalanceAutomationLevel: "string",
    sdrsSpaceUtilizationThreshold: 0,
    sdrsVmEvacuationAutomationLevel: "string",
    tags: ["string"],
});

    type: vsphere:DatastoreCluster
properties:
    customAttributes:
        string: string
    datacenterId: string
    folder: string
    name: string
    sdrsAdvancedOptions:
        string: string
    sdrsAutomationLevel: string
    sdrsDefaultIntraVmAffinity: false
    sdrsEnabled: false
    sdrsFreeSpaceThreshold: 0
    sdrsFreeSpaceThresholdMode: string
    sdrsFreeSpaceUtilizationDifference: 0
    sdrsIoBalanceAutomationLevel: string
    sdrsIoLatencyThreshold: 0
    sdrsIoLoadBalanceEnabled: false
    sdrsIoLoadImbalanceThreshold: 0
    sdrsIoReservableIopsThreshold: 0
    sdrsIoReservablePercentThreshold: 0
    sdrsIoReservableThresholdMode: string
    sdrsLoadBalanceInterval: 0
    sdrsPolicyEnforcementAutomationLevel: string
    sdrsRuleEnforcementAutomationLevel: string
    sdrsSpaceBalanceAutomationLevel: string
    sdrsSpaceUtilizationThreshold: 0
    sdrsVmEvacuationAutomationLevel: string
    tags:
        - string

    DatastoreCluster 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 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 for a reference on how to set values for custom attributes.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    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>
    Advanced configuration options for storage DRS.
    SdrsAutomationLevel string
    The default automation level for all virtual machines in this storage cluster.
    SdrsDefaultIntraVmAffinity bool
    When true, storage DRS keeps VMDKs for individual VMs on the same datastore by default.
    SdrsEnabled bool
    Enable Storage DRS for this datastore cluster. Default: false.
    SdrsFreeSpaceThreshold int
    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore.
    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.
    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.
    SdrsIoLoadBalanceEnabled bool
    Enable I/O load balancing for this datastore cluster.
    SdrsIoLoadImbalanceThreshold int
    The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load.
    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.
    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.
    SdrsIoReservableThresholdMode string
    The reservable IOPS threshold to use, percent in the event of automatic, or manual threshold in the event of manual.
    SdrsLoadBalanceInterval int
    The storage DRS poll interval, in 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 for a reference on how to set values for custom attributes.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    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
    Advanced configuration options for storage DRS.
    SdrsAutomationLevel string
    The default automation level for all virtual machines in this storage cluster.
    SdrsDefaultIntraVmAffinity bool
    When true, storage DRS keeps VMDKs for individual VMs on the same datastore by default.
    SdrsEnabled bool
    Enable Storage DRS for this datastore cluster. Default: false.
    SdrsFreeSpaceThreshold int
    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore.
    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.
    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.
    SdrsIoLoadBalanceEnabled bool
    Enable I/O load balancing for this datastore cluster.
    SdrsIoLoadImbalanceThreshold int
    The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load.
    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.
    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.
    SdrsIoReservableThresholdMode string
    The reservable IOPS threshold to use, percent in the event of automatic, or manual threshold in the event of manual.
    SdrsLoadBalanceInterval int
    The storage DRS poll interval, in 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 Map<String,String>

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

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    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>
    Advanced configuration options for storage DRS.
    sdrsAutomationLevel String
    The default automation level for all virtual machines in this storage cluster.
    sdrsDefaultIntraVmAffinity Boolean
    When true, storage DRS keeps VMDKs for individual VMs on the same datastore by default.
    sdrsEnabled Boolean
    Enable Storage DRS for this datastore cluster. Default: false.
    sdrsFreeSpaceThreshold Integer
    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore.
    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 Integer
    The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space.
    sdrsIoBalanceAutomationLevel String
    Overrides the default automation settings when correcting I/O load imbalances.
    sdrsIoLatencyThreshold Integer
    The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore.
    sdrsIoLoadBalanceEnabled Boolean
    Enable I/O load balancing for this datastore cluster.
    sdrsIoLoadImbalanceThreshold Integer
    The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load.
    sdrsIoReservableIopsThreshold Integer
    The threshold of reservable IOPS of all virtual machines on the datastore before storage DRS makes recommendations to move VMs off of a datastore.
    sdrsIoReservablePercentThreshold Integer
    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.
    sdrsIoReservableThresholdMode String
    The reservable IOPS threshold to use, percent in the event of automatic, or manual threshold in the event of manual.
    sdrsLoadBalanceInterval Integer
    The storage DRS poll interval, in 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 Integer
    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 {[key: string]: string}

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

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    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}
    Advanced configuration options for storage DRS.
    sdrsAutomationLevel string
    The default automation level for all virtual machines in this storage cluster.
    sdrsDefaultIntraVmAffinity boolean
    When true, storage DRS keeps VMDKs for individual VMs on the same datastore by default.
    sdrsEnabled boolean
    Enable Storage DRS for this datastore cluster. Default: false.
    sdrsFreeSpaceThreshold number
    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore.
    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.
    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.
    sdrsIoLoadBalanceEnabled boolean
    Enable I/O load balancing for this datastore cluster.
    sdrsIoLoadImbalanceThreshold number
    The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load.
    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.
    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.
    sdrsIoReservableThresholdMode string
    The reservable IOPS threshold to use, percent in the event of automatic, or manual threshold in the event of manual.
    sdrsLoadBalanceInterval number
    The storage DRS poll interval, in 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 Mapping[str, str]

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

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    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 Mapping[str, str]
    Advanced configuration options for storage DRS.
    sdrs_automation_level str
    The default automation level for all virtual machines in this storage cluster.
    sdrs_default_intra_vm_affinity bool
    When true, storage DRS keeps VMDKs for individual VMs on the same datastore by default.
    sdrs_enabled bool
    Enable Storage DRS for this datastore cluster. Default: false.
    sdrs_free_space_threshold int
    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore.
    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 int
    The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space.
    sdrs_io_balance_automation_level str
    Overrides the default automation settings when correcting I/O load imbalances.
    sdrs_io_latency_threshold int
    The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore.
    sdrs_io_load_balance_enabled bool
    Enable I/O load balancing for this datastore cluster.
    sdrs_io_load_imbalance_threshold int
    The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load.
    sdrs_io_reservable_iops_threshold 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.
    sdrs_io_reservable_percent_threshold 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.
    sdrs_io_reservable_threshold_mode str
    The reservable IOPS threshold to use, percent in the event of automatic, or manual threshold in the event of manual.
    sdrs_load_balance_interval int
    The storage DRS poll interval, in 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 int
    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 Sequence[str]
    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>

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

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    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>
    Advanced configuration options for storage DRS.
    sdrsAutomationLevel String
    The default automation level for all virtual machines in this storage cluster.
    sdrsDefaultIntraVmAffinity Boolean
    When true, storage DRS keeps VMDKs for individual VMs on the same datastore by default.
    sdrsEnabled Boolean
    Enable Storage DRS for this datastore cluster. Default: false.
    sdrsFreeSpaceThreshold Number
    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore.
    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.
    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.
    sdrsIoLoadBalanceEnabled Boolean
    Enable I/O load balancing for this datastore cluster.
    sdrsIoLoadImbalanceThreshold Number
    The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load.
    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.
    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.
    sdrsIoReservableThresholdMode String
    The reservable IOPS threshold to use, percent in the event of automatic, or manual threshold in the event of manual.
    sdrsLoadBalanceInterval Number
    The storage DRS poll interval, in 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 List<String>
    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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_attributes: Optional[Mapping[str, str]] = None,
        datacenter_id: Optional[str] = None,
        folder: Optional[str] = None,
        name: Optional[str] = None,
        sdrs_advanced_options: Optional[Mapping[str, str]] = None,
        sdrs_automation_level: Optional[str] = None,
        sdrs_default_intra_vm_affinity: Optional[bool] = None,
        sdrs_enabled: Optional[bool] = None,
        sdrs_free_space_threshold: Optional[int] = None,
        sdrs_free_space_threshold_mode: Optional[str] = None,
        sdrs_free_space_utilization_difference: Optional[int] = None,
        sdrs_io_balance_automation_level: Optional[str] = None,
        sdrs_io_latency_threshold: Optional[int] = None,
        sdrs_io_load_balance_enabled: Optional[bool] = None,
        sdrs_io_load_imbalance_threshold: Optional[int] = None,
        sdrs_io_reservable_iops_threshold: Optional[int] = None,
        sdrs_io_reservable_percent_threshold: Optional[int] = None,
        sdrs_io_reservable_threshold_mode: Optional[str] = None,
        sdrs_load_balance_interval: Optional[int] = None,
        sdrs_policy_enforcement_automation_level: Optional[str] = None,
        sdrs_rule_enforcement_automation_level: Optional[str] = None,
        sdrs_space_balance_automation_level: Optional[str] = None,
        sdrs_space_utilization_threshold: Optional[int] = None,
        sdrs_vm_evacuation_automation_level: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> DatastoreCluster
    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)
    public static DatastoreCluster get(String name, Output<String> id, DatastoreClusterState state, CustomResourceOptions options)
    resources:  _:    type: vsphere:DatastoreCluster    get:      id: ${id}
    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.
    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 for a reference on how to set values for custom attributes.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    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>
    Advanced configuration options for storage DRS.
    SdrsAutomationLevel string
    The default automation level for all virtual machines in this storage cluster.
    SdrsDefaultIntraVmAffinity bool
    When true, storage DRS keeps VMDKs for individual VMs on the same datastore by default.
    SdrsEnabled bool
    Enable Storage DRS for this datastore cluster. Default: false.
    SdrsFreeSpaceThreshold int
    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore.
    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.
    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.
    SdrsIoLoadBalanceEnabled bool
    Enable I/O load balancing for this datastore cluster.
    SdrsIoLoadImbalanceThreshold int
    The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load.
    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.
    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.
    SdrsIoReservableThresholdMode string
    The reservable IOPS threshold to use, percent in the event of automatic, or manual threshold in the event of manual.
    SdrsLoadBalanceInterval int
    The storage DRS poll interval, in 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 for a reference on how to set values for custom attributes.

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    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
    Advanced configuration options for storage DRS.
    SdrsAutomationLevel string
    The default automation level for all virtual machines in this storage cluster.
    SdrsDefaultIntraVmAffinity bool
    When true, storage DRS keeps VMDKs for individual VMs on the same datastore by default.
    SdrsEnabled bool
    Enable Storage DRS for this datastore cluster. Default: false.
    SdrsFreeSpaceThreshold int
    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore.
    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.
    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.
    SdrsIoLoadBalanceEnabled bool
    Enable I/O load balancing for this datastore cluster.
    SdrsIoLoadImbalanceThreshold int
    The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load.
    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.
    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.
    SdrsIoReservableThresholdMode string
    The reservable IOPS threshold to use, percent in the event of automatic, or manual threshold in the event of manual.
    SdrsLoadBalanceInterval int
    The storage DRS poll interval, in 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 Map<String,String>

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

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    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>
    Advanced configuration options for storage DRS.
    sdrsAutomationLevel String
    The default automation level for all virtual machines in this storage cluster.
    sdrsDefaultIntraVmAffinity Boolean
    When true, storage DRS keeps VMDKs for individual VMs on the same datastore by default.
    sdrsEnabled Boolean
    Enable Storage DRS for this datastore cluster. Default: false.
    sdrsFreeSpaceThreshold Integer
    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore.
    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 Integer
    The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space.
    sdrsIoBalanceAutomationLevel String
    Overrides the default automation settings when correcting I/O load imbalances.
    sdrsIoLatencyThreshold Integer
    The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore.
    sdrsIoLoadBalanceEnabled Boolean
    Enable I/O load balancing for this datastore cluster.
    sdrsIoLoadImbalanceThreshold Integer
    The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load.
    sdrsIoReservableIopsThreshold Integer
    The threshold of reservable IOPS of all virtual machines on the datastore before storage DRS makes recommendations to move VMs off of a datastore.
    sdrsIoReservablePercentThreshold Integer
    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.
    sdrsIoReservableThresholdMode String
    The reservable IOPS threshold to use, percent in the event of automatic, or manual threshold in the event of manual.
    sdrsLoadBalanceInterval Integer
    The storage DRS poll interval, in 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 Integer
    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 {[key: string]: string}

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

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    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}
    Advanced configuration options for storage DRS.
    sdrsAutomationLevel string
    The default automation level for all virtual machines in this storage cluster.
    sdrsDefaultIntraVmAffinity boolean
    When true, storage DRS keeps VMDKs for individual VMs on the same datastore by default.
    sdrsEnabled boolean
    Enable Storage DRS for this datastore cluster. Default: false.
    sdrsFreeSpaceThreshold number
    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore.
    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.
    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.
    sdrsIoLoadBalanceEnabled boolean
    Enable I/O load balancing for this datastore cluster.
    sdrsIoLoadImbalanceThreshold number
    The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load.
    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.
    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.
    sdrsIoReservableThresholdMode string
    The reservable IOPS threshold to use, percent in the event of automatic, or manual threshold in the event of manual.
    sdrsLoadBalanceInterval number
    The storage DRS poll interval, in 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 Mapping[str, str]

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

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    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 Mapping[str, str]
    Advanced configuration options for storage DRS.
    sdrs_automation_level str
    The default automation level for all virtual machines in this storage cluster.
    sdrs_default_intra_vm_affinity bool
    When true, storage DRS keeps VMDKs for individual VMs on the same datastore by default.
    sdrs_enabled bool
    Enable Storage DRS for this datastore cluster. Default: false.
    sdrs_free_space_threshold int
    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore.
    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 int
    The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space.
    sdrs_io_balance_automation_level str
    Overrides the default automation settings when correcting I/O load imbalances.
    sdrs_io_latency_threshold int
    The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore.
    sdrs_io_load_balance_enabled bool
    Enable I/O load balancing for this datastore cluster.
    sdrs_io_load_imbalance_threshold int
    The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load.
    sdrs_io_reservable_iops_threshold 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.
    sdrs_io_reservable_percent_threshold 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.
    sdrs_io_reservable_threshold_mode str
    The reservable IOPS threshold to use, percent in the event of automatic, or manual threshold in the event of manual.
    sdrs_load_balance_interval int
    The storage DRS poll interval, in 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 int
    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 Sequence[str]
    The IDs of any tags to attach to this resource.
    customAttributes Map<String>

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

    NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

    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>
    Advanced configuration options for storage DRS.
    sdrsAutomationLevel String
    The default automation level for all virtual machines in this storage cluster.
    sdrsDefaultIntraVmAffinity Boolean
    When true, storage DRS keeps VMDKs for individual VMs on the same datastore by default.
    sdrsEnabled Boolean
    Enable Storage DRS for this datastore cluster. Default: false.
    sdrsFreeSpaceThreshold Number
    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore.
    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.
    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.
    sdrsIoLoadBalanceEnabled Boolean
    Enable I/O load balancing for this datastore cluster.
    sdrsIoLoadImbalanceThreshold Number
    The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load.
    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.
    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.
    sdrsIoReservableThresholdMode String
    The reservable IOPS threshold to use, percent in the event of automatic, or manual threshold in the event of manual.
    sdrsLoadBalanceInterval Number
    The storage DRS poll interval, in 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 List<String>
    The IDs of any tags to attach to this resource.

    Import

    An existing datastore cluster can be imported into this resource

    via the path to the cluster, via the following command:

    $ pulumi import vsphere:index/datastoreCluster:DatastoreCluster datastore_cluster /dc1/datastore/ds-cluster

    The above would import the datastore cluster named ds-cluster that is located

    in the dc1 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.
    vsphere logo
    vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
    pulumi/pulumi-vsphere