Edit

Set-VolumeScrubPolicy

  • Reference
Module:
Storage

Sets the status of the volume scrub policy.

Syntax

Set-VolumeScrubPolicy
   [-DriveLetter] <Char[]>
   [[-Enable] <Boolean>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [<CommonParameters>]
Set-VolumeScrubPolicy
   -ObjectId <String[]>
   [[-Enable] <Boolean>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [<CommonParameters>]
Set-VolumeScrubPolicy
   -Path <String[]>
   [[-Enable] <Boolean>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [<CommonParameters>]
Set-VolumeScrubPolicy
   -FileSystemLabel <String[]>
   [[-Enable] <Boolean>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [<CommonParameters>]
Set-VolumeScrubPolicy
   -InputObject <CimInstance[]>
   [[-Enable] <Boolean>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [<CommonParameters>]

Description

The Set-VolumeScrubPolicy cmdlet sets the status of the volume scrub policy. Use this cmdlet to enable or disable the policy.

Examples

Example 1: Set the volume scrub policy status

PS C:\>Get-Volume H | Set-VolumeScrubPolicy -Enable $False

This command gets a volume object, and then sets the volume scrub policy status on that object to $False.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DriveLetter

Specifies an array of letters that identify one or more drives or volumes in the system. The cmdlet sets the volume scrub policy for the drives or volumes you specify.

Type:Char[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Enable

Indicates whether to enable or disable the volume scrub policy.

Type:Boolean
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FileSystemLabel

Specifies an array of file system labels. The cmdlet sets the volume scrub policy for the file system labels you specify.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Specifies the input object that is used in a pipeline command.

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ObjectId

Specifies an array of IDs, as strings. The ID is not globally unique.

Type:String[]
Aliases:Id
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Specifies an array of paths. The cmdlet sets the volume scrub policy for the paths you specify.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance

You can use the pipeline operator to pass an array of MSFT_Volume objects to the InputObject parameter.

Outputs

CimInstance

If you specify the PassThru parameter, this cmdlet returns an object representing the volumes that you were configuring.

Notes

  • When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).