en-US/HPENVDIMMCmdlets.dll-help.xml
|
<?xml version="1.0" encoding="UTF-8"?><helpItems 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" schema="maml">
<command:command> <command:details> <command:name>Get-HPENVDIMMConfig</command:name> <maml:description> <maml:para>Gets all or specific NVDIMM system configuration information.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2016-2017 Hewlett Packard Enterprise Development LP</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPENVDIMMConfig</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>This cmdlet can get specific NVDIMM system configuration information from the BIOS NFIT table. This includes Interleave infomation and System Physical Address mapping information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPENVDIMMConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ExpandObject</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ForceString</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>SubFunc</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ExpandObject</maml:name> <maml:description> <maml:para>Expands all output class type object information and serializes them as an object array. This parameter cannot be used with -ForceString. With this parameter, this cmdlet does not need to traverse the whole parent class structure to get data from the output structure.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> <dev:type> <maml:name>switch</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ForceString</maml:name> <maml:description> <maml:para>Forces the output to be in a string format instead of object based. The default output type is object based.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> <dev:type> <maml:name>switch</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>SubFunc</maml:name> <maml:description> <maml:para>Specifies which configuration information to get. Except “All”, other -SubFunc strings must be used in conjunction with “-ForceString” or “-ExpandObject” parameter. This parameter is not case-sensitive. The default is All. • All: All configuration information. • Interleave: NVDIMM interleave information. • SPA: NVDIMM system physical address range information. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <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:description> <maml:para>This cmdlet outputs PSObject or String with NVDIMM configuration information.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPENVDIMMConfig</dev:code> <dev:remarks> <maml:para>This example outputs all NVDIMM system configuration information in PSObject format.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPENVDIMMConfig -SubFunc interleave -ExpandObject</dev:code> <dev:remarks> <maml:para>This example outputs NVDIMM interleave configuration information in PSObject format. It will expand all PSObject items.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPENVDIMMConfig -SubFunc SPA -ForceString</dev:code> <dev:remarks> <maml:para>This example outputs NVDIMM SPA configuration information in string format.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Additional NVDIMM information:</maml:linkText> <maml:uri>http://persistentmemory.hpe.com/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Additional cmdlets:</maml:linkText> <maml:uri>https://www.powershellgallery.com/items?q=hp.powershell</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Additional cmdlets and information:</maml:linkText> <maml:uri>https://www.hpe.com/servers/powershell</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-HPENVDIMMHealth</command:name> <maml:description> <maml:para>Gets all or specific NVDIMM health information.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2016-2017 Hewlett Packard Enterprise Development LP</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPENVDIMMHealth</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>This Cmdlet gets all or specific NVDIMM health information for all or specific NVDIMM devices. The health information includes status summary, alarm and life span, and health statistics information. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPENVDIMMHealth</maml:name> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>DevNo</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ExpandObject</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ForceString</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>SubFunc</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>DevNo</maml:name> <maml:description> <maml:para>Specifies the NVDIMM device number. The value is from 1 to N. N is the total number of NVDIMM devices installed in the system. The default value of -1 gets all NVDIMM devices. A value of 0 gets the total number of NVDIMM devices installed in the system.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ExpandObject</maml:name> <maml:description> <maml:para>Expands all output class type object information and serializes them as an object array. This parameter cannot to be used with -ForceString. With this parameter, the cmdlet does not need to traverse the whole parent class structure to get data from the output structure.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> <dev:type> <maml:name>switch</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ForceString</maml:name> <maml:description> <maml:para>Forces the output to be in a string format instead of object based. The default output type is object based.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> <dev:type> <maml:name>switch</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>SubFunc</maml:name> <maml:description> <maml:para>Specifies which health information to get. Except “All”, other -SubFunc strings must be used in conjunction with “-ForceString” or “-ExpandObject” parameter. This parameter is not case-sensitive. The default is All. • All: All health information. • Status: NVDIMM health summary status. • Temp: NVDIMM current temperature. • Spare: NVDIMM spare block capacity. • Alarm: NVDIMM alarm trips. • Life: NVDIMM device life span information. • Shutdown: NVDIMM last shutdown status. • Statistics: NVDIMM health statistics. • Detail: NVDIMM health details. • Energy: NVDIMM energy source status. • Vendor: NVDIMM vendor specific data. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <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:description> <maml:para>This cmdlet outputs PSObject or String with NVDIMM health information.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPENVDIMMHealth -DevNo 1 -ExpandObject</dev:code> <dev:remarks> <maml:para>This example outputs all NVDIMM health information for the NVDIMM 1 device in PSObject format. It will expand all PSObject items.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPENVDIMMHealth -SubFunc Life -ForceString</dev:code> <dev:remarks> <maml:para>This example outputs NVDIMM life span information for all NVDIMM devices in string format.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Additional NVDIMM information:</maml:linkText> <maml:uri>http://persistentmemory.hpe.com/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Additional cmdlets:</maml:linkText> <maml:uri>https://www.powershellgallery.com/items?q=hp.powershell</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Additional cmdlets and information:</maml:linkText> <maml:uri>https://www.hpe.com/servers/powershell</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-HPENVDIMMHWInfo</command:name> <maml:description> <maml:para>Gets all or specific NVDIMM hardware information.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2016-2017 Hewlett Packard Enterprise Development LP</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPENVDIMMHWInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>This cmdlet gets all or specific NVDIMM hardware information for specific NVDIMM devices. The hardware information includes various NVDIMM parameters reported from the BIOS. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPENVDIMMHWInfo</maml:name> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>DevNo</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ExpandObject</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ForceString</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>SubFunc</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>DevNo</maml:name> <maml:description> <maml:para>Specifies the NVDIMM device number. The value is from 1 to N. N is the total number of NVDIMM devices installed in system. The default value of -1 gets all NVDIMM devices. A value of 0 gets the total number of NVDIMM devices installed in the system.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ExpandObject</maml:name> <maml:description> <maml:para>Expands all output class type object information and serializes them as an object array. This parameter cannot to be used with -ForceString. With this parameter, the cmdlet does not need to traverse the whole parent class structure to get data from the output structure.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> <dev:type> <maml:name>switch</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ForceString</maml:name> <maml:description> <maml:para>Forces the output to be in a string format instead of object based. The default output type is object based.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> <dev:type> <maml:name>switch</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>SubFunc</maml:name> <maml:description> <maml:para>Specifies which hardware information to get. Except “All”, other -SubFunc strings must be used in conjunction with “-ForceString” or “-ExpandObject” parameter. This parameter is not case-sensitive. The default is All. • All: All hardware information. • Location: NVDIMM hardware location. • Bank: NVDIMM hardware bank information. • Type: NVDIMM type. • Size: NVDIMM size. • Speed: NVDIMM speed. • Cfg_Speed: NVDIMM configured speed. • Manufacturer: NVDIMM manufacturer information. • Serial: NVDIMM serial number. • Asset: NVDIMM asset tag. • Part: NVDIMM part number. • Min_Volt: NVDIMM minimum voltage. • Max_Volt: NVDIMM maximum voltage. • Cfg_Volt: NVDIMM configured voltage. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <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:description> <maml:para>This cmdlet outputs PSObject or String with NVDIMM hardware information.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPENVDIMMHWInfo -DevNo 1 -ExpandObject</dev:code> <dev:remarks> <maml:para>This example outputs all NVDIMM hardware information for the NVDIMM 1 device in PSObject format. It will expand all PSObject items.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPENVDIMMHWInfo -SubFunc size -ForceString</dev:code> <dev:remarks> <maml:para>This example outputs NVDIMM size information for all NVDIMM devices in string format.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Additional NVDIMM information:</maml:linkText> <maml:uri>http://persistentmemory.hpe.com/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Additional cmdlets:</maml:linkText> <maml:uri>https://www.powershellgallery.com/items?q=hp.powershell</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Additional cmdlets and information:</maml:linkText> <maml:uri>https://www.hpe.com/servers/powershell</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-HPENVDIMMModuleVersion</command:name> <maml:description> <maml:para>Gets the module version information.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2016-2017 Hewlett Packard Enterprise Development LP</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPENVDIMMModuleVersion</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>This cmdlet gets the HPENVDIMMCmdlets module version information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPENVDIMMModuleVersion</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <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:description> <maml:para>This cmdlet outputs PSObject with HPENVDIMMCmdlets module version information.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPENVDIMMModuleVersion</dev:code> <dev:remarks> <maml:para>This example outputs HPENVDIMMCmdlets module version in PSObject format.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Additional NVDIMM information:</maml:linkText> <maml:uri>http://persistentmemory.hpe.com/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Additional cmdlets:</maml:linkText> <maml:uri>https://www.powershellgallery.com/items?q=hp.powershell</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Additional cmdlets and information:</maml:linkText> <maml:uri>https://www.hpe.com/servers/powershell</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-HPENVDIMMStatus</command:name> <maml:description> <maml:para>Gets all or specific NVDIMM status information.</maml:para> </maml:description> <maml:copyright> <maml:para>(C) Copyright 2016-2017 Hewlett Packard Enterprise Development LP</maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPENVDIMMStatus</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>This cmdlet can get specific NVDIMM status information for specific NVDIMM devices. The status information includes identification status and energy source status information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HPENVDIMMStatus</maml:name> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>DevNo</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ExpandObject</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ForceString</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>SubFunc</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>DevNo</maml:name> <maml:description> <maml:para>Specifies the NVDIMM device number. The value is from 1 to N. N is the total number of NVDIMM devices installed in system. The default value of -1 gets all NVDIMM devices. A value of 0 gets the total number of NVDIMM devices installed in the system.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ExpandObject</maml:name> <maml:description> <maml:para>Expands all output class type object information and serializes them as an object array. This parameter cannot be used with -ForceString. With this parameter, this cmdlet does not need to traverse the whole parent class structure to get data from the output structure.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> <dev:type> <maml:name>switch</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>ForceString</maml:name> <maml:description> <maml:para>Forces the output to be in a string format instead of object based. The default output type is object based.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">switch</command:parameterValue> <dev:type> <maml:name>switch</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="Named" aliases=""> <maml:name>SubFunc</maml:name> <maml:description> <maml:para>Specifies which device status information to get. Except “All”, other -SubFunc strings must be used in conjunction with “-ForceString” or “-ExpandObject” parameter. This parameter is not case-sensitive. The default is All. • All: All status information. • Identify: NVDIMM identification status. • Energy: NVDIMM energy source status. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <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:description> <maml:para>This cmdlet outputs PSObject or String with NVDIMM status information.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPENVDIMMStatus -DevNo 1 -ExpandObject</dev:code> <dev:remarks> <maml:para>This example outputs all NVDIMM status information for NVDIMM 1 device in PSObject format. It will expand all PSObject items to display.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPENVDIMMStatus -SubFunc energy -ForceString</dev:code> <dev:remarks> <maml:para>This example outputs NVDIMM energy source status for all NVDIMM devices in string format.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Additional NVDIMM information:</maml:linkText> <maml:uri>http://persistentmemory.hpe.com/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Additional cmdlets:</maml:linkText> <maml:uri>https://www.powershellgallery.com/items?q=hp.powershell</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Additional cmdlets and information:</maml:linkText> <maml:uri>https://www.hpe.com/servers/powershell</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |