Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Set-WheaMemoryPolicy

Published: March 30, 2012

Updated: September 15, 2012

Applies To: Windows 8, Windows Server 2012

Set-WheaMemoryPolicy

Sets the Windows Hardware Error Architecture (WHEA) memory policy on a local or remote computer.

Syntax

Parameter Set: Default
Set-WheaMemoryPolicy [-ComputerName <String> ] [-DisableOffline <Boolean> ] [-DisablePFA <Boolean> ] [-PersistMemoryOffline <Boolean> ] [-PFAErrorThreshold <UInt32> ] [-PFAPageCount <UInt32> ] [-PFATimeout <UInt32> ] [ <CommonParameters>]




Detailed Description

Set the elements of the WHEA (Windows Hardware Error Architecture) memory policy on the specified computer. WHEA receives memory errors, corrected and uncorrected, from the platform and implements a Predictive Failure Analysis (PFA) algorithm based on corrected errors. WHEA attempts to remove from the available system memory the pages that have uncorrected errors, or are predicted to fail based on corrected errors,. The removal decisions can be persisted across reboots. You can change the WHEA decision criteria against memory errors by tuning the WHEA memory policy. These policy elements can be set independently of each other. The new policy element values take effect immediately.

The following list specifies the WHEA memory policy elements:

DisableOffline: Disable decisions to take memory offline based on corrected or uncorrected errors.

DisablePFA: Disable predictive failure analysis (PFA) of memory pages based on the number of corrected errors reported in the page.

PersistMemoryOffline: Persist the decisions to take memory offline across reboots. This element applies to both corrected and uncorrected errors.

PFAPageCount: The maximum number of memory pages that WHEA monitors using PFA.

PFAErrorThreshold: The number of errors that need to occur within the timeout period for the page to be candidate for removal.

PFATimeout: The number of seconds before PFA takes a page out of the monitoring list.

Parameters

-ComputerName<String>

Name of the computer on which to set the policy. If you do not specify this value, the cmdlet sets policy on the local computer. You can use cn as an alias for ComputerName.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DisableOffline<Boolean>

Setting the DisableOffline policy element to TRUE prevents WHEA from removing memory pages in response to either corrected or uncorrected memory errors.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-DisablePFA<Boolean>

Setting the DisablePFA policy element to TRUE stops WHEA from monitoring the memory pages that have corrected errors, and disables the predicative failure analysis algorithm.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-PFAErrorThreshold<UInt32>

The PFAErrorThreshold is the number of corrected errors that need to occur before a memory page in the PFA monitoring list is considered bad and will be taken offline.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-PFAPageCount<UInt32>

The maximum size of the PFA monitoring list for pages that experience corrected memory errors.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-PFATimeout<UInt32>

The number of seconds that WHEA monitors a memory page using PFA. WHEA starts monitoring a memory page when the page has its first corrected error.

WHEA stops monitoring a memory page when one of the following events occurs:

The monitoring interval exceeds the PfaTimeout value.

or

The number of detected errors exceeds the PfaErrorThreshold value.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-PersistMemoryOffline<Boolean>

Setting the PersistMemoryOffline policy element to TRUE enables WHEA to persist memory offline decisions across computer reboots.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Examples

 

PS C:\> 

Example 1: Enable WHEA predictive failure analysis

Enable PFA on the local computer.


 

PS C:\> Set-WheaMemoryPolicy -DisablePFA $FALSE

Example 2: Change the memory time out policy on a remote computer

Change the WHEA memory policy on the remote computer TestPC to use a timeout of 600 seconds.


 

PS C:\> Set-WHEAMemoryPolicy -ComputerName TestPC -PFATimeout 600

Example 3: Get and set WHEA memory policy in a script

Get the memory policy in the object x, change the value of x.DisableOffline to TRUE, and then use x to set the memory policy.


 

PS C:\> $x=Get-WheaMemoryPolicy
$x.DisableOffline=$TRUE$
$x | Set-WheaMemoryPolicy

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.