Chkdsk - powershell.one

Invokes the Chkdsk operation on the volume.

Example

Do not run below example code just to see what happens next. Many methods seriously affect your system. Always make sure you actually understand what the method and the code do.

# define the arguments you want to submit to the method
# remove values that you do not want to submit
# make sure you replace values with meaningful content before running the code
# see section "Parameters" below for a description of each argument.
$arguments = @{
    FixErrors       = [Boolean](12345)  # replace 12345 with a meaningful value
    ForceDismount   = [Boolean](12345)  # replace 12345 with a meaningful value
    OkToRunAtBootUp = [Boolean](12345)  # replace 12345 with a meaningful value
    RecoverBadSectors = [Boolean](12345)  # replace 12345 with a meaningful value
    SkipFolderCycle = [Boolean](12345)  # replace 12345 with a meaningful value
    VigorousIndexCheck = [Boolean](12345)  # replace 12345 with a meaningful value
}


# select the instance(s) for which you want to invoke the method
# you can use "Get-CimInstance -Query (ADD FILTER CLAUSE HERE!)" to safely play with filter clauses
# if you want to apply the method to ALL instances, remove "Where...." clause altogether.
$query = 'Select * From Win32_Volume Where (ADD FILTER CLAUSE HERE!)'
Invoke-CimMethod -Query $query -Namespace Root/CIMV2 -MethodName Chkdsk -Arguments $arguments |
Add-Member -MemberType ScriptProperty -Name ReturnValueFriendly -Passthru -Value {
  switch ([int]$this.ReturnValue)
  {
        0        {'Success'}
        default  {'Unknown Error '}
    }
}

To run this method on one or more remote systems, use New-CimSession:

$ComputerName = 'server12','server14'  # adjust to your server names
$Credential   = Get-Credential         # submit a user account with proper permissions

# define the arguments you want to submit to the method
# remove values that you do not want to submit
# make sure you replace values with meaningful content before running the code
# see section "Parameters" below for a description of each argument.
$arguments = @{
    FixErrors       = [Boolean](12345)  # replace 12345 with a meaningful value
    ForceDismount   = [Boolean](12345)  # replace 12345 with a meaningful value
    OkToRunAtBootUp = [Boolean](12345)  # replace 12345 with a meaningful value
    RecoverBadSectors = [Boolean](12345)  # replace 12345 with a meaningful value
    SkipFolderCycle = [Boolean](12345)  # replace 12345 with a meaningful value
    VigorousIndexCheck = [Boolean](12345)  # replace 12345 with a meaningful value
}


$session = New-CimSession -ComputerName $ComputerName -Credential $Credential

# select the instance(s) for which you want to invoke the method
# you can use "Get-CimInstance -Query (ADD FILTER CLAUSE HERE!)" to safely play with filter clauses
$query = 'Select * From Win32_Volume Where (ADD FILTER CLAUSE HERE!)'
Invoke-CimMethod -Query $query -Namespace Root/CIMV2 -MethodName Chkdsk -Arguments $arguments -CimSession $session |
Add-Member -MemberType ScriptProperty -Name ReturnValueFriendly -Passthru -Value {
  switch ([int]$this.ReturnValue)
  {
        0        {'Success'}
        default  {'Unknown Error '}
    }
}


Remove-CimSession -CimSession $session

Learn more about Invoke-CimMethod and invoking WMI methods.

Syntax

uint32 Chkdsk(
  [in] boolean FixErrors = FALSE,
  [in] boolean VigorousIndexCheck = TRUE,
  [in] boolean SkipFolderCycle = TRUE,
  [in] boolean ForceDismount = FALSE,
  [in] boolean RecoverBadSectors = FALSE,
  [in] boolean OkToRunAtBootUp = FALSE
);

Parameters

Name	Type	Description
FixErrors	Boolean	This parameter indicates what should be done to errors found on the disk. If true, then errors are fixed.
ForceDismount	Boolean	This parameter indicates whether the volume should be forced to dismount before checking.
OkToRunAtBootUp	Boolean	This parameter indicates whether the chkdsk operation should be performed at next boot up time, in case the operation could not be performed because the disk was locked at time the method was called.
RecoverBadSectors	Boolean	This parameter indicates whether the bad sectors should be located and the readable information should be recovered from these sectors.
SkipFolderCycle	Boolean	This parameter indicates whether the folder cycle checking should be skipped or not.
VigorousIndexCheck	Boolean	This parameter indicates whether a vigorous check of index entries should be performed.

Return Value

Returns a value of type UInt32. Return values:

$returnValues = @{
    0    = 'Success'
}

Requirements

To use Win32_Volume, the following requirements apply:

PowerShell

Get-CimInstance was introduced with PowerShell Version 3.0, which in turn was introduced on clients with Windows 8 and on servers with Windows Server 2012.

If necessary, update Windows PowerShell to Windows PowerShell 5.1, or install PowerShell 7 side-by-side.

Operating System

Win32_Volume was introduced on clients with None supported and on servers with Windows Server 2003.

Namespace

Win32_Volume lives in the Namespace Root/CIMV2. This is the default namespace. There is no need to use the -Namespace parameter in Get-CimInstance.

Implementation

Win32_Volume is implemented in Vdswmi.dll and defined in Vds.mof. Both files are located in the folder C:\Windows\system32\wbem:

explorer $env:windir\system32\wbem
notepad $env:windir\system32\wbem\Vds.mof

PREVIOUSArchive