HelpCache/Microsoft.Windows.Whea.WheaMemoryPolicy.dll-help.xml
|
<?xml version = "1.0" encoding = "utf-8" ?>
<helpItems schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-WheaMemoryPolicy</command:name><maml:description><maml:para>Retrieves the Windows Hardware Error Architecture (WHEA) memory policies in effect on a local or remote computer.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>WheaMemoryPolicy</command:noun><dev:version /></command:details><maml:description><maml:para></maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-WheaMemoryPolicy</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ComputerName</maml:name><maml:description><maml:para>Name of the remote computer from which to retrieve policy information. If no computer name is specified, the command returns the policy of the local computer. You can use cn as an alias for ComputerName.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ComputerName</maml:name><maml:description><maml:para>Name of the remote computer from which to retrieve policy information. If no computer name is specified, the command returns the policy of the local computer. You can use cn as an alias for ComputerName.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example: Get the WHEA memory policy settings from the local computer</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Get-WHEAMemoryPolicy DisableOffline : False DisablePFA : False PersistMemoryOffline : True PFAPageCount : 64 PFAErrorThreshold : 16 PFATimeOut : 86400 </dev:code><dev:remarks><maml:para>Return WHEA memory policy values from the local computer, as a WheaMemoryPolicy object.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287612</maml:uri></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Set-WheaMemoryPolicy</command:name><maml:description><maml:para>Sets the Windows Hardware Error Architecture (WHEA) memory policy on a local or remote computer.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Set</command:verb><command:noun>WheaMemoryPolicy</command:noun><dev:version /></command:details><maml:description><maml:para>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.</maml:para><maml:para>The following list specifies the WHEA memory policy elements:</maml:para><maml:para>DisableOffline: Disable decisions to take memory offline based on corrected or uncorrected errors.</maml:para><maml:para>DisablePFA: Disable predictive failure analysis (PFA) of memory pages based on the number of corrected errors reported in the page.</maml:para><maml:para>PersistMemoryOffline: Persist the decisions to take memory offline across reboots. This element applies to both corrected and uncorrected errors.</maml:para><maml:para>PFAPageCount: The maximum number of memory pages that WHEA monitors using PFA.</maml:para><maml:para>PFAErrorThreshold: The number of errors that need to occur within the timeout period for the page to be candidate for removal.</maml:para><maml:para>PFATimeout: The number of seconds before PFA takes a page out of the monitoring list.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-WheaMemoryPolicy</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ComputerName</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>DisableOffline</maml:name><maml:description><maml:para>Setting the DisableOffline policy element to TRUE prevents WHEA from removing memory pages in response to either corrected or uncorrected memory errors.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>DisablePFA</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>PersistMemoryOffline</maml:name><maml:description><maml:para>Setting the PersistMemoryOffline policy element to TRUE enables WHEA to persist memory offline decisions across computer reboots.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>PFAErrorThreshold</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>PFAPageCount</maml:name><maml:description><maml:para>The maximum size of the PFA monitoring list for pages that experience corrected memory errors.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>PFATimeout</maml:name><maml:description><maml:para>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.</maml:para><maml:para>WHEA stops monitoring a memory page when one of the following events occurs:</maml:para><maml:para>The monitoring interval exceeds the PfaTimeout value.</maml:para><maml:para>or</maml:para><maml:para>The number of detected errors exceeds the PfaErrorThreshold value.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ComputerName</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>DisableOffline</maml:name><maml:description><maml:para>Setting the DisableOffline policy element to TRUE prevents WHEA from removing memory pages in response to either corrected or uncorrected memory errors.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue><dev:type><maml:name>Boolean</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>DisablePFA</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue><dev:type><maml:name>Boolean</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>PFAErrorThreshold</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue><dev:type><maml:name>UInt32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>PFAPageCount</maml:name><maml:description><maml:para>The maximum size of the PFA monitoring list for pages that experience corrected memory errors.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue><dev:type><maml:name>UInt32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>PFATimeout</maml:name><maml:description><maml:para>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.</maml:para><maml:para>WHEA stops monitoring a memory page when one of the following events occurs:</maml:para><maml:para>The monitoring interval exceeds the PfaTimeout value.</maml:para><maml:para>or</maml:para><maml:para>The number of detected errors exceeds the PfaErrorThreshold value.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue><dev:type><maml:name>UInt32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>PersistMemoryOffline</maml:name><maml:description><maml:para>Setting the PersistMemoryOffline policy element to TRUE enables WHEA to persist memory offline decisions across computer reboots.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue><dev:type><maml:name>Boolean</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Enable WHEA predictive failure analysis</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Set-WheaMemoryPolicy -DisablePFA $FALSE </dev:code><dev:remarks><maml:para>Enable PFA on the local computer.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Change the memory time out policy on a remote computer</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Set-WHEAMemoryPolicy -ComputerName TestPC -PFATimeout 600 </dev:code><dev:remarks><maml:para>Change the WHEA memory policy on the remote computer TestPC to use a timeout of 600 seconds. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 3: Get and set WHEA memory policy in a script</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>$x=Get-WheaMemoryPolicy PS C:\>$x.DisableOffline=$TRUE$ PS C:\>$x | Set-WheaMemoryPolicy </dev:code><dev:remarks><maml:para>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. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=287613</maml:uri></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |