vsphere.DatastoreCluster
Explore with Pulumi AI
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:
- Datacenter
Id string The managed object ID of the datacenter to create the datastore cluster in. Forces a new resource if changed.
- Custom
Attributes Dictionary<string, string> A map of custom attribute ids to attribute value strings to set for the datastore cluster. 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 providedfolder
offoo/bar
, The provider will place a datastore cluster nameddatastore-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.
- Sdrs
Advanced Dictionary<string, string>Options A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.
- Sdrs
Automation stringLevel The global automation level for all virtual machines in this datastore cluster. Default:
manual
.- Sdrs
Default boolIntra Vm Affinity 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 intSpace Threshold The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default:
50
GB. When set toutilization
,drs_space_utilization_threshold
is used, and when set tofreeSpace
,drs_free_space_threshold
is used. Default:utilization
.- Sdrs
Free stringSpace Threshold Mode 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 intSpace Utilization Difference 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 stringBalance Automation Level Overrides the default automation settings when correcting I/O load imbalances.
- Sdrs
Io intLatency Threshold 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 boolLoad Balance Enabled Enable I/O load balancing for this datastore cluster. Default:
true
.- Sdrs
Io intLoad Imbalance Threshold The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default:
5
percent.- Sdrs
Io intReservable Iops Threshold 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 intReservable Percent Threshold 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 stringReservable Threshold Mode The reservable IOPS threshold setting to use,
sdrs_io_reservable_percent_threshold
in the event ofautomatic
, orsdrs_io_reservable_iops_threshold
in the event ofmanual
. Default:automatic
.- Sdrs
Load intBalance Interval The storage DRS poll interval, in minutes. Default:
480
minutes.- Sdrs
Policy stringEnforcement Automation Level Overrides the default automation settings when correcting storage and VM policy violations.
- Sdrs
Rule stringEnforcement Automation Level Overrides the default automation settings when correcting affinity rule violations.
- Sdrs
Space stringBalance Automation Level Overrides the default automation settings when correcting disk space imbalances.
- Sdrs
Space intUtilization Threshold Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default:
80
percent.- Sdrs
Vm stringEvacuation Automation Level Overrides the default automation settings when generating recommendations for datastore evacuation.
- List<string>
The IDs of any tags to attach to this resource.
NOTE: Tagging support requires vCenter 6.0 or higher.
- Datacenter
Id string The managed object ID of the datacenter to create the datastore cluster in. Forces a new resource if changed.
- Custom
Attributes map[string]string A map of custom attribute ids to attribute value strings to set for the datastore cluster. 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 providedfolder
offoo/bar
, The provider will place a datastore cluster nameddatastore-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.
- Sdrs
Advanced map[string]stringOptions A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.
- Sdrs
Automation stringLevel The global automation level for all virtual machines in this datastore cluster. Default:
manual
.- Sdrs
Default boolIntra Vm Affinity 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 intSpace Threshold The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default:
50
GB. When set toutilization
,drs_space_utilization_threshold
is used, and when set tofreeSpace
,drs_free_space_threshold
is used. Default:utilization
.- Sdrs
Free stringSpace Threshold Mode 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 intSpace Utilization Difference 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 stringBalance Automation Level Overrides the default automation settings when correcting I/O load imbalances.
- Sdrs
Io intLatency Threshold 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 boolLoad Balance Enabled Enable I/O load balancing for this datastore cluster. Default:
true
.- Sdrs
Io intLoad Imbalance Threshold The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default:
5
percent.- Sdrs
Io intReservable Iops Threshold 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 intReservable Percent Threshold 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 stringReservable Threshold Mode The reservable IOPS threshold setting to use,
sdrs_io_reservable_percent_threshold
in the event ofautomatic
, orsdrs_io_reservable_iops_threshold
in the event ofmanual
. Default:automatic
.- Sdrs
Load intBalance Interval The storage DRS poll interval, in minutes. Default:
480
minutes.- Sdrs
Policy stringEnforcement Automation Level Overrides the default automation settings when correcting storage and VM policy violations.
- Sdrs
Rule stringEnforcement Automation Level Overrides the default automation settings when correcting affinity rule violations.
- Sdrs
Space stringBalance Automation Level Overrides the default automation settings when correcting disk space imbalances.
- Sdrs
Space intUtilization Threshold Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default:
80
percent.- Sdrs
Vm stringEvacuation Automation Level Overrides the default automation settings when generating recommendations for datastore evacuation.
- []string
The IDs of any tags to attach to this resource.
NOTE: Tagging support requires vCenter 6.0 or higher.
- datacenter
Id String The managed object ID of the datacenter to create the datastore cluster in. Forces a new resource if changed.
- custom
Attributes Map<String,String> A map of custom attribute ids to attribute value strings to set for the datastore cluster. 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 providedfolder
offoo/bar
, The provider will place a datastore cluster nameddatastore-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.
- sdrs
Advanced Map<String,String>Options A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.
- sdrs
Automation StringLevel The global automation level for all virtual machines in this datastore cluster. Default:
manual
.- sdrs
Default BooleanIntra Vm Affinity When
true
, all disks in a single virtual machine will be kept on the same datastore. Default:true
.- sdrs
Enabled Boolean Enable Storage DRS for this datastore cluster. Default:
false
.- sdrs
Free IntegerSpace Threshold The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default:
50
GB. When set toutilization
,drs_space_utilization_threshold
is used, and when set tofreeSpace
,drs_free_space_threshold
is used. Default:utilization
.- sdrs
Free StringSpace Threshold Mode 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 IntegerSpace Utilization Difference 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 StringBalance Automation Level Overrides the default automation settings when correcting I/O load imbalances.
- sdrs
Io IntegerLatency Threshold 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 BooleanLoad Balance Enabled Enable I/O load balancing for this datastore cluster. Default:
true
.- sdrs
Io IntegerLoad Imbalance Threshold The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default:
5
percent.- sdrs
Io IntegerReservable Iops Threshold 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 IntegerReservable Percent Threshold 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 StringReservable Threshold Mode The reservable IOPS threshold setting to use,
sdrs_io_reservable_percent_threshold
in the event ofautomatic
, orsdrs_io_reservable_iops_threshold
in the event ofmanual
. Default:automatic
.- sdrs
Load IntegerBalance Interval The storage DRS poll interval, in minutes. Default:
480
minutes.- sdrs
Policy StringEnforcement Automation Level Overrides the default automation settings when correcting storage and VM policy violations.
- sdrs
Rule StringEnforcement Automation Level Overrides the default automation settings when correcting affinity rule violations.
- sdrs
Space StringBalance Automation Level Overrides the default automation settings when correcting disk space imbalances.
- sdrs
Space IntegerUtilization Threshold Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default:
80
percent.- sdrs
Vm StringEvacuation Automation Level Overrides the default automation settings when generating recommendations for datastore evacuation.
- List<String>
The IDs of any tags to attach to this resource.
NOTE: Tagging support requires vCenter 6.0 or higher.
- datacenter
Id string The managed object ID of the datacenter to create the datastore cluster in. Forces a new resource if changed.
- custom
Attributes {[key: string]: string} A map of custom attribute ids to attribute value strings to set for the datastore cluster. 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 providedfolder
offoo/bar
, The provider will place a datastore cluster nameddatastore-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.
- sdrs
Advanced {[key: string]: string}Options A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.
- sdrs
Automation stringLevel The global automation level for all virtual machines in this datastore cluster. Default:
manual
.- sdrs
Default booleanIntra Vm Affinity When
true
, all disks in a single virtual machine will be kept on the same datastore. Default:true
.- sdrs
Enabled boolean Enable Storage DRS for this datastore cluster. Default:
false
.- sdrs
Free numberSpace Threshold The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default:
50
GB. When set toutilization
,drs_space_utilization_threshold
is used, and when set tofreeSpace
,drs_free_space_threshold
is used. Default:utilization
.- sdrs
Free stringSpace Threshold Mode 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 numberSpace Utilization Difference 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 stringBalance Automation Level Overrides the default automation settings when correcting I/O load imbalances.
- sdrs
Io numberLatency Threshold 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 booleanLoad Balance Enabled Enable I/O load balancing for this datastore cluster. Default:
true
.- sdrs
Io numberLoad Imbalance Threshold The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default:
5
percent.- sdrs
Io numberReservable Iops Threshold 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 numberReservable Percent Threshold 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 stringReservable Threshold Mode The reservable IOPS threshold setting to use,
sdrs_io_reservable_percent_threshold
in the event ofautomatic
, orsdrs_io_reservable_iops_threshold
in the event ofmanual
. Default:automatic
.- sdrs
Load numberBalance Interval The storage DRS poll interval, in minutes. Default:
480
minutes.- sdrs
Policy stringEnforcement Automation Level Overrides the default automation settings when correcting storage and VM policy violations.
- sdrs
Rule stringEnforcement Automation Level Overrides the default automation settings when correcting affinity rule violations.
- sdrs
Space stringBalance Automation Level Overrides the default automation settings when correcting disk space imbalances.
- sdrs
Space numberUtilization Threshold Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default:
80
percent.- sdrs
Vm stringEvacuation Automation Level Overrides the default automation settings when generating recommendations for datastore evacuation.
- 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 providedfolder
offoo/bar
, The provider will place a datastore cluster nameddatastore-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_ Mapping[str, str]options A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.
- sdrs_
automation_ strlevel The global automation level for all virtual machines in this datastore cluster. Default:
manual
.- sdrs_
default_ boolintra_ vm_ affinity 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_ intspace_ threshold The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default:
50
GB. When set toutilization
,drs_space_utilization_threshold
is used, and when set tofreeSpace
,drs_free_space_threshold
is used. Default:utilization
.- sdrs_
free_ strspace_ threshold_ mode 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_ intspace_ utilization_ difference 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_ strbalance_ automation_ level Overrides the default automation settings when correcting I/O load imbalances.
- sdrs_
io_ intlatency_ threshold 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_ boolload_ balance_ enabled Enable I/O load balancing for this datastore cluster. Default:
true
.- sdrs_
io_ intload_ imbalance_ threshold The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default:
5
percent.- sdrs_
io_ intreservable_ iops_ threshold 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_ intreservable_ percent_ threshold 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_ strreservable_ threshold_ mode The reservable IOPS threshold setting to use,
sdrs_io_reservable_percent_threshold
in the event ofautomatic
, orsdrs_io_reservable_iops_threshold
in the event ofmanual
. Default:automatic
.- sdrs_
load_ intbalance_ interval The storage DRS poll interval, in minutes. Default:
480
minutes.- sdrs_
policy_ strenforcement_ automation_ level Overrides the default automation settings when correcting storage and VM policy violations.
- sdrs_
rule_ strenforcement_ automation_ level Overrides the default automation settings when correcting affinity rule violations.
- sdrs_
space_ strbalance_ automation_ level Overrides the default automation settings when correcting disk space imbalances.
- sdrs_
space_ intutilization_ threshold Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default:
80
percent.- sdrs_
vm_ strevacuation_ automation_ level Overrides the default automation settings when generating recommendations for datastore evacuation.
- Sequence[str]
The IDs of any tags to attach to this resource.
NOTE: Tagging support requires vCenter 6.0 or higher.
- datacenter
Id String The managed object ID of the datacenter to create the datastore cluster in. Forces a new resource if changed.
- custom
Attributes Map<String> A map of custom attribute ids to attribute value strings to set for the datastore cluster. 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 providedfolder
offoo/bar
, The provider will place a datastore cluster nameddatastore-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.
- sdrs
Advanced Map<String>Options A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.
- sdrs
Automation StringLevel The global automation level for all virtual machines in this datastore cluster. Default:
manual
.- sdrs
Default BooleanIntra Vm Affinity When
true
, all disks in a single virtual machine will be kept on the same datastore. Default:true
.- sdrs
Enabled Boolean Enable Storage DRS for this datastore cluster. Default:
false
.- sdrs
Free NumberSpace Threshold The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default:
50
GB. When set toutilization
,drs_space_utilization_threshold
is used, and when set tofreeSpace
,drs_free_space_threshold
is used. Default:utilization
.- sdrs
Free StringSpace Threshold Mode 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 NumberSpace Utilization Difference 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 StringBalance Automation Level Overrides the default automation settings when correcting I/O load imbalances.
- sdrs
Io NumberLatency Threshold 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 BooleanLoad Balance Enabled Enable I/O load balancing for this datastore cluster. Default:
true
.- sdrs
Io NumberLoad Imbalance Threshold The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default:
5
percent.- sdrs
Io NumberReservable Iops Threshold 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 NumberReservable Percent Threshold 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 StringReservable Threshold Mode The reservable IOPS threshold setting to use,
sdrs_io_reservable_percent_threshold
in the event ofautomatic
, orsdrs_io_reservable_iops_threshold
in the event ofmanual
. Default:automatic
.- sdrs
Load NumberBalance Interval The storage DRS poll interval, in minutes. Default:
480
minutes.- sdrs
Policy StringEnforcement Automation Level Overrides the default automation settings when correcting storage and VM policy violations.
- sdrs
Rule StringEnforcement Automation Level Overrides the default automation settings when correcting affinity rule violations.
- sdrs
Space StringBalance Automation Level Overrides the default automation settings when correcting disk space imbalances.
- sdrs
Space NumberUtilization Threshold Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default:
80
percent.- sdrs
Vm StringEvacuation Automation Level Overrides the default automation settings when generating recommendations for datastore evacuation.
- 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.
- Custom
Attributes 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.
- Datacenter
Id 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 providedfolder
offoo/bar
, The provider will place a datastore cluster nameddatastore-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.
- Sdrs
Advanced Dictionary<string, string>Options A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.
- Sdrs
Automation stringLevel The global automation level for all virtual machines in this datastore cluster. Default:
manual
.- Sdrs
Default boolIntra Vm Affinity 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 intSpace Threshold The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default:
50
GB. When set toutilization
,drs_space_utilization_threshold
is used, and when set tofreeSpace
,drs_free_space_threshold
is used. Default:utilization
.- Sdrs
Free stringSpace Threshold Mode 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 intSpace Utilization Difference 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 stringBalance Automation Level Overrides the default automation settings when correcting I/O load imbalances.
- Sdrs
Io intLatency Threshold 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 boolLoad Balance Enabled Enable I/O load balancing for this datastore cluster. Default:
true
.- Sdrs
Io intLoad Imbalance Threshold The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default:
5
percent.- Sdrs
Io intReservable Iops Threshold 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 intReservable Percent Threshold 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 stringReservable Threshold Mode The reservable IOPS threshold setting to use,
sdrs_io_reservable_percent_threshold
in the event ofautomatic
, orsdrs_io_reservable_iops_threshold
in the event ofmanual
. Default:automatic
.- Sdrs
Load intBalance Interval The storage DRS poll interval, in minutes. Default:
480
minutes.- Sdrs
Policy stringEnforcement Automation Level Overrides the default automation settings when correcting storage and VM policy violations.
- Sdrs
Rule stringEnforcement Automation Level Overrides the default automation settings when correcting affinity rule violations.
- Sdrs
Space stringBalance Automation Level Overrides the default automation settings when correcting disk space imbalances.
- Sdrs
Space intUtilization Threshold Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default:
80
percent.- Sdrs
Vm stringEvacuation Automation Level Overrides the default automation settings when generating recommendations for datastore evacuation.
- List<string>
The IDs of any tags to attach to this resource.
NOTE: Tagging support requires vCenter 6.0 or higher.
- Custom
Attributes 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.
- Datacenter
Id 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 providedfolder
offoo/bar
, The provider will place a datastore cluster nameddatastore-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.
- Sdrs
Advanced map[string]stringOptions A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.
- Sdrs
Automation stringLevel The global automation level for all virtual machines in this datastore cluster. Default:
manual
.- Sdrs
Default boolIntra Vm Affinity 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 intSpace Threshold The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default:
50
GB. When set toutilization
,drs_space_utilization_threshold
is used, and when set tofreeSpace
,drs_free_space_threshold
is used. Default:utilization
.- Sdrs
Free stringSpace Threshold Mode 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 intSpace Utilization Difference 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 stringBalance Automation Level Overrides the default automation settings when correcting I/O load imbalances.
- Sdrs
Io intLatency Threshold 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 boolLoad Balance Enabled Enable I/O load balancing for this datastore cluster. Default:
true
.- Sdrs
Io intLoad Imbalance Threshold The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default:
5
percent.- Sdrs
Io intReservable Iops Threshold 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 intReservable Percent Threshold 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 stringReservable Threshold Mode The reservable IOPS threshold setting to use,
sdrs_io_reservable_percent_threshold
in the event ofautomatic
, orsdrs_io_reservable_iops_threshold
in the event ofmanual
. Default:automatic
.- Sdrs
Load intBalance Interval The storage DRS poll interval, in minutes. Default:
480
minutes.- Sdrs
Policy stringEnforcement Automation Level Overrides the default automation settings when correcting storage and VM policy violations.
- Sdrs
Rule stringEnforcement Automation Level Overrides the default automation settings when correcting affinity rule violations.
- Sdrs
Space stringBalance Automation Level Overrides the default automation settings when correcting disk space imbalances.
- Sdrs
Space intUtilization Threshold Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default:
80
percent.- Sdrs
Vm stringEvacuation Automation Level Overrides the default automation settings when generating recommendations for datastore evacuation.
- []string
The IDs of any tags to attach to this resource.
NOTE: Tagging support requires vCenter 6.0 or higher.
- custom
Attributes 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.
- datacenter
Id 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 providedfolder
offoo/bar
, The provider will place a datastore cluster nameddatastore-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.
- sdrs
Advanced Map<String,String>Options A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.
- sdrs
Automation StringLevel The global automation level for all virtual machines in this datastore cluster. Default:
manual
.- sdrs
Default BooleanIntra Vm Affinity When
true
, all disks in a single virtual machine will be kept on the same datastore. Default:true
.- sdrs
Enabled Boolean Enable Storage DRS for this datastore cluster. Default:
false
.- sdrs
Free IntegerSpace Threshold The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default:
50
GB. When set toutilization
,drs_space_utilization_threshold
is used, and when set tofreeSpace
,drs_free_space_threshold
is used. Default:utilization
.- sdrs
Free StringSpace Threshold Mode 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 IntegerSpace Utilization Difference 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 StringBalance Automation Level Overrides the default automation settings when correcting I/O load imbalances.
- sdrs
Io IntegerLatency Threshold 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 BooleanLoad Balance Enabled Enable I/O load balancing for this datastore cluster. Default:
true
.- sdrs
Io IntegerLoad Imbalance Threshold The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default:
5
percent.- sdrs
Io IntegerReservable Iops Threshold 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 IntegerReservable Percent Threshold 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 StringReservable Threshold Mode The reservable IOPS threshold setting to use,
sdrs_io_reservable_percent_threshold
in the event ofautomatic
, orsdrs_io_reservable_iops_threshold
in the event ofmanual
. Default:automatic
.- sdrs
Load IntegerBalance Interval The storage DRS poll interval, in minutes. Default:
480
minutes.- sdrs
Policy StringEnforcement Automation Level Overrides the default automation settings when correcting storage and VM policy violations.
- sdrs
Rule StringEnforcement Automation Level Overrides the default automation settings when correcting affinity rule violations.
- sdrs
Space StringBalance Automation Level Overrides the default automation settings when correcting disk space imbalances.
- sdrs
Space IntegerUtilization Threshold Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default:
80
percent.- sdrs
Vm StringEvacuation Automation Level Overrides the default automation settings when generating recommendations for datastore evacuation.
- List<String>
The IDs of any tags to attach to this resource.
NOTE: Tagging support requires vCenter 6.0 or higher.
- custom
Attributes {[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.
- datacenter
Id 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 providedfolder
offoo/bar
, The provider will place a datastore cluster nameddatastore-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.
- sdrs
Advanced {[key: string]: string}Options A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.
- sdrs
Automation stringLevel The global automation level for all virtual machines in this datastore cluster. Default:
manual
.- sdrs
Default booleanIntra Vm Affinity When
true
, all disks in a single virtual machine will be kept on the same datastore. Default:true
.- sdrs
Enabled boolean Enable Storage DRS for this datastore cluster. Default:
false
.- sdrs
Free numberSpace Threshold The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default:
50
GB. When set toutilization
,drs_space_utilization_threshold
is used, and when set tofreeSpace
,drs_free_space_threshold
is used. Default:utilization
.- sdrs
Free stringSpace Threshold Mode 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 numberSpace Utilization Difference 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 stringBalance Automation Level Overrides the default automation settings when correcting I/O load imbalances.
- sdrs
Io numberLatency Threshold 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 booleanLoad Balance Enabled Enable I/O load balancing for this datastore cluster. Default:
true
.- sdrs
Io numberLoad Imbalance Threshold The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default:
5
percent.- sdrs
Io numberReservable Iops Threshold 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 numberReservable Percent Threshold 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 stringReservable Threshold Mode The reservable IOPS threshold setting to use,
sdrs_io_reservable_percent_threshold
in the event ofautomatic
, orsdrs_io_reservable_iops_threshold
in the event ofmanual
. Default:automatic
.- sdrs
Load numberBalance Interval The storage DRS poll interval, in minutes. Default:
480
minutes.- sdrs
Policy stringEnforcement Automation Level Overrides the default automation settings when correcting storage and VM policy violations.
- sdrs
Rule stringEnforcement Automation Level Overrides the default automation settings when correcting affinity rule violations.
- sdrs
Space stringBalance Automation Level Overrides the default automation settings when correcting disk space imbalances.
- sdrs
Space numberUtilization Threshold Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default:
80
percent.- sdrs
Vm stringEvacuation Automation Level Overrides the default automation settings when generating recommendations for datastore evacuation.
- 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 providedfolder
offoo/bar
, The provider will place a datastore cluster nameddatastore-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_ Mapping[str, str]options A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.
- sdrs_
automation_ strlevel The global automation level for all virtual machines in this datastore cluster. Default:
manual
.- sdrs_
default_ boolintra_ vm_ affinity 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_ intspace_ threshold The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default:
50
GB. When set toutilization
,drs_space_utilization_threshold
is used, and when set tofreeSpace
,drs_free_space_threshold
is used. Default:utilization
.- sdrs_
free_ strspace_ threshold_ mode 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_ intspace_ utilization_ difference 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_ strbalance_ automation_ level Overrides the default automation settings when correcting I/O load imbalances.
- sdrs_
io_ intlatency_ threshold 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_ boolload_ balance_ enabled Enable I/O load balancing for this datastore cluster. Default:
true
.- sdrs_
io_ intload_ imbalance_ threshold The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default:
5
percent.- sdrs_
io_ intreservable_ iops_ threshold 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_ intreservable_ percent_ threshold 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_ strreservable_ threshold_ mode The reservable IOPS threshold setting to use,
sdrs_io_reservable_percent_threshold
in the event ofautomatic
, orsdrs_io_reservable_iops_threshold
in the event ofmanual
. Default:automatic
.- sdrs_
load_ intbalance_ interval The storage DRS poll interval, in minutes. Default:
480
minutes.- sdrs_
policy_ strenforcement_ automation_ level Overrides the default automation settings when correcting storage and VM policy violations.
- sdrs_
rule_ strenforcement_ automation_ level Overrides the default automation settings when correcting affinity rule violations.
- sdrs_
space_ strbalance_ automation_ level Overrides the default automation settings when correcting disk space imbalances.
- sdrs_
space_ intutilization_ threshold Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default:
80
percent.- sdrs_
vm_ strevacuation_ automation_ level Overrides the default automation settings when generating recommendations for datastore evacuation.
- Sequence[str]
The IDs of any tags to attach to this resource.
NOTE: Tagging support requires vCenter 6.0 or higher.
- custom
Attributes 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.
- datacenter
Id 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 providedfolder
offoo/bar
, The provider will place a datastore cluster nameddatastore-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.
- sdrs
Advanced Map<String>Options A key/value map of advanced Storage DRS settings that are not exposed via the provider or the vSphere client.
- sdrs
Automation StringLevel The global automation level for all virtual machines in this datastore cluster. Default:
manual
.- sdrs
Default BooleanIntra Vm Affinity When
true
, all disks in a single virtual machine will be kept on the same datastore. Default:true
.- sdrs
Enabled Boolean Enable Storage DRS for this datastore cluster. Default:
false
.- sdrs
Free NumberSpace Threshold The threshold, in GB, that storage DRS uses to make decisions to migrate VMs out of a datastore. Default:
50
GB. When set toutilization
,drs_space_utilization_threshold
is used, and when set tofreeSpace
,drs_free_space_threshold
is used. Default:utilization
.- sdrs
Free StringSpace Threshold Mode 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 NumberSpace Utilization Difference 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 StringBalance Automation Level Overrides the default automation settings when correcting I/O load imbalances.
- sdrs
Io NumberLatency Threshold 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 BooleanLoad Balance Enabled Enable I/O load balancing for this datastore cluster. Default:
true
.- sdrs
Io NumberLoad Imbalance Threshold The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default:
5
percent.- sdrs
Io NumberReservable Iops Threshold 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 NumberReservable Percent Threshold 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 StringReservable Threshold Mode The reservable IOPS threshold setting to use,
sdrs_io_reservable_percent_threshold
in the event ofautomatic
, orsdrs_io_reservable_iops_threshold
in the event ofmanual
. Default:automatic
.- sdrs
Load NumberBalance Interval The storage DRS poll interval, in minutes. Default:
480
minutes.- sdrs
Policy StringEnforcement Automation Level Overrides the default automation settings when correcting storage and VM policy violations.
- sdrs
Rule StringEnforcement Automation Level Overrides the default automation settings when correcting affinity rule violations.
- sdrs
Space StringBalance Automation Level Overrides the default automation settings when correcting disk space imbalances.
- sdrs
Space NumberUtilization Threshold Runtime thresholds govern when Storage DRS performs or recommends migrations (based on the selected automation level). Default:
80
percent.- sdrs
Vm StringEvacuation Automation Level Overrides the default automation settings when generating recommendations for datastore evacuation.
- 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.