PowerShell Logo Small

Set-WheaMemoryPolicy



This is the built-in help made by Microsoft for the command 'Set-WheaMemoryPolicy', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

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

SYNTAX


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



Search powershellhelp.space

DESCRIPTION


The Set-WheaMemoryPolicy cmdlet sets 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.



<

RELATED LINKS


Online Version: http://go.microsoft.com/fwlink/p/?linkid=287613

REMARKS

<

Examples


Example 1: Enable WHEA predictive failure analysis

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



Enable PFA on the local computer.




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

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



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




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

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



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.