Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-VolumeScrubPolicy

Set-VolumeScrubPolicy

volume.cdxml

Synopsis

Sets the status of the volume scrub policy.

Syntax

Set-VolumeScrubPolicy [-DriveLetter] [-Enable] [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [<CommonParameters>]

Set-VolumeScrubPolicy [-Enable] [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-Path] [<CommonParameters>]

Set-VolumeScrubPolicy [-Enable] [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-InputObject] [<CommonParameters>]

Set-VolumeScrubPolicy [-Enable] [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-ObjectId] [<CommonParameters>]

Set-VolumeScrubPolicy [-Enable] [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-FileSystemLabel] [<CommonParameters>]

Detailed Description

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

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DriveLetter <Char[]>

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.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Enable <Boolean>

Indicates whether to enable or disable the volume scrub policy.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-FileSystemLabel <String[]>

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

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-ObjectId <String[]>

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

Aliases

Id

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Path <String[]>

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

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Volume

Return Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Volume

Notes

None

Examples

Example 1: Set the volume scrub policy status

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

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

Online Version
Get-Volume
Get-VolumeScrubPolicy