Edit

Get-VolumeScrubPolicy

  • Reference
Module:
Storage

Gets the status of the volume scrub policy.

Syntax

Get-VolumeScrubPolicy
   [-DriveLetter] <Char[]>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-VolumeScrubPolicy
   -ObjectId <String[]>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-VolumeScrubPolicy
   -Path <String[]>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-VolumeScrubPolicy
   -FileSystemLabel <String[]>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-VolumeScrubPolicy
   -InputObject <CimInstance[]>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-VolumeScrubPolicy cmdlet gets the status of the volume scrub policy.

Examples

Example 1: Get the volume scrub policy

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

This command sets the volume scrub policy to $False, and then gets the volume scrub policy to verify the change.

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 gets 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

-FileSystemLabel

Specifies an array of file system labels. The cmdlet gets 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

-Path

Specifies an array of paths. The cmdlet gets 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 a Volume object to the InputObject parameter.

Outputs

Boolean

This cmdlet returns the whether the volume scrub policy is true or false.

Notes

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