en-US/HPENVDIMMCmdlets.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.37--> <!-- Module: HPENVDIMMCmdlets Version: 2.1.0.0 --> <!--Version 2.1.0.0, XML modified by Yee Lee --> <!--All Commands--> <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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Clear-HPENVDIMMLog</command:name> <maml:description> <maml:para>The Clear-HPENVDIMMLog cmdlet clears one or more logs created by the HPENVDIMMCmdlets module.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPENVDIMMLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPENVDIMMLog cmdlet clears one or more logs created by the HPENVDIMMCmdlets module. You are prompted for confirmation unless you specify the Force parameter.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPENVDIMMLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases=""> <maml:name>Last</maml:name> <maml:description> <maml:para>Specifies the integer as value. If you specify the value as X, then X number of logs in the descending order of their age, or the older logs, are cleared. If you do not use a parameter, all the existing logs including the current log are cleared.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" variableLength="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Clears all the existing logs without prompting for confirmation. By default, Clear-HPENVDIMMLog prompts for confirmation before clearing any logs from the module installation folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases=""> <maml:name>Last</maml:name> <maml:description> <maml:para>Specifies the integer as value. If you specify the value as X, then X number of logs in the descending order of their age, or the older logs, are cleared. If you do not use a parameter, all the existing logs including the current log are cleared.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Clears all the existing logs without prompting for confirmation. By default, Clear-HPENVDIMMLog prompts for confirmation before clearing any logs from the module installation folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>If the cmdlet executes successfully, it does not return anything. In case of an error, the error will be thrown.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Clear all the logs created by the HPENVDIMMCmdlets module.</maml:para> </maml:introduction> <dev:code>PS C:\> Clear-HPENVDIMMLog Do you really want to clear all the logs? [Y] Yes [N] No [S] Suspend</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>The first five logs in the descending order of their age, or the older logs, are cleared.</maml:para> </maml:introduction> <dev:code>C:\PS> Clear-HPENVDIMMLog -Last 5</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Clears all the existing logs without prompting for confirmation.</maml:para> </maml:introduction> <dev:code>C:\PS> Clear-HPENVDIMMLog -Force</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText /> <maml:uri>http://www.hpe.com/servers/powershell</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPENVDIMMLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPENVDIMMLog</maml:linkText> <maml:uri></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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Disable-HPENVDIMMLog</command:name> <maml:description> <maml:para>The Disable-HPENVDIMMLog cmdlet disables the HPENVDIMMCmdlets logging for the current PowerShell session.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>HPENVDIMMLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disable-HPENVDIMMLog cmdlet disables the HPENVDIMMCmdlets logging for the current PowerShell session.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disable-HPENVDIMMLog</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Disable the HPENVDIMMCmdlets logging for the current PowerShell session.</maml:para> </maml:introduction> <dev:code>PS C:\> Disable-HPENVDIMMLog Logging disabled for the current session!</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText /> <maml:uri>http://www.hpe.com/servers/powershell</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPENVDIMMLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPENVDIMMLog</maml:linkText> <maml:uri></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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Enable-HPENVDIMMLog</command:name> <maml:description> <maml:para>The Enable-HPENVDIMMLog cmdlet enables HPENVDIMMCmdlets logging for the current PowerShell session.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>HPENVDIMMLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Enable-HPENVDIMMLog cmdlet enables HPENVDIMMCmdlets logging for the current PowerShell session. By default, logging is disabled. If logging is required, it must be enabled explicitly. Log files can be found in the "Logs" directory in the cmdlet assembly file installation directory.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Enable-HPENVDIMMLog</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Enable HPENVDIMMCmdlets logging for the current PowerShell session.</maml:para> </maml:introduction> <dev:code>PS C:\> Enable-HPENVDIMMLog LogFilePath ----------- C:\Program Files\WindowsPowerShell\Modules\HPENVDIMMCmdlets\2.0.0.0\Logs\HPENVDIMMCmdlets_2232018_141259598.log</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText /> <maml:uri>http://www.hpe.com/servers/powershell</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPENVDIMMLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPENVDIMMLog</maml:linkText> <maml:uri></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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPENVDIMMConfig</command:name> <maml:description> <maml:para>Returns NVDIMM system configuration information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPENVDIMMConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns NVDIMM system configuration information.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPENVDIMMConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Add Note information here--> <maml:title>Status</maml:title> <maml:alert> <maml:para>The value returned in the "Status" property reflects the data retrieval operation of a cmdlet. It does not reflect the component status. When a cmdlet returns “Status: Error” or “Status: Warning”, it indicates that the operation to retrieve the data was not successful. The “StatusInfo” message specifies the reason for the data retrieval operation failure. If the data retrieval operation is successful, "Status: OK" is returned for the cmdlet, and the component status is displayed in the Health property and/or other properties of the PS object.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">EXAMPLE 1</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Get an object of Get-HPENVDIMMConfig and display the system physical address range information of the server.</maml:para> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> PS C:\> $cfg = Get-HPENVDIMMConfig PS C:\> $cfg.spaInfo | fl NFITSPAIndex : 1 SPAFLAG : 2 SPAFLAGInfo : Proximity domain data field is valid. ProximityDomain : 0 GUIDInfo : 79D3F066-F3B4-7440-AC43-0D3318B78CDB AddressRangeBase : 19327352832 AddressRangeLengthInByte : 8589934592 AddressRangeInfo : 0000000480000000h - 000000067FFFFFFFh AddressRangeAttribute : @{MemoryUncacheable=1; MemoryCacheWriteCombine=1; MemoryCacheWriteThrough=1; MemoryCacheWriteBack=1; MemoryUCE=0; MemoryWriteProtect=0; MemoryRP=0; MemoryXP=0; MemoryNonVolatile=1; MemoryMoreReliable=0} </dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText /> <maml:uri>http://www.hpe.com/servers/powershell</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPENVDIMMDiskInfo</command:name> <maml:description> <maml:para>Returns NVDIMM disk information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPENVDIMMDiskInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns NVDIMM disk information including disk type, disk size, and disk UUID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPENVDIMMDiskInfo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Add Note information here--> <maml:title>Status</maml:title> <maml:alert> <maml:para>The value returned in the "Status" property reflects the data retrieval operation of a cmdlet. It does not reflect the component status. When a cmdlet returns “Status: Error” or “Status: Warning”, it indicates that the operation to retrieve the data was not successful. The “StatusInfo” message specifies the reason for the data retrieval operation failure. If the data retrieval operation is successful, "Status: OK" is returned for the cmdlet, and the component status is displayed in the Health property and/or other properties of the PS object.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPENVDIMMDiskInfo and display the disk type of the first NVDIMM disk.</maml:para> </maml:introduction> <dev:code>PS C:\> $dk = Get-HPENVDIMMDiskInfo PS C:\> $dk.diskinfo[0].DiskType MBR </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText /> <maml:uri>http://www.hpe.com/servers/powershell</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPENVDIMMHWInfo</command:name> <maml:description> <maml:para>Returns NVDIMM hardware information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPENVDIMMHWInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns NVDIMM hardware information.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPENVDIMMHWInfo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Add Note information here--> <maml:title>Status</maml:title> <maml:alert> <maml:para>The value returned in the "Status" property reflects the data retrieval operation of a cmdlet. It does not reflect the component status. When a cmdlet returns “Status: Error” or “Status: Warning”, it indicates that the operation to retrieve the data was not successful. The “StatusInfo” message specifies the reason for the data retrieval operation failure. If the data retrieval operation is successful, "Status: OK" is returned for the cmdlet, and the component status is displayed in the Health property and/or other properties of the PS object.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPENVDIMMHWInfo and display the size of the first DIMM.</maml:para> </maml:introduction> <dev:code> PS C:\> $hw = Get-HPENVDIMMHWInfo PS C:\> $hw.HWInfo[0].SizeInBytes 8589934592 </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText /> <maml:uri>http://www.hpe.com/servers/powershell</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPENVDIMMStatus</command:name> <maml:description> <maml:para>Returns NVDIMM device status information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPENVDIMMStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns NVDIMM device status information.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPENVDIMMStatus</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Add Note information here--> <maml:title>Status</maml:title> <maml:alert> <maml:para>The value returned in the "Status" property reflects the data retrieval operation of a cmdlet. It does not reflect the component status. When a cmdlet returns “Status: Error” or “Status: Warning”, it indicates that the operation to retrieve the data was not successful. The “StatusInfo” message specifies the reason for the data retrieval operation failure. If the data retrieval operation is successful, "Status: OK" is returned for the cmdlet, and the component status is displayed in the Health property and/or other properties of the PS object.</maml:para> </maml:alert> <maml:alert> <maml:para>Properties returned may be different depending on the NVDIMM type on the server.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">EXAMPLE 1</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Get an object of Get-HPENVDIMMStatus and display the backup trigger configurations in the first HPE NVDIMM-N.</maml:para> </maml:introduction> <dev:code> PS C:\> $st = Get-HPENVDIMMStatus PS C:\> $st.HWStatus[0].SupportedBackupTrigger CKESingleLowTrigger : 1 ExternalSingleLowTrigger : 0 12VRailFallTrigger : 1 12CRegisterTrigger : 0 SAVE_NPinTrigger : 1 </dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:remarks> </command:example> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">EXAMPLE 2</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Get an object of Get-HPENVDIMMStatus and display the controller temperature threshold value in the first HPE Persistent Memory Module featuring Intel© Optane™ DC Persistent Memory Module.</maml:para> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> PS C:\> $st = Get-HPENVDIMMStatus PS C:\> $st.HWStatus[0].ControllerTemperatureThresholdInCelsius 98 </dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText /> <maml:uri>http://www.hpe.com/servers/powershell</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"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-HPENVDIMMHealth</command:name> <maml:description> <maml:para>Returns NVDIMM device health information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPENVDIMMHealth</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Returns NVDIMM device health information.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPENVDIMMHealth</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Add Note information here--> <maml:title>Status</maml:title> <maml:alert> <maml:para>The value returned in the "Status" property reflects the data retrieval operation of a cmdlet. It does not reflect the component status. When a cmdlet returns “Status: Error” or “Status: Warning”, it indicates that the operation to retrieve the data was not successful. The “StatusInfo” message specifies the reason for the data retrieval operation failure. If the data retrieval operation is successful, "Status: OK" is returned for the cmdlet, and the component status is displayed in the Health property and/or other properties of the PS object.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPENVDIMMHealth and get the percentage of spare capacity in the first NVDIMM.</maml:para> </maml:introduction> <dev:code>PS C:\> $health = Get-HPENVDIMMHealth PS C:\> $st.HealthInfo[0].SpareCapacityPercentage 99 </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText /> <maml:uri>http://www.hpe.com/servers/powershell</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.37--> </helpItems> |