< Back
Get-VolumeScrubPolicy
Post
NAME Get-VolumeScrubPolicy
SYNOPSIS
Gets the status of the volume scrub policy.
SYNTAX
Get-VolumeScrubPolicy [-DriveLetter] <Char[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-VolumeScrubPolicy [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] -ObjectId <String[]> [<CommonParameters>]
Get-VolumeScrubPolicy [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-VolumeScrubPolicy [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] -FileSystemLabel <String[]> [<CommonParameters>]
Get-VolumeScrubPolicy [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] -Path <String[]> [<CommonParameters>]
DESCRIPTION
The Get-VolumeScrubPolicy cmdlet gets the status of the volume scrub policy.
PARAMETERS
-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.
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 gets the volume scrub policy for the drives or
volumes you specify.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-FileSystemLabel <String[]>
Specifies an array of file system labels. The cmdlet gets the volume scrub policy for the file system labels you specify.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ObjectId <String[]>
Specifies an array of IDs, as strings. The ID is not globally unique.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Path <String[]>
Specifies an array of paths. The cmdlet gets the volume scrub policy for the paths you specify.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Volume
http://msdn.microsoft.com/library/windo ... 30604.aspx
You can use the pipeline operator to pass a Volume object to the InputObject parameter.
OUTPUTS
System.Boolean
This cmdlet returns the whether the volume scrub policy is true or false.
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816425
Get-Volume
Set-VolumeScrubPolicy
SYNOPSIS
Gets the status of the volume scrub policy.
SYNTAX
Get-VolumeScrubPolicy [-DriveLetter] <Char[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-VolumeScrubPolicy [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] -ObjectId <String[]> [<CommonParameters>]
Get-VolumeScrubPolicy [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [<CommonParameters>]
Get-VolumeScrubPolicy [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] -FileSystemLabel <String[]> [<CommonParameters>]
Get-VolumeScrubPolicy [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] -Path <String[]> [<CommonParameters>]
DESCRIPTION
The Get-VolumeScrubPolicy cmdlet gets the status of the volume scrub policy.
PARAMETERS
-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.
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 gets the volume scrub policy for the drives or
volumes you specify.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-FileSystemLabel <String[]>
Specifies an array of file system labels. The cmdlet gets the volume scrub policy for the file system labels you specify.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ObjectId <String[]>
Specifies an array of IDs, as strings. The ID is not globally unique.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Path <String[]>
Specifies an array of paths. The cmdlet gets the volume scrub policy for the paths you specify.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Volume
http://msdn.microsoft.com/library/windo ... 30604.aspx
You can use the pipeline operator to pass a Volume object to the InputObject parameter.
OUTPUTS
System.Boolean
This cmdlet returns the whether the volume scrub policy is true or false.
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816425
Get-Volume
Set-VolumeScrubPolicy