en-US/HPESysInfoCmdlets.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--> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <!-- Module: HPESysInfoCmdlets Version: 1.6 --> <!--Version 1.6, XML modified by TDC OE-Windows --> <!--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-HPESysInfoLog</command:name> <maml:description> <maml:para>The Clear-HPESysInfoLog cmdlet clears one or more logs created by the HPESysInfoCmdlets module.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPESysInfoLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPESysInfoLog cmdlet clears one or more logs created by the HPESysInfoCmdlets 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-HPESysInfoLog</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-HPESysInfoLog 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-HPESysInfoLog 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 HPESysInfoCmdlets module.</maml:para> </maml:introduction> <dev:code>PS C:\> Clear-HPESysInfoLog 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-HPESysInfoLog -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-HPESysInfoLog -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-HPESysInfoLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPESysInfoLog</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-HPESysInfoLog</command:name> <maml:description> <maml:para>The Disable-HPESysInfoLog cmdlet disables the HPESysInfoCmdlets 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>HPESysInfoLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disable-HPESysInfoLog cmdlet disables the HPESysInfoCmdlets logging for the current PowerShell session.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disable-HPESysInfoLog</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 HPESysInfoCmdlets logging for the current PowerShell session.</maml:para> </maml:introduction> <dev:code>PS C:\> Disable-HPESysInfoLog 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-HPESysInfoLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPESysInfoLog</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-HPESysInfoLog</command:name> <maml:description> <maml:para>The Enable-HPESysInfoLog cmdlet enables HPESysInfoCmdlets 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>HPESysInfoLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Enable-HPESysInfoLog cmdlet enables HPESysInfoCmdlets 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-HPESysInfoLog</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 HPESysInfoCmdlets logging for the current PowerShell session.</maml:para> </maml:introduction> <dev:code>PS C:\> Enable-HPESysInfoLog LogFilePath ----------- C:\Program Files\WindowsPowerShell\Modules\HPESysInfoCmdlets\1.5.0.2\Logs\HPESysInfoCmdlets_1242019_1180791.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-HPESysInfoLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPESysInfoLog</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-HPESysInfoASR</command:name> <maml:description> <maml:para>Get Automatic Server Recovery information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoASR</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get Automatic Server Recovery information including its state (enabled or disabled) and the timeout interval (in minutes).</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPESysInfoASR</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 the operation to retrieve the data was not successful. The “StatusInfo” message will specify the reason why the data retrieval operation failed. If the data retrieval operation is successful, "Status: OK" will be returned for the cmdlet, and the component status will be seen in the Health property and/or other properties of the PS object. </maml:para> <maml:para></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-HPESysInfoASR and display the Automatic Server Recovery information of the server.</maml:para> </maml:introduction> <dev:code>PS C:\> $asr = Get-HPESysInfoASR PS C:\> $asr | fl ASRState : Enabled TimeoutInMinutes : 10 Status : OK</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPESysInfoASR and check whether Automatic Server Recovery is enabled.</maml:para> </maml:introduction> <dev:code>PS C:\> $asr = Get-HPESysInfoASR PS C:\> $asr.ASRState Enabled </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPESysInfoASR and show the time out interval (in minutes).</maml:para> </maml:introduction> <dev:code>PS C:\> $asr = Get-HPESysInfoASR PS C:\> $asr.TimeoutInMinutes 10</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-HPESysInfoBIOSSettings</command:name> <maml:description> <maml:para>Get information about BIOS settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoBIOSSettings</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get information about BIOS settings including boot mode, NetworkBootRetry, and VirtualSerialPort.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoBIOSSettings</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoBIOSSettings</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </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 the operation to retrieve the data was not successful. The “StatusInfo” message will specify the reason why the data retrieval operation failed. If the data retrieval operation is successful, "Status: OK" will be returned for the cmdlet, and the component status will be seen in the Health property and/or other properties of the PS object. </maml:para> <maml:para></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-HPESysInfoBIOSSettings and show the information about boot mode.</maml:para> </maml:introduction> <dev:code>PS C:\> $bios = Get-HPESysInfoBIOSSettings -Username username -Password password PS C:\> $bios.BiosSettings.BootMode Uefi</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPESysInfoBIOSSettings and show the information about NetworkBootRetry.</maml:para> </maml:introduction> <dev:code>PS C:\> $bios = Get-HPESysInfoBIOSSettings -Crendential $Credential PS C:\> $bios.BiosSettings.NetworkBootRetry Enabled</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPESysInfoBIOSSettings and show the information about VirtualSerialPort.</maml:para> </maml:introduction> <dev:code>PS C:\> $bios = Get-HPESysInfoBIOSSettings PS C:\> $bios.BiosSettings.VirtualSerialPort Com1Irq4</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-HPESysInfoCooling</command:name> <maml:description> <maml:para>Get information about cooling of the system.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoCooling</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get information about cooling of the system including readings from temperature sensors and the speed of fans.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoCooling</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoCooling</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </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-HPESysInfoCooling and get the name of all the temperature sensors.</maml:para> </maml:introduction> <dev:code>PS C:\> $cool = Get-HPESysInfoCooling -Username username -Password password PS C:\> $cool.TemperatureSensors.Name 01-Inlet Ambient 02-CPU 03-P1 DIMM 1-3 04-P1 DIMM 4-6 05-HD Max 06-Chipset 07-Chipset Zone 08-P/S 1 09-P/S 2 10-VR P1 11-VR P1 Mem 1 12-VR P1 Mem 2 13-Stor Batt 14-iLO 15-iLO Zone 16-LOM 17-LOM Zone 18-PCI 1 19-PCI 2 20-PCI 3 21-PCI 4 22-PCI 5 23-PCI 1 Zone 24-PCI 2 Zone 25-PCI 3 Zone 26-PCI 4 Zone 27-PCI 5 Zone</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPESysInfoCooling and get information about all the fans on the system.</maml:para> </maml:introduction> <dev:code>PS C:\> $cool = Get-HPESysInfoCooling -Credential $credential PS C:\> $cool.Fans Name : Fan 1 Oem : {@{Hpe=System.Collections.Generic.List`1[System.Object]}} Reading : 6 ReadingUnits : Percent Status : {@{Health=OK; State=Enabled}} Name : Fan 2 Oem : {@{Hpe=System.Collections.Generic.List`1[System.Object]}} Reading : 0 ReadingUnits : Percent Status : {@{State=Absent}} Name : Fan 3 Oem : {@{Hpe=System.Collections.Generic.List`1[System.Object]}} Reading : 27 ReadingUnits : Percent Status : {@{Health=OK; State=Enabled}} Name : Fan 4 Oem : {@{Hpe=System.Collections.Generic.List`1[System.Object]}} Reading : 0 ReadingUnits : Percent Status : {@{State=Absent}}</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPESysInfoCooling and get the names of the temperature sensors that have non-zero readings.</maml:para> </maml:introduction> <dev:code>PS C:\> $cool = Get-HPESysInfoCooling PS C:\> $cool.TemperatureSensors | Where-Object {$_.ReadingCelsius -ne 0} | Select-Object -Property Name Name ---- 01-Inlet Ambient 07-Chipset Zone 10-VR P1 11-VR P1 Mem 1 12-VR P1 Mem 2 14-iLO 15-iLO Zone 16-LOM 17-LOM Zone 23-PCI 1 Zone 24-PCI 2 Zone 25-PCI 3 Zone 26-PCI 4 Zone 27-PCI 5 Zone </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-HPESysInfoEnclosure</command:name> <maml:description> <maml:para>Get information about the server enclosure.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoEnclosure</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get information about the server enclosure including the enclosure type, enclosure model number, chassis part number, assembly part number, enclosure serial number, manufacturer, chassis dimensions, and number of bay slots.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoEnclosure</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoEnclosure</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </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-HPESysInfoEnclosure and show information about enclosure.</maml:para> </maml:introduction> <dev:code>PS C:\> $encl = Get-HPESysInfoEnclosure -Username username -Password password PS C:\> $encl EnclosureStatus : OK OnboardAdministrator : @{IPv4Address=Not Available; IPv6=; MACAddress=Not Available} Manufacturer : HPE BayInfo : @{BayNumber=9; BaysConsumedHeight=1; BaysConsumedWidth=1} EnclosureModelNumberAndProductId : @{ModelZeroPartNumber=802322-B21; ChassisPartNumber=797738-B21; AssemblyPartNumber=808745-001; EnclosureModel=Synergy 12000 Frame; SerialNumber=MXQ65202K4} EnclosureType : G1 EnclosureSerialNumber : @{PCASerialNumber=PFHCE0BRH9Y05I; ChassisSerialNumber=MXQ65202K4} ChassisDimensions : @{ChassisWidth=482; ChassisHeight=442; ChassisDepth=909} NumberOfBaySlotsAndInterconnectSlots : {@{DevType=Enclosure; Name=Frame}, @{Count=12; DevType=BladeBay; Location=Front; Name=Devices}, @{Count=6; DevType=ICM; Location= Rear; Name=Interconnects}, @{Count=2; DevType=CIM; Name=Applianc es}...} Status : OK</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPESysInfoEnclosure and show information about bay slots and interconnect slots.</maml:para> </maml:introduction> <dev:code>PS C:\> $encl = Get-HPESysInfoEnclosure -Credential $credential PS C:\> $encl.NumberOfBaySlotsAndInterconnectSlots DevType Name ------- ---- Enclosure Frame BladeBay Devices ICM Interconnects CIM Appliances EM Frame Links Display Front Panel Fan Fans PS Power Supplies MaxMezzPerBB Max Mezz per Blade Bay MaxPortsPerMezz Max Ports per Mezz MaxLanesPerMezzPort Max Lanes per Mezz Port MaxJSxPerIcm Max JSx Connectors per ICM MaxBBPerBBB Max Bays per Bundle of Blade Bays BayStride BB slot stride per Enclosure NumberOfFanRows Number of fan rows per Enclosure </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPESysInfoEnclosure and show information about enclosure model number and product ID.</maml:para> </maml:introduction> <dev:code>PS C:\> $encl = Get-HPESysInfoEnclosure PS C:\> $encl.EnclosureModelNumberAndProductId ModelZeroPartNumber : 802322-B21 ChassisPartNumber : 797738-B21 AssemblyPartNumber : 808745-001 EnclosureModel : Synergy 12000 Frame SerialNumber : MXQ65202K4</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: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-HPESysInfoFirmware</command:name> <maml:description> <maml:para>Get all or specific information about firmware.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoFirmware</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESysInfoFirmware cmdlet gets detailed information about the firmware including the version, names of all firmware components, firmware inventory, and specific firmware components with array index.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoFirmware</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoFirmware</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> </dev:type> <maml:description> <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: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 HPESysInfoFirmware object and show firmware inventory.</maml:para> </maml:introduction> <dev:code>PS C:\> $fwre = Get-HPESysInfoFirmware -Username username -Password password PS C:\> $fwre.FIRMWAREINVENTORY Name Description Version ---- ----------- ------- iLO 5 SystemBMC 1.40 Feb 05 2019 System ROM SystemRomActive U30 v1.46 (10/02/2018) Intelligent Platform Abstraction Data PlatformDefinitionTable 7.2.0 Build 30 System Programmable Logic Device SystemProgrammableLogicDevice 0x2A Power Management Controller Firmware PowerManagementController 1.0.4 Power Supply Firmware PowerSupplies 1.00 Innovation Engine (IE) Firmware InnovationEngineFirmware 0.1.6.0 Server Platform Services (SPS) Firmware SPSFirmwareVersionData 4.0.4.288 Redundant System ROM SystemRomBackup U30 v1.40 (06/15/2018) Intelligent Provisioning Intelligent Provisioning 3.00.382 Power Management Controller FW Bootloader PowerManagementControllerBootloader 1.1 HPE Smart Storage Battery 1 Firmware StorageBattery 2.1 HPE Eth 10/25Gb 2p 640FLR-SFP28 Adptr 15b31015159000d3 14.22.14.14 Network Controller 14e41657103c22be 20.12.41 HPE Smart Array P408i-a SR Gen10 9005028f103c0602 1.65 Embedded Video Controller 102b0538159000e4 2.5</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoFirmware object and show specific firmware component with array index.</maml:para> </maml:introduction> <dev:code>PS C:\> $fwre.FIRMWAREINVENTORY.Count -Credential $credential 16 PS C:\> $fwre.FIRMWAREINVENTORY[2] Name Version ---- ------- Intelligent Platform Abstraction Data 1.35.0 Build 8</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoFirmware object and show the name of all firmware components.</maml:para> </maml:introduction> <dev:code>PS C:\> $fwre.FIRMWAREINVENTORY.Name iLO 5 System ROM Intelligent Platform Abstraction Data System Programmable Logic Device Power Management Controller Firmware Power Supply Firmware Innovation Engine (IE) Firmware Server Platform Services (SPS) Firmware Redundant System ROM Intelligent Provisioning Power Management Controller FW Bootloader HPE Smart Storage Battery 1 Firmware HPE Eth 10/25Gb 2p 640FLR-SFP28 Adptr Network Controller HPE Smart Array P408i-a SR Gen10 Embedded Video Controller</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: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-HPESysInfoManagementProcessor</command:name> <maml:description> <maml:para>Get information about Management Processor.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoManagementProcessor</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get information about Management Processor including its name, state (Enabled/Disabled), firmware version, active licence type, license key, and network information related to the management processor.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoManagementProcessor</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoManagementProcessor</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </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 the Get-HPESysInfoManagementProcessor and show the overall information.</maml:para> </maml:introduction> <dev:code>PS C:\> $manp = Get-HPESysInfoManagementProcessor -Username username -Password password PS C:\> $manp | fl LICENSESERVICE : {@{ActiveLicenseType=Perpetual; LicenseKey=XXXXX-XXXXX-XXXXX-XXXXX-XXXXX}} ETHERNETINTERFACES : {@{HostName=abc1; URL=abc1.domain.com; IPv4AddressGatewaySubnetmask=; IPv6Address=; ipv6LinkLocalPrefixLengthAndAddressSourceAndState=System.Object[]; MACAddress=; Duplex=True; Speed=1000}, @{HostName=abc1; URL=abc1.; IPv4AddressGatewaySubnetmask=; IPv6Address=Not Available; ipv6LinkLocalPrefixLengthAndAddressSourceAndState=Not Available; MACAddress=; Duplex=False; Speed=Not Available}} Name : iLO 5 v1.20 pass 27 State : @{State=Enabled} FirmwareVersionAndReleaseDate : @{Current=System.Collections.Generic.List`1[System.Object]} Status : OK </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get an object of the Get-HPESysInfoManagementProcessor and show its current firmware version and release date.</maml:para> </maml:introduction> <dev:code>PS C:\> $manp = Get-HPESysInfoManagementProcessor -Credential $credential PS C:\> $manp.FirmwareVersionAndReleaseDate.Current | fl BuildNumber : 59 BuildNumberString : 59 Date : Apr 10 2017 DebugBuild : False MajorVersion : 1 MinorVersion : 10 Time : VersionString : iLO 5 v1.10 </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get an object of the Get-HPESysInfoManagementProcessor and show the IPv4 information of one of its ethernet interfaces.</maml:para> </maml:introduction> <dev:code>PS C:\> $manp = Get-HPESysInfoManagementProcessor PS C:\> $manp.ETHERNETINTERFACES[0].IPv4AddressGatewaySubnetmask Address AddressOrigin Gateway SubnetMask ------- ------------- ------- ---------- 10.10.10.10 DHCP 10.10.10.1 255.255.0.0</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: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-HPESysInfoMemory</command:name> <maml:description> <maml:para>Get all or specific memory device information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoMemory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESysInfoMemory cmdlet gets detailed information about the memory devices on the system such as DIMM size, type, location, total memory size, and operating frequency.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoMemory</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoMemory</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </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 HPESysInfoMemory object and list information for all of the DIMMs.</maml:para> </maml:introduction> <dev:code>PS C:\> $mem = Get-HPESysInfoMemory -Username username -Password password PS C:\> $mem | fl MEMORY : {@{DIMMSize=; DIMMNonVolatileSize=-1; DIMMType=; DIMMLocation=; DIMMStatus=; VendorName=0; OperatingFrequency=Not Available; OperatingVoltage=0; OperatingMode=Not Available; PartNumber=Not Available; SerialNumber=Not Available}, @{DIMMSize=; DIMMNonVolatileSize=-1; DIMMType=; DIMMLocation=; DIMMStatus=; VendorName=0; OperatingFrequency=Not Available; OperatingVoltage=0; OperatingMode=Not Available; PartNumber=Not Available; SerialNumber=Not Available}, @{DIMMSize=; DIMMNonVolatileSize=0; DIMMType=; DIMMLocation=; DIMMStatus=; VendorName=44288; OperatingFrequency=2666; OperatingVoltage=12; OperatingMode=Not Available; PartNumber=840756-091; SerialNumber=Not Available}, @{DIMMSize=; DIMMNonVolatileSize=0; DIMMType=; DIMMLocation=; DIMMStatus=; VendorName=44288; OperatingFrequency=2666; OperatingVoltage=12; OperatingMode=Not Available; PartNumber=840756-091; SerialNumber=Not Available}...} TotalMemorySize : @{Status=System.Collections.Generic.List`1[System.Object]; TotalSystemMemoryGiB=8} AmpInfo : @{AmpModeActive=AdvancedECC; AmpModeStatus=AdvancedECC; AmpModeSupported=System.Object[]} Status : OK</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoMemory object and use array index to retrieve information about a specific DIMM.</maml:para> </maml:introduction> <dev:code>PS C:\> $mem = Get-HPESysInfoMemory -Credential $credential PS C:\> $mem.MEMORY[2] DIMMSize : @{CapacityMiB=16384; DataWidthBits=64} DIMMNonVolatileSize : 0 DIMMType : @{BaseModuleType=RDIMM; MemoryDeviceType=DDR4} DIMMLocation : @{MemoryLocation=; DeviceLocator=PROC 1 DIMM 3} DIMMStatus : @{MemoryLocation=; Status=; DIMMStatus=GoodInUse} VendorName : 44288 OperatingFrequency : 2666 OperatingVoltage : 12 OperatingMode : Not Available PartNumber : 840756-091 SerialNumber : Not Available</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoMemory object and display DIMMLocation of a specific DIMM.</maml:para> </maml:introduction> <dev:code>PS C:\> $mem = Get-HPESysInfoMemory PS C:\> $mem.MEMORY[0].DIMMLocation MemoryLocation DeviceLocator -------------- ------------- @{Channel=6; MemoryController=2; Slot=1; Socket=1} PROC 1 DIMM 1</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoMemory object and get the total memory size on the system.</maml:para> </maml:introduction> <dev:code>PS C:\> $mem = Get-HPESysInfoMemory PS C:\> $mem.TotalMemorySize Status TotalSystemMemoryGiB TotalSystemPersistentMemoryGiB ------ -------------------- ------------------------------ {@{HealthRollup=OK}} 128 0</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: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-HPESysInfoModuleVersion</command:name> <maml:description> <maml:para>The Get-HPESysInfoModuleVersion cmdlet gets the module details of the installed HPESysInfoCmdlets module.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoModuleVersion</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESysInfoModuleVersion cmdlet gets the module details of the installed HPESysInfoCmdlets module. The details include the name of the file, path, description, GUID, version, and supported UI cultures with respective versions.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> </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.Management.Automation.PSObject[]</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>Get the module details of the installed HPESysInfoCmdlets module.</maml:para> </maml:introduction> <dev:code>PS C:\> Get-HPESysInfoModuleVersion Name : HPESysInfoCmdlets Path : C:\Program Files\WindowsPowerShell\Modules\HPESysInfoCmdlets\1.5.0.2\HPESysInfoCmdlets.dll Description : Scripting Tools for Windows PowerShell : SysInfo Cmdlets provides an in-band tool for system info & health status on Gen10 servers and Gen10+ servers. GUID : b557f265-ddb8-4723-ab21-51dc9da3e643 CurrentUICultureName : en-US CurrentUICultureVersion : 1.5.0.2 Version : 1.5.0.2 DotNetVersion : 4.6.2 PSVersion : @{PSVersion=5.1.14393.1198; PSEdition=Desktop; PSCompatibleVersions=System.Version[]; BuildVersion=10.0.14393.1198; CLRVersion=4.0.30319.42000; WSManStackVersion=3.0; PSRemotingProtocolVersion=2.3; SerializationVersion=1.1.0.1} OSVersion : @{Caption=Microsoft Windows Server 2016 Datacenter; CSDVersion=; Version=10.0.14393; BuildNumber=14393} CCGVersion : 1.2.0.0 AvailableUICulture : {@{UICultureName=en-US; UICultureVersion=1.5.0.2}} </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: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-HPESysInfoNetwork</command:name> <maml:description> <maml:para>Get all or specific information about network.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoNetwork</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESysInfoNetwork cmdlet gets detailed information about the network such as the adapter name, link status, and firmware version.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoNetwork</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoNetwork</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> </dev:type> <maml:description> <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: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 HPESysInfoNetwork object and show a specific network adapter by array index.</maml:para> </maml:introduction> <dev:code>PS C:\> $netw = get-hpesysinfonetwork -Username username -Password password PS C:\> $netw.BASENETWORKADAPTERS.count 2 PS C:\> $netw.BASENETWORKADAPTERS[0] AdapterNameAndModel : HPE Eth 10/25Gb 2p 640FLR-SFP28 Adptr LinkStatus : @{Status=System.Object[]; LinkStatus=System.Object[]; State=Not Available} MacAddress : {98:f2:b3:d1:c3:f0, 98:f2:b3:d1:c3:f1} IPv4Address : {} IPv6Address : {@{Address=N/A}, @{Address=N/A}} FWVersion : 14.22.14.14 PciDeviceStructuredName : NIC.FlexLOM.1.1 UefiDevicePath : PciRoot(0x3)/Pci(0x2,0x0)/Pci(0x0,0x0) DuplexInfo : {True, True} PartNumber : 840139-001 SerialNumber : IL273404NL InterfaceName : {Embedded FlexibleLOM 1 Port 1, Embedded FlexibleLOM 1 Port 2} MaxTransmissionUnit : {0, 0} StatisticsInfo : @{BadReceives=Not Available; BadTransmits=Not Available; GoodReceives=Not Available; GoodTransmits=Not Available} NicTeamingInfo : {Not Available, Not Available} FcPorts : @{WWNN=Not Available; WWPN=Not Available} PhysicalPorts : {@{FullDuplex=True; IPv4Addresses=System.Collections.Generic.List`1[System.Object]; IPv6Addresses=System.Collections.Generic.List`1[System.Object]; LinkStatus=null; MacAddress=98:f2:b3:d1:c3:f0; Name=Embedded FlexibleLOM 1 Port 1; Oem=System.Collections.Generic.List`1[System.Object]; SpeedMbps=0}, @{FullDuplex=True; IPv4Addresses=System.Collections.Generic.List`1[System.Object]; IPv6Addresses=System.Collections.Generic.List`1[System.Object]; LinkStatus=null; MacAddress=98:f2:b3:d1:c3:f1; Name=Embedded FlexibleLOM 1 Port 2; Oem=System.Collections.Generic.List`1[System.Object]; SpeedMbps=0}}</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoNetwork object and show the firmware version of all adapters.</maml:para> </maml:introduction> <dev:code>PS C:\> $netw.BASENETWORKADAPTERS.FWVersion -Credential $credential 14.22.14.14 20.12.41</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoNetwork object and show the adapter name and model of all network adapters.</maml:para> </maml:introduction> <dev:code>PS C:\> $netw.BASENETWORKADAPTERS.AdapterNameAndModel HPE Eth 10/25Gb 2p 640FLR-SFP28 Adptr HPE Eth 10/25Gb 2p 631SFP28 Adptr</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: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-HPESysInfoPCIDevice</command:name> <maml:description> <maml:para>Get all or specific PCI device information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoPCIDevice</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESysInfoPCIDevice cmdlet gets detailed information about the PCI devices on the system such as class code, VID, DID, SVID, SDID, SegmentNumber, BugNumber, DeviceNumber, and FunctionNumber.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoPCIDevice</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoPCIDevice</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </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 information about the PCI devices on the system from Get-HPESysInfoPCIDevice object.</maml:para> </maml:introduction> <dev:code>PS C:\> $pcid = Get-HPESysInfoPCIDevice -Username username -Password password PS C:\> $pcid | fl PCIDEVICES : {@{ProductName=HP Ethernet 1Gb 2-port 332i Adapter - NIC; PhysicalLocation=Embedded LOM 1; PciSegBusDevFn=; PciIds=; PCIDeviceType=Embedded LOM; PCIClassCode=}, @{ProductName=HP Ethernet 1Gb 2-port 332i Adapter - NIC; PhysicalLocation=Embedded LOM 1; PciSegBusDevFn=; PciIds=; PCIDeviceType=Embedded LOM; PCIClassCode=}, @{ProductName=Embedded SATA Controller #1; PhysicalLocation=Embedded SATA Controller #1; PciSegBusDevFn=; PciIds=; PCIDeviceType=HDD Not attached to a SA Controller; PCIClassCode=}, @{ProductName=Embedded SATA Controller #2; PhysicalLocation=Embedded SATA Controller #2; PciSegBusDevFn=; PciIds=; PCIDeviceType=HDD Not attached to a SA Controller; PCIClassCode=}} Status : OK</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get a Get-HPESysInfoPCIDevice object and use array index to display information for a specific PCI device.</maml:para> </maml:introduction> <dev:code>PS C:\> $pcid = Get-HPESysInfoPCIDevice -Credential $credential PS C:\> $pcid.PCIDEVICES[1] ProductName : HP Ethernet 1Gb 2-port 332i Adapter - NIC PhysicalLocation : Embedded LOM 1 PciSegBusDevFn : @{SegmentNumber=0; BusNumber=22; DeviceNumber=0; FunctionNumber=1} PciIds : @{VendorID=5348; DeviceID=5727; SubsystemVendorID=4156; SubsystemDeviceID=8936} PCIDeviceType : Embedded LOM PCIClassCode : @{ClassCode=2; SubclassCode=0}</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get a Get-HPESysInfoPCIDevice object and show the PCI Classcode of a particular PCI device.</maml:para> </maml:introduction> <dev:code>PS C:\> $pcid = Get-HPESysInfoPCIDevice PS C:\> $pcid.PCIDEVICES[1].PCIClasscode ClassCode SubclassCode --------- ------------ 2 0</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para>Get a Get-HPESysInfoPCIDevice object and list all the PCI devices from the PCI device array.</maml:para> </maml:introduction> <dev:code>PS C:\> $pcid= Get-HPESysInfoPCIDevice PS C:\> $pcid.PCIDEVICES | fl ProductName : HP Ethernet 1Gb 2-port 332i Adapter - NIC PhysicalLocation : Embedded LOM 1 PciSegBusDevFn : @{SegmentNumber=0; BusNumber=22; DeviceNumber=0; FunctionNumber=0} PciIds : @{VendorID=5348; DeviceID=5727; SubsystemVendorID=4156; SubsystemDeviceID=8936} PCIDeviceType : Embedded LOM PCIClassCode : @{ClassCode=2; SubclassCode=0} ProductName : HP Ethernet 1Gb 2-port 332i Adapter - NIC PhysicalLocation : Embedded LOM 1 PciSegBusDevFn : @{SegmentNumber=0; BusNumber=22; DeviceNumber=0; FunctionNumber=1} PciIds : @{VendorID=5348; DeviceID=5727; SubsystemVendorID=4156; SubsystemDeviceID=8936} PCIDeviceType : Embedded LOM PCIClassCode : @{ClassCode=2; SubclassCode=0} ProductName : Embedded SATA Controller #1 PhysicalLocation : Embedded SATA Controller #1 PciSegBusDevFn : @{SegmentNumber=0; BusNumber=0; DeviceNumber=23; FunctionNumber=0} PciIds : @{VendorID=32902; DeviceID=41346; SubsystemVendorID=5520; SubsystemDeviceID=235} PCIDeviceType : HDD Not attached to a SA Controller PCIClassCode : @{ClassCode=1; SubclassCode=6} ProductName : Embedded SATA Controller #2 PhysicalLocation : Embedded SATA Controller #2 PciSegBusDevFn : @{SegmentNumber=0; BusNumber=0; DeviceNumber=17; FunctionNumber=5} PciIds : @{VendorID=32902; DeviceID=41426; SubsystemVendorID=5520; SubsystemDeviceID=235} PCIDeviceType : HDD Not attached to a SA Controller PCIClassCode : @{ClassCode=1; SubclassCode=6}</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 5</maml:title> <maml:introduction> <maml:para>Get a Get-HPESysInfoPCIDevice object. Use the Count variable to get the number of PCI devices. Use "Get-Member | fl Name" to list the properties in a PCI device object. Finally, display the PCIDeviceType property of all PCI devices.</maml:para> </maml:introduction> <dev:code>PS C:\> $pcid= Get-HPESysInfoPCIDevice PS C:\> $pcid.PCIDEVICES.Count 4 PS C:\> $pcid.PCIDEVICES| Get-Member | fl Name Name : Equals Name : GetHashCode Name : GetType Name : ToString Name : PCIClassCode Name : PCIDeviceType Name : PciIds Name : PciSegBusDevFn Name : PhysicalLocation Name : ProductName PS C:\> $pcid.PCIDEVICES.PCIDeviceType Flexible LOM Flexible LOM Flexible LOM Flexible LOM Flexible LOM Flexible LOM Flexible LOM Flexible LOM Storage Array Controller</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: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-HPESysInfoPCISlot</command:name> <maml:description> <maml:para>Get all or specific PCI slot information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoPCISlot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESysInfoPCISlot cmdlet gets detailed information about the PCI slots on the system such as location, status, type, and characteristics.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoPCISlot</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoPCISlot</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </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 information about PCI slots on the system from the Get-HPESysInfoPCISlot object.</maml:para> </maml:introduction> <dev:code>PS C:\> $pcis = Get-HPESysInfoPCISlot -Username username -Password password PS C:\> $pcis | fl PCISLOTS : {@{SlotLocation=PCI-E Slot 1; SlotStatus=InUse; SlotType=PCIExpressGen3; SlotLength=Long; SlotLinkLanes=x16; SlotSupportsHotPlug=False}, @{SlotLocation=PCI-E Slot 2; SlotStatus=InUse; SlotType=PCIExpressGen3; SlotLength=Short; SlotLinkLanes=x8; SlotSupportsHotPlug=False}, @{SlotLocation=NVMe Drive Box 2 Bay 1; SlotStatus=InUse; SlotType=Not Available; SlotLength=Other; SlotLinkLanes=x4; SlotSupportsHotPlug=True}, @{SlotLocation=NVMe Slot ; SlotStatus=Empty; SlotType=Not Available; SlotLength=Other; SlotLinkLanes=x4; SlotSupportsHotPlug=True}} Status : OK</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get a Get-HPESysInfoPCISlot object and use array index to display information for specific PCI slots.</maml:para> </maml:introduction> <dev:code>PS C:\> $pcis = Get-HPESysInfoPCISlot -Credential $credential PS C:\> $pcis.PCISLOTS[0,2] SlotLocation : PCI-E Slot 1 SlotStatus : InUse SlotType : PCIExpressGen3 SlotLength : Long SlotLinkLanes : x16 SlotSupportsHotPlug : False SlotLocation : NVMe Drive Box 2 Bay 1 SlotStatus : InUse SlotType : Not Available SlotLength : Other SlotLinkLanes : x4 SlotSupportsHotPlug : True</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get a Get-HPESysInfoPCISlot object and show the total number of PCI Slots and their locations.</maml:para> </maml:introduction> <dev:code>PS C:\> $pcis.PCISLOTS.Count 4 PS C:\> $pcis.PCISLOTS.SlotLocation PCI-E Slot 1 PCI-E Slot 2 NVMe Drive Box 2 Bay 1 NVMe Slot </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: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-HPESysInfoPowerSupply</command:name> <maml:description> <maml:para>Get information about power supply.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoPowerSupply</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get information about power supply including the firmware version, model, and PowerCapacityWatts.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoPowerSupply</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoPowerSupply</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </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-HPESysInfoPowerSupply and get the overall information about power supply.</maml:para> </maml:introduction> <dev:code>PS C:\> $pwsp = Get-HPESysInfoPowerSupply -Username username -Password password PS C:\> $pwsp | fl PowerSupply : {@{FirmwareVersion=1.01; LastPowerOutputWatts=116; LineInputVoltage=215; LineInputVoltageType=ACHighLine; Model=865408-B21; Name=HpeServerPowerSupply; Oem=System.Collections.Generic.List`1[System.Object]; PowerCapacityWatts=500; PowerSupplyType=AC; SerialNumber=5WBXKV1LL36092; SparePartNumber=866729-001; Status=System.Collections.Generic.List`1[System.Object]}, @{Oem=System.Collections.Generic.List`1[System.Object]; Status=System.Collections.Generic.List`1[System.Object]}} SmartStorageBattery : @{ChargeLevelPercent=95; FirmwareVersion=2.2; Index=1; MaximumCapWatts=96; Model=875241-B21; ProductName=HPE Smart Storage Battery ; RemainingChargeTimeSeconds=0; SerialNumber=6WHCK0HB26402Z; SparePartNumber=875288-001; Status=System.Collections.Generic.List`1[System.Object]} Status : OK</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPESysInfoPowerSupply and get the firmware version of the power supplies.</maml:para> </maml:introduction> <dev:code>PS C:\> $pwsp = Get-HPESysInfoPowerSupply -Credential $credential PS C:\> $pwsp.PowerSupply.FirmwareVersion 1.01 </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPESysInfoPowerSupply and get the model name of the power supplies.</maml:para> </maml:introduction> <dev:code>PS C:\> $pwsp = Get-HPESysInfoPowerSupply PS C:\> $pwsp.PowerSupply.Model 865408-B21 </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPESysInfoPowerSupply and get the Smart Storage Battery of the power supplies.</maml:para> </maml:introduction> <dev:code>PS C:\> $pwsp = Get-HPESysInfoPowerSupply -Credential $credential PS C:\> $pwsp.SmartStorageBattery ChargeLevelPercent : 95 FirmwareVersion : 2.2 Index : 1 MaximumCapWatts : 96 Model : 875241-B21 ProductName : HPE Smart Storage Battery RemainingChargeTimeSeconds : 0 SerialNumber : 6WHCK0HB26402Z SparePartNumber : 875288-001 Status : {@{Health=OK; State=Enabled}}</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-HPESysInfoProcessor</command:name> <maml:description> <maml:para>Get all or specific processor information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoProcessor</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESysInfoProcessor cmdlet gets detailed information about the processors on the system.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoProcessor</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoProcessor</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </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 information about processors on the system from the Get-HPESysInfoProcessor object.</maml:para> </maml:introduction> <dev:code>PS C:\> $proc=Get-HPESysInfoProcessor -Username username -Password password PS C:\> $proc.PROCESSORS ProcessorType : Intel(R) Genuine processor Stepping : 2 Status : @{Populated=True; State=Enabled; Health=OK} PhysicalLocation : Proc 1 Speed : 3000 MaxCores : 1 CoresEnabled : 20 ThreadsEnabled : 1 ProcessorId : @{EffectiveFamily=179; EffectiveModel=5; IdentificationRegisters=0x06520005fbffbfeb; MicrocodeInfo=null; Step=2; VendorId=Intel(R) Corporation} MicrocodeInfo : {@{CpuId=0x00050651; Date=2/8/2016 12:00:00 AM; PatchId=0x8000002B}, @{CpuId=0x00050652; Date=12/2/2016 12:00:00 AM; PatchId=0x80000034}, @{CpuId=0x00050654; Date=1/31/2017 12:00:00 AM; PatchId=0x02000011}} ProcessorCharacteristics : {64Bit, MultiCore, HwThread, ExecuteProtection...} CacheInfo : {@{Associativity=8waySetAssociative; CacheSpeedns=0; CurrentSRAMType=System.Collections.Generic.List`1[System.Object]; EccType=SingleBitECC; InstalledSizeKB=1280; Location=Internal; MaximumSizeKB=1280; Name=L1-Cache; Policy=WriteBack; Socketed=False; SupportedSRAMType=System.Collections.Generic.List`1[System.Object]; SystemCacheType=Unified}, @{Associativity=16waySetAssociative; CacheSpeedns=0; CurrentSRAMType=System.Collections.Generic.List`1[System.Object]; EccType=SingleBitECC; InstalledSizeKB=20480; Location=Internal; MaximumSizeKB=20480; Name=L2-Cache; Policy=Varies; Socketed=False; SupportedSRAMType=System.Collections.Generic.List`1[System.Object]; SystemCacheType=Unified}, @{Associativity=FullyAssociative; CacheSpeedns=0; CurrentSRAMType=System.Collections.Generic.List`1[System.Object]; EccType=SingleBitECC; InstalledSizeKB=28160; Location=Internal; MaximumSizeKB=28160; Name=L3-Cache; Policy=Varies; Socketed=False; SupportedSRAMType=System.Collections.Generic.List`1[System.Object]; SystemCacheType=Unified}} VendorName : Intel(R) Corporation PartNumber : 826874-L21 SerialNumber : M841Y6M700732 ProcessorType : Intel(R) Genuine processor Stepping : 2 Status : @{Populated=True; State=Enabled; Health=OK} PhysicalLocation : Proc 2 Speed : 3000 MaxCores : 1 CoresEnabled : 20 ThreadsEnabled : 1 ProcessorId : @{EffectiveFamily=179; EffectiveModel=5; IdentificationRegisters=0x06520005fbffbfeb; MicrocodeInfo=null; Step=2; VendorId=Intel(R) Corporation} MicrocodeInfo : {@{CpuId=0x00050651; Date=2/8/2016 12:00:00 AM; PatchId=0x8000002B}, @{CpuId=0x00050652; Date=12/2/2016 12:00:00 AM; PatchId=0x80000034}, @{CpuId=0x00050654; Date=1/31/2017 12:00:00 AM; PatchId=0x02000011}} ProcessorCharacteristics : {64Bit, MultiCore, HwThread, ExecuteProtection...} CacheInfo : {@{Associativity=8waySetAssociative; CacheSpeedns=0; CurrentSRAMType=System.Collections.Generic.List`1[System.Object]; EccType=SingleBitECC; InstalledSizeKB=1280; Location=Internal; MaximumSizeKB=1280; Name=L1-Cache; Policy=WriteBack; Socketed=False; SupportedSRAMType=System.Collections.Generic.List`1[System.Object]; SystemCacheType=Unified}, @{Associativity=16waySetAssociative; CacheSpeedns=0; CurrentSRAMType=System.Collections.Generic.List`1[System.Object]; EccType=SingleBitECC; InstalledSizeKB=20480; Location=Internal; MaximumSizeKB=20480; Name=L2-Cache; Policy=Varies; Socketed=False; SupportedSRAMType=System.Collections.Generic.List`1[System.Object]; SystemCacheType=Unified}, @{Associativity=FullyAssociative; CacheSpeedns=0; CurrentSRAMType=System.Collections.Generic.List`1[System.Object]; EccType=SingleBitECC; InstalledSizeKB=28160; Location=Internal; MaximumSizeKB=28160; Name=L3-Cache; Policy=Varies; Socketed=False; SupportedSRAMType=System.Collections.Generic.List`1[System.Object]; SystemCacheType=Unified}} VendorName : Intel(R) Corporation PartNumber : 826874-L21 SerialNumber : M841Y6M700732</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Use array index to retrieve information about a specific processor from the PROCESSORS array in the Get-HPESysInfoProcessor object.</maml:para> </maml:introduction> <dev:code>PS C:\> $proc=Get-HPESysInfoProcessor -Credential $credential PS C:\> $proc.PROCESSORS[0] ProcessorType : Intel(R) Genuine processor Stepping : 2 Status : @{Populated=True; State=Enabled; Health=OK} PhysicalLocation : Proc 1 Speed : 3000 MaxCores : 1 CoresEnabled : 20 ThreadsEnabled : 1 ProcessorId : @{EffectiveFamily=179; EffectiveModel=5; IdentificationRegisters=0x06520005fbffbfeb; MicrocodeInfo=null; Step=2; VendorId=Intel(R) Corporation} MicrocodeInfo : {@{CpuId=0x00050651; Date=2/8/2016 12:00:00 AM; PatchId=0x8000002B}, @{CpuId=0x00050652; Date=12/2/2016 12:00:00 AM; PatchId=0x80000034}, @{CpuId=0x00050654; Date=1/31/2017 12:00:00 AM; PatchId=0x02000011}} ProcessorCharacteristics : {64Bit, MultiCore, HwThread, ExecuteProtection...} CacheInfo : {@{Associativity=8waySetAssociative; CacheSpeedns=0; CurrentSRAMType=System.Collections.Generic.List`1[System.Object]; EccType=SingleBitECC; InstalledSizeKB=1280; Location=Internal; MaximumSizeKB=1280; Name=L1-Cache; Policy=WriteBack; Socketed=False; SupportedSRAMType=System.Collections.Generic.List`1[System.Object]; SystemCacheType=Unified}, @{Associativity=16waySetAssociative; CacheSpeedns=0; CurrentSRAMType=System.Collections.Generic.List`1[System.Object]; EccType=SingleBitECC; InstalledSizeKB=20480; Location=Internal; MaximumSizeKB=20480; Name=L2-Cache; Policy=Varies; Socketed=False; SupportedSRAMType=System.Collections.Generic.List`1[System.Object]; SystemCacheType=Unified}, @{Associativity=FullyAssociative; CacheSpeedns=0; CurrentSRAMType=System.Collections.Generic.List`1[System.Object]; EccType=SingleBitECC; InstalledSizeKB=28160; Location=Internal; MaximumSizeKB=28160; Name=L3-Cache; Policy=Varies; Socketed=False; SupportedSRAMType=System.Collections.Generic.List`1[System.Object]; SystemCacheType=Unified}} VendorName : Intel(R) Corporation PartNumber : 826874-L21 SerialNumber : M841Y6M700732</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Use array index on the PROCESSORS array in an HPESysInfoProcessor object to retrieve information from a specific cache.</maml:para> </maml:introduction> <dev:code>PS C:\> $proc=Get-HPESysInfoProcessor PS C:\> $proc.PROCESSORS[0].CacheInfo Associativity : 8waySetAssociative CacheSpeedns : 0 CurrentSRAMType : {Synchronous} EccType : SingleBitECC InstalledSizeKB : 1280 Location : Internal MaximumSizeKB : 1280 Name : L1-Cache Policy : WriteBack Socketed : False SupportedSRAMType : {Synchronous} SystemCacheType : Unified Associativity : 16waySetAssociative CacheSpeedns : 0 CurrentSRAMType : {Synchronous} EccType : SingleBitECC InstalledSizeKB : 20480 Location : Internal MaximumSizeKB : 20480 Name : L2-Cache Policy : Varies Socketed : False SupportedSRAMType : {Synchronous} SystemCacheType : Unified Associativity : FullyAssociative CacheSpeedns : 0 CurrentSRAMType : {Synchronous} EccType : SingleBitECC InstalledSizeKB : 28160 Location : Internal MaximumSizeKB : 28160 Name : L3-Cache Policy : Varies Socketed : False SupportedSRAMType : {Synchronous} SystemCacheType : Unified</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: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-HPESysInfoServer</command:name> <maml:description> <maml:para>Get all or specific information about the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESysInfoServer cmdlet gets detailed information about the server such as asset tag, TPM presence status, and UUID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoServer</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoServer</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </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 information about the server from the Get-HPESysInfoServer object.</maml:para> </maml:introduction> <dev:code>PS C:\> $serv=Get-HPESysInfoServer -Username username -Password password PS C:\> $serv PCISLOTS : {@{PCIBusType=Not Available}, @{PCIBusType=Not Available}, @{PCIBusType=PCIExpressGen3}, @{PCIBusType=PCIExpressGen3}} FIRMWARES : {@{SystemFWVersion=}, @{SystemFWVersion=}, @{SystemFWVersion=}, @{SystemFWVersion=}...} ProductName : ProLiant BL460c Gen10 CurrentOSVersion : 10.0.14393 CurrentOSProductName : Microsoft Windows Server 2016 Datacenter HostName : WIN-ABCDEFGHIJ HostIPAddresses : {$null, $null, 10.10.10.10, 2001:db8:0:1:1:1:1:1, $null...} UUID : 30373438-3231-4337-4537-303350313359 CPUTypeAndCount : @{Count=1; Model=Intel(R) Xeon(R) Gold 5117 CPU @ 2.00GHz; Status=System.Collections.Generic.List`1[System.Object]} MemoryTotalSize : @{Status=System.Collections.Generic.List`1[System.Object]; TotalSystemMemoryGiB=8} SystemSerialNumber : 7CE703P13Y ProductID : 847012-001 AssetTagString : TPMPresenceStatus : NotPresent AggregateHealthStatus : @{AgentlessManagementService=Ready; BiosOrHardwareHealth=System.Collections.Generic.List`1[System.Object]; FanRedundancy=Redundant; Fans=System.Collections.Generic.List`1[System.Object]; Memory=System.Collections.Generic.List`1[System.Object]; Network=System.Collections.Generic.List`1[System.Object]; PowerSupplies=System.Collections.Generic.List`1[System.Object]; Processors=System.Collections.Generic.List`1[System.Object]; SmartStorageBattery=System.Collections.Generic.List`1[System.Object]; Storage=System.Collections.Generic.List`1[System.Object]; Temperatures=System.Collections.Generic.List`1[System.Object]} Status : OK</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get ProductName information from the Get-HPESysInfoServer object.</maml:para> </maml:introduction> <dev:code>PS C:\> $serv=Get-HPESysInfoServer -Credential $credential PS C:\> $serv.ProductName ProLiant BL460c Gen10</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoServer object and display detailed information about a specific Host IP Address.</maml:para> </maml:introduction> <dev:code>PS C:\> $serv=Get-HPESysInfoServer PS C:\> $serv.HostIPAddresses[1] 10.10.10.10 2001:db8:0:1:1:1:1:1</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para>Get an object of Get-HPESysInfoServer and show all firmware versions along with firmware component names.</maml:para> </maml:introduction> <dev:code>PS C:\> $serv=Get-HPESysInfoServer PS C:\> $serv.FIRMWARES.SystemFWVersion | fl Name, Version Name : iLO 5 Version : 1.10 May 05 2017 Name : System ROM Version : I41 v1.00 (05/01/2017) Name : Intelligent Platform Abstraction Data Version : 1.31.0 Build 8 Name : System Programmable Logic Device Version : 0x1A Name : Power Management Controller Firmware Version : 1.0.2 Name : Innovation Engine (IE) Firmware Version : 0.1.0.23 Name : Server Platform Services (SPS) Firmware Version : 4.0.3.199 Name : Redundant System ROM Version : I41 v1.00 (05/01/2017) Name : Intelligent Provisioning Version : 3.00.344 Name : Power Management Controller FW Bootloader Version : 1.1 Name : HPE Smart Storage Battery 1 Firmware Version : 2.1 Name : HP FlexFabric 10Gb 2-port 536FLB Adapter Version : 7.15.35 Name : HPE Smart Array P204i-b SR Gen10 Version : 1.00 Name : Drive Version : HPD6</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: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-HPESysInfoServerHealth</command:name> <maml:description> <maml:para>Get information about server health.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoServerHealth</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESysInfoServerHealth cmdlet gets detailed information about the server health including its network, storage, processor, memory, power supply, cooling, management processor, and enclosure. The enclosure information will be excluded if the system is not a blade system.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoServerHealth</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoServerHealth</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </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 HPESysInfoServerHealth object and show the overall information about the server.</maml:para> </maml:introduction> <dev:code>PS C:\> $srvh = Get-HPESysInfoServerHealth -Username username -Password password PS C:\> $srvh | fl NetworkInfo : @{BASENETWORKADAPTERS=System.Management.Automation.PSObject[]; ETHERNETINTERFACES=System.Management.Automation.PSObject[]; IPAddress=System.String[]; StorageInfo : @{ARRAYCONTROLLERS=System.Management.Automation.PSObject[]} ProcessorInfo : @{PROCESSORS=System.Management.Automation.PSObject[]; HyperThreading=Enabled} MemoryInfo : @{MEMORY=System.Management.Automation.PSObject[]; TotalMemorySize=; AmpInfo=} PowerSupplyInfo : @{PowerSupply=Not Available} CoolingInfo : @{TemperatureSensors=System.Object[]; Fans=} ManagementProcessorInfo : @{LICENSESERVICE=System.Management.Automation.PSObject[]; ETHERNETINTERFACES=System.Management.Automation.PSObject[]; Name=iLO 5 v1.10 ; State=; FirmwareVersionAndReleaseDate=} EnclosureInfo : @{EnclosureType=G1; EnclosureModelNumberAndProductId=; EnclosureSerialNumber=; Manufacturer=HPE; ChassisDimensions=; NumberOfBaySlotsAndInterconnectSlots=System.Object[]} Status : OK</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoServerHealth object and show the chassis dimension of its enclosure.</maml:para> </maml:introduction> <dev:code>PS C:\> $srvh = Get-HPESysInfoServerHealth -Credential $credential PS C:\> $srvh.EnclosureInfo.ChassisDimensions | fl ChassisWidth : 482 ChassisHeight : 442 ChassisDepth : 909</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoServerHealth object and list the DIMMs that have capacity greater than zero.</maml:para> </maml:introduction> <dev:code>PS C:\> $srvh = Get-HPESysInfoServerHealth PS C:\> $srvh.MemoryInfo.MEMORY.DIMMSize | Where-Object -Property CapacityMiB -GT 0 | fl CapacityMiB : 8192 DataWidthBits : 64</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-HPESysInfoSoftware</command:name> <maml:description> <maml:para>Get all or specific information about the software installed on the system.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoSoftware</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESysInfoSoftware cmdlet gets detailed information about the software such as name and version.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoSoftware</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoSoftware</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> </dev:type> <maml:description> <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: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 HPESysInfoSoftware object and show the software inventory.</maml:para> </maml:introduction> <dev:code>PS C:\> $swre = Get-HPESysInfoSoftware -Username username -Password password PS C:\> $swre.SOFTWAREINVENTORY | fl Name : ams.exe Description : agentless management service Version : 1.30.0.0 Name : ssa.exe Description : smart storage administrator Version : 3.30.14.0</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoSoftware object and show specific software component with array index.</maml:para> </maml:introduction> <dev:code>PS C:\> $swre = Get-HPESysInfoSoftware -Credential $credential PS C:\> $swre.SOFTWAREINVENTORY[0] Name Description Version ---- ----------- ------- ams.exe agentless management service 1.30.0.0</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoSoftware object and show the names of all software components.</maml:para> </maml:introduction> <dev:code>PS C:\> $swre = Get-HPESysInfoSoftware PS C:\> $swre.SOFTWAREINVENTORY.Name ams.exe ssa.exe</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: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-HPESysInfoStorage</command:name> <maml:description> <maml:para>Get all or specific information about storage.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPESysInfoStorage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPESysInfoStorage cmdlet gets detailed information about the storage such as smart storage controllers, their model name, version, and the drives under them.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet"> <!--NAME: UsernamePasswordSet--> <maml:name>Get-HPESysInfoStorage</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Get-HPESysInfoStorage</maml:name> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="0"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be provided as an input along with Password. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to be provided along with Username. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. This parameter is required when the iLO security is enabled.</maml:para> <maml:para>ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> </dev:type> <maml:description> <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: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 HPESysInfoStorage object and show the HostBusAdapters.</maml:para> </maml:introduction> <dev:code>PS C:\> $s=Get-HPESysInfoStorage -Username username -Password password PS C:\> $s.HOSTBUSADAPTERS AdapterNameAndModel : Standard IDE Controller ControllerStatus : @{Health=OK; State=Enabled} FWVersion : Not Available PhysicalLocation : @{Location=System Board; LocationFormat=PCISlot} SerialNumber : DISKDRIVES : {@{PhysicalLocation=; SerialNumber=9XG9NR0F; PhysicalDriveInfo=}}</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoStorage object and show the serial numbers of all the diskdrives under all HostBusAdapters.</maml:para> </maml:introduction> <dev:code>PS C:\> $s=Get-HPESysInfoStorage -Credential $credential PS C:\> $s.HOSTBUSADAPTERS.diskdrives.SerialNumber 9XG9NR0F</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoStorage object and show the physical location of the first diskdrive under first HostBusAdapter.</maml:para> </maml:introduction> <dev:code>PS C:\> $s=Get-HPESysInfoStorage PS C:\> $s.HOSTBUSADAPTERS[0].diskdrives[0].PhysicalLocation Location LocationFormat -------- -------------- SATA Device 0 Not Available</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoStorage object and show the SmartArrayControllers.</maml:para> </maml:introduction> <dev:code>PS C:\> $s=Get-HPESysInfoStorage -Username username -Password password PS C:\> $s.ARRAYCONTROLLERS AdapterNameAndModel : HPE Smart Array P408i-a SR Gen10 PartNumber : 836260-001 SerialNumber : PEYHC0DRHBM80O ControllerStatus : @{Health=OK; State=Enabled} FWVersion : @{Current=System.Collections.Generic.List`1[System.Object]} PhysicalLocation : @{Location=Slot 0; LocationFormat=PCISlot} SmartArrayCacheModuleInfo : @{Model=HPE Smart Array P408i-a SR Gen10; Location=Slot 0; LocationFormat=PCISlot; Health=Not Available; CacheMemorySizeMiB=Not Available} DISKDRIVES : {@{SmartArrayEncryptionInfo=False; PhysicalDriveInfo=}, @{SmartArrayEncryptionInfo=False; PhysicalDriveInfo=}, @{SmartArrayEncryptionInfo=False; PhysicalDriveInfo=}, @{SmartArrayEncryptionInfo=False; PhysicalDriveInfo=}...} STORAGEENCLOSURES : {@{StorageEnclosureInfo=}, @{StorageEnclosureInfo=}}</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 5</maml:title> <maml:introduction> <maml:para>Get an HPESysInfoStorage object and show the storages in chassis.</maml:para> </maml:introduction> <dev:code>PS C:\> $s=Get-HPESysInfoStorage -Username username -Password password PS C:\> $s.CHASSIS AdapterNameAndModel PhysicalLocation SerialNumber PhysicalDriveInfo ------------------- ---------------- ------------ ----------------- MO003200KWJSQ @{Info=3:5; InfoFormat=Box:Bay} PHLE747500E13P2EGN @{Id=44fc2c23; CapacityBytes=... MO003200KWJSQ @{Info=3:6; InfoFormat=Box:Bay} PHLE747500RS3P2EGN @{Id=600bf68b; CapacityBytes=... MO003200KWJSQ @{Info=3:7; InfoFormat=Box:Bay} PHLE7474013U3P2EGN @{Id=600bf68b; CapacityBytes=... MO003200KWJSQ @{Info=3:8; InfoFormat=Box:Bay} PHLE747500VA3P2EGN @{Id=600bf68b; CapacityBytes=...</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:relatedLinks> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <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"> <!--Command--> <command:details> <command:name>Set-HPESysInfoASR</command:name> <maml:description> <maml:para>Set Automatic Server Recovery timeout.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPESysInfoASR</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set Automatic Server Recovery timeout interval (in minutes).The maximal timeout of the hardware timer is 139 minutes.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPESysInfoASR</maml:name> <command:parameter required="true" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>TimeoutInMinutes</maml:name> <maml:description> <maml:para>Specifes the ASR timeout. The value is specified in minutes. The default value is 10. The parameter accepts values in the range 0-255. ASR is disabled if the timeout is set to 0.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" globbing="false" pipelineInput="True (ByPropertyName)" variableLength="false" position="named"> <maml:name>TimeoutInMinutes</maml:name> <maml:description> <maml:para>Specifes the ASR timeout. The value is specified in minutes. The default value is 10. The parameter accepts values in the range 0-255. ASR is disabled if the timeout is set to 0.</maml:para> <maml:para>ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <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 /> </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>Set the timeout (in minutes) of the ASR timer</maml:para> </maml:introduction> <dev:code> C:\PS> Set-HPESysInfoASR -TimeoutInMinutes 10 C:\PS> Get-HPESysInfoASR ASRState TimeoutInMinutes Status -------- ---------------- ------ Enabled 10 OK </dev:code> <dev:remarks> <maml:para>This example shows the setup of the ASR timeout and display on screen.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri>http://www.hpe.com/servers/powershell</maml:uri> </maml:navigationLink> <!--Links--> </maml:relatedLinks> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.37--> </helpItems> |