Docs Packages
  1. Packages
  2. vSphere
  3. API Docs
  4. DatastoreCluster
vSphere v4.6.1 published on Tuesday, Sep 26, 2023 by Pulumi
pulumi/pulumi-vsphere

vsphere.DatastoreCluster

Explore with Pulumi AI

vsphere logo
vSphere v4.6.1 published on Tuesday, Sep 26, 2023 by Pulumi
pulumi/pulumi-vsphere

    Create DatastoreCluster Resource

    new DatastoreCluster(name: string, args: DatastoreClusterArgs, opts?: CustomResourceOptions);
    @overload
def DatastoreCluster(resource_name: 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)
@overload
def DatastoreCluster(resource_name: str,
                     args: DatastoreClusterArgs,
                     opts: Optional[ResourceOptions] = 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.
    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.

    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

    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>

    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 threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 50 GB. 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 used space, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 80 percent. 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

    Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default: 80 percent.

    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.

    NOTE: Tagging support requires vCenter 6.0 or higher.

    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

    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 threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 50 GB. 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 used space, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 80 percent. 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

    Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default: 80 percent.

    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.

    NOTE: Tagging support requires vCenter 6.0 or higher.

    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>

    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 Integer

    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 50 GB. 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 Integer

    The threshold, in percent of used space, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 80 percent. 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 Integer

    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 Integer

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

    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. 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 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. 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 Integer

    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 Integer

    Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default: 80 percent.

    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.

    NOTE: Tagging support requires vCenter 6.0 or higher.

    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}

    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 threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 50 GB. 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 used space, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 80 percent. 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

    Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default: 80 percent.

    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.

    NOTE: Tagging support requires vCenter 6.0 or higher.

    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]

    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 int

    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 50 GB. 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 int

    The threshold, in percent of used space, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 80 percent. 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 int

    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 int

    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 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.

    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. 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 int

    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 int

    Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default: 80 percent.

    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.

    NOTE: Tagging support requires vCenter 6.0 or higher.

    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>

    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 threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 50 GB. 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 used space, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 80 percent. 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

    Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default: 80 percent.

    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.

    NOTE: Tagging support requires vCenter 6.0 or higher.

    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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    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>

    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 threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 50 GB. 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 used space, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 80 percent. 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

    Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default: 80 percent.

    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.

    NOTE: Tagging support requires vCenter 6.0 or higher.

    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

    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 threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 50 GB. 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 used space, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 80 percent. 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

    Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default: 80 percent.

    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.

    NOTE: Tagging support requires vCenter 6.0 or higher.

    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>

    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 Integer

    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 50 GB. 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 Integer

    The threshold, in percent of used space, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 80 percent. 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 Integer

    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 Integer

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

    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. 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 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. 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 Integer

    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 Integer

    Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default: 80 percent.

    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.

    NOTE: Tagging support requires vCenter 6.0 or higher.

    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}

    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 threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 50 GB. 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 used space, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 80 percent. 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

    Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default: 80 percent.

    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.

    NOTE: Tagging support requires vCenter 6.0 or higher.

    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]

    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 int

    The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 50 GB. 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 int

    The threshold, in percent of used space, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 80 percent. 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 int

    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 int

    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 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.

    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. 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 int

    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 int

    Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default: 80 percent.

    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.

    NOTE: Tagging support requires vCenter 6.0 or higher.

    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>

    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 threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 50 GB. 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 used space, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default: 80 percent. 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

    Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default: 80 percent.

    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.

    NOTE: Tagging support requires vCenter 6.0 or higher.

    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.6.1 published on Tuesday, Sep 26, 2023 by Pulumi
    pulumi/pulumi-vsphere