Set-Datastore
This cmdlet modifies the properties of the specified datastore. You can use the following characters in a path, but not in a datastore name: slash (/), backslash (\), and percent (%).
Syntax
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Datastore | Datastore[] | named |
|
Specifies the datastore whose properties you want to change. |
| required
|
MaintenanceMode | Boolean | named |
|
Specifies whether you want to put the datastore in maintenance mode. The operation completes when no virtual machines are present and no provisioning processes are running on the datastore. |
| optional | EvacuateAutomatically | SwitchParameter | named |
|
Specifies whether you want to automatically migrate all virtual machines to another datastore if the value of MaintenanceMode is $true. When the Storage DRS automation level is set to Fully Automated, you do not need to specify the EvacuateAutomatically parameter because Storage DRS will migrate all virtual machines automatically. If EvacuateAutomatically is specified, the SDRS placement and migration recommendations are automatically applied. If SDRS generates cluster DRS faults, an error report is displayed and the operation is cancelled. The report contains information about each datastore cluster DRS fault. If EvacuateAutomatically is not specified, an error report is displayed and the operation is cancelled. The error report contains information about each SDRS recommendation. If SDRS generates cluster DRS faults, an error report is displayed and the operation is cancelled. The error report contains information about each fault. If EvacuateAutomatically is explicitly set to false, the cmdlet blocks execution without displaying an error message. If SDRS generates datastore cluster DRS faults, the cmdlet stops responding and an error report is displayed. The report contains information about each cluster DRS fault. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | RunAsync | SwitchParameter | named |
|
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console. |
| optional | Server | VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Datastore | Datastore[] | named |
|
Specifies the datastore whose properties you want to change. |
| optional | Name | String | 1 |
|
Specifies a new name for the datastore. Do not use slash (/), backslash (\), and percent (%) characters in datastore names. |
| optional | CongestionThresholdMillisecond | Int32 | named |
|
Specifies the latency period beyond which the storage array is considered congested. The range of this value is between 10 to 100 milliseconds. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. |
| optional | StorageIOControlEnabled | Boolean | named |
|
Indicates whether you want to enable the IO control. |
Output
VMware.VimAutomation.ViCore.Types.V1.DatastoreManagement.DatastoreExamples
Example 1
Get-Datastore -Name Datastore1 | Set-Datastore -Name Datastore2
Renames the Datastore1 datastore to Datastore2.
Example 2
Set-Datastore $datastore1, $datastore2 -StorageIOControlEnabled $true -CongestionThresholdMillisecond 80
Enables the Storage IO Control and set a congestion threshold of 80 milliseconds for the specified datastores.
Example 3
Get-Datastore -Name 'MyDatastore1' | Set-Datastore -MaintenanceMode $true -EvacuateAutomatically
Puts the MyDatastore1 datastore in maintenance mode and specifies that all virtual machines on the datastore will be automatically migrated to another datastore.
Related Commands
Datastore
This cmdlet retrieves the datastores available on a vCenter Server system.
This cmdlet moves datastores from one location to another.
This cmdlet creates a new datastore.
This cmdlet removes the specified datastores from their locations.
This cmdlet modifies the properties of the specified datastore.
DatastoreCluster
This cmdlet retrieves datastore clusters.
This cmdlet creates a new datastore cluster.
This cmdlet deletes the specified datastore clusters.
This cmdlet modifies the configuration of the specified datastore cluster.
DatastoreItem
This cmdlet copies items between datastores and between a datastore and a local file system provider.