ExcludeFromAutoChk - powershell.one

Excludes volumes from the Chkdsk operation to be run at the next reboot.

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 = @{
    Volume          = 'someText'  # replace 'someText' with meaningful text
}


Invoke-CimMethod -ClassName Win32_Volume -Namespace Root/CIMV2 -MethodName ExcludeFromAutoChk -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 = @{
    Volume          = 'someText'  # replace 'someText' with meaningful text
}


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

Invoke-CimMethod -ClassName Win32_Volume -Namespace Root/CIMV2 -MethodName ExcludeFromAutoChk -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 ExcludeFromAutoChk(
  [in] string Volume[]
);

Parameters

Name	Type	Description
Volume	String	This parameter is used to specify the list of volumes that should be excluded from autochk at next reboot. The string syntax consists of the the drive letter followed by a colon for the logical disk.

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