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

-Datastore  <Datastore[]>
[[-Name]  <String>]
[-CongestionThresholdMillisecond  <Int32>]
[-Server  <VIServer[]>]
[-StorageIOControlEnabled  <Boolean>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Datastore
Datastore[] named
  • wildcards
  • pipeline
  • 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
    Server
    VIServer[] named
  • wildcards
  • 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.

    -Datastore  <Datastore[]>
    -MaintenanceMode  <Boolean>
    [-EvacuateAutomatically]
    [-RunAsync]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Datastore
    Datastore[] named
  • wildcards
  • pipeline
  • 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.
    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
  • wildcards
  • 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.

    Output

    VMware.VimAutomation.ViCore.Types.V1.DatastoreManagement.Datastore

    Examples


    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

    Feedback

    Was this page helpful?