ja-JP/HPEiLOCmdlets.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems xmlns="http://msh" schema="maml"> <!-- Edited with: SAPIEN PowerShell HelpWriter 2020 v2.3.46--> <!--Generated by: SAPIEN PowerShell HelpWriter 2019 v2.3.42--> <!-- Module: HPEiLOCmdlets Version: 3.0.0.0 --> <!--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>Add-HPEiLODirectoryGroup</command:name> <maml:description> <maml:para>Adds a new Directory Group.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEiLODirectoryGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEiLODirectoryGroup cmdlet adds a new Directory Group to iLO. This cmdlet is supported on iLO 4 and iLO5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-HPEiLODirectoryGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Identifies a group container in the directory, such as Administrators, Users, or Power Users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupSID</maml:name> <maml:description> <maml:para>Specifies the SID for a group container.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to add, edit, and delete iLO user accounts. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoteConsPriv"> <maml:name>RemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to remotely access the host system Remote Console, including video, keyboard, and mouse control. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to use scripted Virtual Media with the local iLO system. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ConfigiLOPriv"> <maml:name>iLOConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure most iLO settings, including security settings, and to remotely update firmware. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to log in to iLO. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to power-cycle or reset the local iLO system. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to configure the host BIOS settings using the UEFI System Utilities. Only supported on iLO5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to configure the host NIC settings. Only supported on iLO5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to configure the host storage settings. Only supported on iLO5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to manage the System Recovery Set. Only supported on iLO5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Identifies a group container in the directory, such as Administrators, Users, or Power Users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupSID</maml:name> <maml:description> <maml:para>Specifies the SID for a group container.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to add, edit, and delete iLO user accounts. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoteConsPriv"> <maml:name>RemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to remotely access the host system Remote Console, including video, keyboard, and mouse control. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to use scripted Virtual Media with the local iLO system. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ConfigiLOPriv"> <maml:name>iLOConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure most iLO settings, including security settings, and to remotely update firmware. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to log in to iLO. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to power-cycle or reset the local iLO system. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to configure the host BIOS settings using the UEFI System Utilities. Only supported on iLO5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to configure the host NIC settings. Only supported on iLO5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to configure the host storage settings. Only supported on iLO5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to manage the System Recovery Set. Only supported on iLO5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as Object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>PARTIAL STATUS in iLO5</maml:title> <maml:alert> <maml:para>If the logged in user does not have sufficient privileges to change the permissions of the other users then this cmdlet will return status as "PARTIAL". The cmdlet successfully creates the new user but does not have permission to add privileges. This is because adding user and adding privileges is handled by two different Redfish URI's.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Add-HPEiLODirectoryGroup -GroupName admin -GroupSID 1-2-3-4 -UserConfigPrivilege Yes -iLOConfigPrivilege Yes -RemoteConsolePrivilege No -VirtualMediaPrivilege Yes -VirtualPowerAndResetPrivilege Yes -LoginPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet adds a new Directory Group to iLO 4 along with various Privileges with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Add-HPEiLODirectoryGroup -Connection $connection -GroupName admin -GroupSID 1-2-3-4 -UserConfigPrivilege Yes -iLOConfigPrivilege Yes -RemoteConsolePrivilege No -VirtualMediaPrivilege Yes -VirtualPowerAndResetPrivilege Yes -LoginPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet adds a new Directory Group to iLO 4, with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $add = $connection | Add-HPEiLODirectoryGroup -GroupName admin -GroupSID S-1-5-2039349 -HostBIOSConfigPrivilege Yes -HostNICConfigPrivilege Yes -HostStorageConfigPrivilege Yes -SystemRecoveryConfigPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet adds a new Directory Group to iLO 5, with an array of connection objects passed over pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://www.sapien.com</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLODirectoryGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLODirectoryGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLODirectoryGroup</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>Add-HPEiLOFederationGroup</command:name> <maml:description> <maml:para>Creates an iLO Federation group or includes an iLO in an existing group membership.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEiLOFederationGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet creates a new iLO Federation group or includes an iLO into an existing group membership while setting the associated privileges of that group for that iLO users. This cmdlet has the following parameters:</maml:para> <maml:para>· GroupName</maml:para> <maml:para>· GroupKey</maml:para> <maml:para>· NewPassword</maml:para> <maml:para>. UserConfigPrivilege</maml:para> <maml:para>. RemoteConsolePrivilege</maml:para> <maml:para>. VirtualMediaPrivilege</maml:para> <maml:para>. iLOConfigPrivilege</maml:para> <maml:para>. VirtualPowerAndResetPrivilege</maml:para> <maml:para>. LoginPrivilege (available only on Gen10 servers)</maml:para> <maml:para>. HostBIOSConfigPrivilege (available only on Gen10 servers)</maml:para> <maml:para>. HostNICConfigPrivilege (available only on Gen10 servers)</maml:para> <maml:para>. HostStorageConfigPrivilege (available only on Gen10 servers)</maml:para> <maml:para>. SystemRecoveryConfigPrivilege (available only on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-HPEiLOFederationGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>The name of the group to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupKey</maml:name> <maml:description> <maml:para>The password for the group to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to add, edit, and delete iLO user accounts. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoteConsPriv"> <maml:name>RemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to remotely access the host system Remote Console, including video, keyboard, and mouse control. The supported values are Yes and No.</maml:para> <maml:para>Aliases : RemoteConsPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to use scripted Virtual Media with the local iLO system. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ConfigiLOPriv"> <maml:name>iLOConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure most iLO settings, including security settings, and to remotely update firmware. The supported values are Yes and No.</maml:para> <maml:para>Aliases : ConfigiLOPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure Host BIOS Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure Host NIC Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure Host Storage Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to log in to iLO. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure System Recovery Configuration Privilege. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ResetServerPriv"> <maml:name>VirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to power-cycle or reset the local iLO system. The supported values are Yes and No.</maml:para> <maml:para>Aliases : ResetServerPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>The name of the group to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupKey</maml:name> <maml:description> <maml:para>The password for the group to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to add, edit, and delete iLO user accounts. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoteConsPriv"> <maml:name>RemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to remotely access the host system Remote Console, including video, keyboard, and mouse control. The supported values are Yes and No.</maml:para> <maml:para>Aliases : RemoteConsPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to use scripted Virtual Media with the local iLO system. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ConfigiLOPriv"> <maml:name>iLOConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure most iLO settings, including security settings, and to remotely update firmware. The supported values are Yes and No.</maml:para> <maml:para>Aliases : ConfigiLOPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure Host BIOS Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure Host NIC Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure Host Storage Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to log in to iLO. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure System Recovery Configuration Privilege. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ResetServerPriv"> <maml:name>VirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to power-cycle or reset the local iLO system. The supported values are Yes and No.</maml:para> <maml:para>Aliases : ResetServerPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Add-HPEiLOFederationGroup -GroupName testgroup -GroupKey testgroup123 -AdminPrivilege Yes -RemoteConsolePrivilege Yes -VirtualMediaPrivilege Yes -iLOConfigPrivilege Yes -LoginPrivilege Yes -VirtualPowerAndResetPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet adds a new Federation Group to iLO 4 along with various privileges with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Add-HPEiLOFederationGroup -Connection $connection -GroupName testgroup -GroupKey testgroup1 -AdminPrivilege Yes -RemoteConsolePrivilege Yes -VirtualMediaPrivilege Yes -iLOConfigPrivilege Yes -HostBIOSConfigPrivilege Yes -HostNICConfigPrivilege Yes -HostStorageConfigPrivilege Yes -LoginPrivilege Yes -SystemRecoveryConfigPrivilege Yes -VirtualPowerAndResetPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet adds a new Federation Group to iLO 5 along with various privileges with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Add-HPEiLOFederationGroup -GroupName testgroup -GroupKey testgroup123 -AdminPrivilege Yes -RemoteConsolePrivilege Yes -VirtualMediaPrivilege Yes -iLOConfigPrivilege Yes -LoginPrivilege Yes -VirtualPowerAndResetPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet adds a new Federation Group to iLO 4 and iLO 5 IP addresses along with various privileges with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOFederationGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOFederationGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOFederationGroup</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>Add-HPEiLOInstallationQueueWaitTask</command:name> <maml:description> <maml:para>Adds a wait time task to the installation queue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEiLOInstallationQueueWaitTask</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEiLOInstallationQueueWaitTask cmdlet adds a wait time task to the installation queue. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-HPEiLOInstallationQueueWaitTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>User defined name of the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Expire</maml:name> <maml:description> <maml:para>The task expiration date and time. The task automatically expires after this time. iLO automatically changes the state to Expired for such tasks. Supported format is yyyy-MM-dd HH:mm:ss. (For example 2018-06-27 19:23:14). Time must be given in 24 hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StartAfter</maml:name> <maml:description> <maml:para>The task start date and time. Supported format is yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 12:23:14)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatableBy</maml:name> <maml:description> <maml:para>This is an unordered set of permitted updaters that can execute the task from the installation queue.</maml:para> <maml:para>Supported values are: • Bmc: This component may be scheduled for update by iLO. • RuntimeAgent: This component may be scheduled for update by a runtime update agent such as Smart Update Manager or Smart Update Tool. • Uefi: This component may be scheduled for update by UEFI BIOS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTimeSeconds</maml:name> <maml:description> <maml:para>The number of seconds to pause.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ExecutionTimeoutMinutes</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>User defined name of the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Expire</maml:name> <maml:description> <maml:para>The task expiration date and time. The task automatically expires after this time. iLO automatically changes the state to Expired for such tasks. Supported format is yyyy-MM-dd HH:mm:ss. (For example 2018-06-27 19:23:14). Time must be given in 24 hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StartAfter</maml:name> <maml:description> <maml:para>The task start date and time. Supported format is yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 12:23:14)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatableBy</maml:name> <maml:description> <maml:para>This is an unordered set of permitted updaters that can execute the task from the installation queue.</maml:para> <maml:para>Supported values are: • Bmc: This component may be scheduled for update by iLO. • RuntimeAgent: This component may be scheduled for update by a runtime update agent such as Smart Update Manager or Smart Update Tool. • Uefi: This component may be scheduled for update by UEFI BIOS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTimeSeconds</maml:name> <maml:description> <maml:para>The number of seconds to pause.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ExecutionTimeoutMinutes</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> $update = ,@("Uefi","RuntimeAgent") PS C:\> ,$connection | Add-HPEiLOInstallationQueueWaitTask -TaskName WaitTime -UpdatableBy $update -WaitTimeSeconds 10</dev:code> <dev:remarks> <maml:para>This command adds the wait task in the installaton queue to the iLO 5 when a connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $update = ,@("Uefi","RuntimeAgent") PS C:\> Add-HPEiLOInstallationQueueWaitTask -Connection $connection -TaskName WaitTime -UpdatableBy $update -WaitTimeSeconds 10 -Expire "2017-03-01 02:43:01" -StartAfter "2017-01-01 02:43:01"</dev:code> <dev:remarks> <maml:para>This cmdlet adds the wait task to the installation queue on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOInstallationTaskQueue</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>Add-HPEiLOInstallSet</command:name> <maml:description> <maml:para>Adds a new install set.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEiLOInstallSet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEiLOInstallSet cmdlet adds a new install set to the iLO. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-HPEiLOInstallSet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the install set (client supplied upon creation).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the install set (client supplied upon creation).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsRecoverySet</maml:name> <maml:description> <maml:para>If set to Yes, this install set is reserved to hold only critical firmware recovery updatable by iLO. Additionally the 'Administrate Recovery Set' iLO privilege is required to modify or remove this install set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Command</maml:name> <maml:description> <maml:para>Command to execute. Supported values are "ApplyUpdate", "ResetServer", "ResetBmc", "Wait". ApplyUpdate : Apply an update using the specified component. ResetBmc : Reset the BMC. ResetServer : Reset the server. Wait : Wait for the WaitTimeSeconds number of seconds</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ApplyUpdate</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResetServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResetBmc</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wait</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para>The unique filename of the component. This correlates to 'Filename' in the HpeComponent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComponentName</maml:name> <maml:description> <maml:para>Name of the component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatableBy</maml:name> <maml:description> <maml:para>This is an unordered set of permitted updaters that can execute this item. Supported values are: Bmc: This component may be scheduled for an update by iLO. RuntimeAgent: This component may be scheduled for an update by a runtime update agent such as Smart Update Manager or Smart Update Tool. Uefi: This component may be scheduled for an update by UEFI BIOS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTimeSeconds</maml:name> <maml:description> <maml:para>The number of seconds to pause if the command is 'Wait'; ignored otherwise.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ExecutionTimeoutMinutes</maml:name> <maml:description> <maml:para>The number of minutes that this update will likely take to apply. Applies if the command is 'ApplyUpdate'. Ignored otherwise.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the install set (client supplied upon creation).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the install set (client supplied upon creation).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsRecoverySet</maml:name> <maml:description> <maml:para>If set to Yes, this install set is reserved to hold only critical firmware recovery updatable by iLO. Additionally the 'Administrate Recovery Set' iLO privilege is required to modify or remove this install set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Command</maml:name> <maml:description> <maml:para>Command to execute. Supported values are "ApplyUpdate", "ResetServer", "ResetBmc", "Wait". ApplyUpdate : Apply an update using the specified component. ResetBmc : Reset the BMC. ResetServer : Reset the server. Wait : Wait for the WaitTimeSeconds number of seconds</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ApplyUpdate</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResetServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResetBmc</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wait</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para>The unique filename of the component. This correlates to 'Filename' in the HpeComponent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComponentName</maml:name> <maml:description> <maml:para>Name of the component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatableBy</maml:name> <maml:description> <maml:para>This is an unordered set of permitted updaters that can execute this item. Supported values are: Bmc: This component may be scheduled for an update by iLO. RuntimeAgent: This component may be scheduled for an update by a runtime update agent such as Smart Update Manager or Smart Update Tool. Uefi: This component may be scheduled for an update by UEFI BIOS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitTimeSeconds</maml:name> <maml:description> <maml:para>The number of seconds to pause if the command is 'Wait'; ignored otherwise.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ExecutionTimeoutMinutes</maml:name> <maml:description> <maml:para>The number of minutes that this update will likely take to apply. Applies if the command is 'ApplyUpdate'. Ignored otherwise.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> [string[][]]$update = ,@("Bmc"),@("Uefi","RuntimeAgent") PS C:\> ,$connection | Add-HPEiLOInstallSet -Name TestInstallSet -Description NewInstallSet -IsRecoverySet Yes -Command ApplyUpdate,ApplyUpdate -Filename " ","cp031578.exe" -ComponentName Component1,Component2 -UpdatableBy $update -WaitTimeSeconds 10,0 -ExecutionTimeoutMinutes 15</dev:code> <dev:remarks> <maml:para>This command adds the install set to iLO 5 when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> PS C:\> [string[][]]$update = ,@("Bmc"),@("Uefi") PS C:\> ,$connection | Add-HPEiLOInstallSet -Name TestInstallSet -Description NewInstallSet -IsRecoverySet Yes -Command ResetServer,ApplyUpdate -Filename "ilo5_120.bin","cp031578.exe" -ComponentName Component1,Component2 -UpdatableBy $update</dev:code> <dev:remarks> <maml:para>This cmdlet adds the install set on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOInstallSet</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>Add-HPEiLOLanguagePack</command:name> <maml:description> <maml:para>Adds the language pack to the iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEiLOLanguagePack</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEiLOLanguagePack cmdlet adds the language pack to iLO.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-HPEiLOLanguagePack</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the full path of the firmware upgrade file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TPMEnabled</maml:name> <maml:description> <maml:para>If set to true, then the TPMOverrideFlag is passed in on the associated flash operations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UploadTimeout</maml:name> <maml:description> <maml:para>The timeout value for uploading the language pack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRepository</maml:name> <maml:description> <maml:para>If set to true, the language pack file is added to the iLO repository. This parameter is supported only on the iLO 5 server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the full path of the firmware upgrade file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TPMEnabled</maml:name> <maml:description> <maml:para>If set to true, then the TPMOverrideFlag is passed in on the associated flash operations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UploadTimeout</maml:name> <maml:description> <maml:para>The timeout value for uploading the language pack.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRepository</maml:name> <maml:description> <maml:para>If set to true, the language pack file is added to the iLO repository. This parameter is supported only on the iLO 5 server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.UInt32[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Add-HPEiLOLanguagePack -Location "C:\iLOFirmware\lang_ja_222.lpk" -UploadTimeout 300 -TPMEnabled</dev:code> <dev:remarks> <maml:para>This cmdlet adds the language pack to iLO 4 when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Add-HPEiLOLanguagePack -Location "C:\iLOFirmware\lang_ja_222.lpk" -UploadTimeout 300 -TPMEnabled -UpdateRepository</dev:code> <dev:remarks> <maml:para>This cmdlet adds the language pack to iLO 5 when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Add-HPEiLOLanguagePack -Connection $Connection -Location "C:\iLOFirmware\lang_ja_222.lpk" -UploadTimeout 300 -TPMEnabled</dev:code> <dev:remarks> <maml:para>This cmdlet adds the language pack on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOLanguage</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOLanguage</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOLanguagePack</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>Add-HPEiLOMaintenanceWindow</command:name> <maml:description> <maml:para>Adds the maintenance window.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEiLOMaintenanceWindow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEiLOMaintenanceWindow cmdlet adds the maintenance window. A maintenance window is a configured time period that applies to an installation task. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-HPEiLOMaintenanceWindow</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Expire</maml:name> <maml:description> <maml:para>The maintenance window end time (UTC). Supported format is of the form yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 19:23:14). Time must be given in 24-hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StartAfter</maml:name> <maml:description> <maml:para>The maintenance window start time (UTC). Supported format is of the form yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 19:23:14). Time must be given in 24-hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the user-defined name for the maintenance window. Accepts a string of length between 1 to 64.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the maintenance window. Accepts a string of length between 0 to 64.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Expire</maml:name> <maml:description> <maml:para>The maintenance window end time (UTC). Supported format is of the form yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 19:23:14). Time must be given in 24-hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StartAfter</maml:name> <maml:description> <maml:para>The maintenance window start time (UTC). Supported format is of the form yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 19:23:14). Time must be given in 24-hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the user-defined name for the maintenance window. Accepts a string of length between 1 to 64.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>A description of the maintenance window. Accepts a string of length between 0 to 64.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.DateTime[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>Maintenance windows are automatically deleted 24 hours after they expire.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Add-HPEiLOMaintenanceWindow -Expire "2018-09-29 03:15" -StartAfter "2018-09-28 19:00" -Name TestMaint -Description "test maintenance window"</dev:code> <dev:remarks> <maml:para>This cmdlet adds the maintenance window to iLO 5 when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> [DateTime]$startTime = Get-Date PS C:\> [DateTime]$endTime = (Get-Date).AddDays(2) PS C:\> ,$connection | Add-HPEiLOMaintenanceWindow -Expire $endTime -StartAfter $startTime -Name TestMaint -Description "test maintenance window"</dev:code> <dev:remarks> <maml:para>This cmdlet adds the maintenance window on iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOMaintenanceWindow</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>Add-HPEiLORepositoryComponent</command:name> <maml:description> <maml:para>Adds the repository component to the iLO repository</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEiLORepositoryComponent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEiLORepositoryComponent cmdlet adds the repository component to the iLO repository. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-HPEiLORepositoryComponent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the full path of the firmware upgrade file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CompSigLocation</maml:name> <maml:description> <maml:para>The signature file location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TPMEnabled</maml:name> <maml:description> <maml:para>If set to true, then the TPMOverrideFlag is passed in on the associated flash operations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateTarget</maml:name> <maml:description> <maml:para>If set to true, the component starts flashing immediately after uploading to the iLO repository.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRecoverySet</maml:name> <maml:description> <maml:para>If set to Yes, then the corresponding component is set as RecovertSet component. NOTE: The user must have SystemRecoverySet privilege in order to use the parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UploadTimeout</maml:name> <maml:description> <maml:para>The timeout value for uploading the repository component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the full path of the firmware upgrade file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CompSigLocation</maml:name> <maml:description> <maml:para>The signature file location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TPMEnabled</maml:name> <maml:description> <maml:para>If set to true, then the TPMOverrideFlag is passed in on the associated flash operations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateTarget</maml:name> <maml:description> <maml:para>If set to true, the component starts flashing immediately after uploading to the iLO repository.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRecoverySet</maml:name> <maml:description> <maml:para>If set to Yes, then the corresponding component is set as RecovertSet component. NOTE: The user must have SystemRecoverySet privilege in order to use the parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UploadTimeout</maml:name> <maml:description> <maml:para>The timeout value for uploading the repository component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.UInt32[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>File size greater than 32 MB can be added only via local file path.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Add-HPEiLORepositoryComponent -Location "C:\iLOFirmware\ilo4_255.bin" -UploadTimeout 700 -TPMEnabled -UpdateTarget</dev:code> <dev:remarks> <maml:para>This cmdlet adds the repository component to iLO 5 when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> $file = ,@("C:\iLO\iLOFirmwares\ComponentFile\3414\cp034141_part1.compsig","C:\iLO\iLOFirmwares\ComponentFile\3414\cp034141_part2.compsig","C:\iLO\iLOFirmwares\ComponentFile\3414\cp034141_part3.compsig","C:\iLO\iLOFirmwares\ComponentFile\3414\cp034141_part4.compsig") PS C:\> ,$connection | Add-HPEiLORepositoryComponent -Location "C:\iLO\iLOFirmwares\ComponentFile\3414\cp034141.exe" -CompSigLocation $file</dev:code> <dev:remarks> <maml:para>This cmdlet adds the repository component which is greater than 32 MB on iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Add-HPEiLORepositoryComponent -Connection $connection -Location "C:\iLOFirmware\cp033330.exe" -CompSigLocation "C:\iLOFirmware\cp033330.compsig" -UploadTimeout 700 -TPMEnabled</dev:code> <dev:remarks> <maml:para>This cmdlet adds the repository component on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLORepositoryComponent</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>Add-HPEiLOSNMPAlertDestination</command:name> <maml:description> <maml:para>Adds the respective iLO SNMP Alert Destination.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEiLOSNMPAlertDestination</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEiLOSNMPAlertDestination cmdlet adds the respective iLO SNMP Alert Destination. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-HPEiLOSNMPAlertDestination</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertDestination</maml:name> <maml:description> <maml:para>The IP address or FQDN of the remote management system that receive SNMP alerts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertProtocol</maml:name> <maml:description> <maml:para>Indicates the SNMP protocol associated with the AlertDestination. The supported values are SNMPv1trap, SNMPv3trap, and SNMPv3Inform.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SNMPv1Trap</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3Trap</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3Inform</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TrapCommunity</maml:name> <maml:description> <maml:para>The configured SNMPv1 trap community string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPv3User</maml:name> <maml:description> <maml:para>Provides the SNMPv3 security name associated with SNMPv3trap or SNMPv3Inform set on SNMPAlertProtocol.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertDestination</maml:name> <maml:description> <maml:para>The IP address or FQDN of the remote management system that receive SNMP alerts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertProtocol</maml:name> <maml:description> <maml:para>Indicates the SNMP protocol associated with the AlertDestination. The supported values are SNMPv1trap, SNMPv3trap, and SNMPv3Inform.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SNMPv1Trap</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3Trap</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3Inform</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TrapCommunity</maml:name> <maml:description> <maml:para>The configured SNMPv1 trap community string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPv3User</maml:name> <maml:description> <maml:para>Provides the SNMPv3 security name associated with SNMPv3trap or SNMPv3Inform set on SNMPAlertProtocol.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Add-HPEiLOSNMPAlertDestination -AlertDestination 1.1.1.1 -AlertProtocol SNMPv3trap -TrapCommunity 2.2.2.2 -SNMPv3User admin123</dev:code> <dev:remarks> <maml:para>This cmdlet adds the SNMP alert destination. The connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Add-HPEiLOSNMPAlertDestination -Connection $connection -AlertDestination 1.1.1.1 -AlertProtocol SNMPv1trap -TrapCommunity 2.2.2.2</dev:code> <dev:remarks> <maml:para>This cmdlet adds the SNMP alert destination to the iLO. The array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSNMPAlertDestination</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSNMPAlertDestination</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOSNMPAlertDestination</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>Add-HPEiLOSNMPv3User</command:name> <maml:description> <maml:para>Adds SNMPv3User in the iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEiLOSNMPv3User</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEiLOSNMPv3User cmdlet adds SNMPv3User in the iLO. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-HPEiLOSNMPv3User</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SecurityName</maml:name> <maml:description> <maml:para>SNMPv3 User associated with the destination when SNMP alert protocol is SNMPv3trap. The maximum allowable length is 32.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationProtocol</maml:name> <maml:description> <maml:para>Sets the message digest algorithm to use for encoding the authorization passphrase. The message digest is calculated over an appropriate portion of an SNMP message, and is included as a part of the message sent to the recipient. The supported values are MD5, SHA, and SHA256.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MD5</command:parameterValue> <command:parameterValue required="false" variableLength="false">SHA</command:parameterValue> <command:parameterValue required="false" variableLength="false">SHA256</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationPassphrase</maml:name> <maml:description> <maml:para>Sets the passphrase to use for sign operations. Enter a value between 8 and 49 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PrivacyProtocol</maml:name> <maml:description> <maml:para>Sets the encryption algorithm to use for encoding the privacy passphrase. A portion of an SNMP message is encrypted before transmission. The supported values are DES and AES.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DES</command:parameterValue> <command:parameterValue required="false" variableLength="false">AES</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PrivacyPassphrase</maml:name> <maml:description> <maml:para>Sets the passphrase to use for encrypt operations. Enter a value between 8 and 49 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserEngineID</maml:name> <maml:description> <maml:para>The UserEngineID is combined with the SecurityName to create an SNMPv3 user for each manager. It is only used for creating remote accounts used with INFORM messages. If this property is not set, then the INFORM message will be sent by default or by the iLO configured engine ID. This value must be a hexadecimal string with an even number of 10 to 64 characters, excluding the first two characters, 0x (for example, 0x01020304abcdef).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SecurityName</maml:name> <maml:description> <maml:para>SNMPv3 User associated with the destination when SNMP alert protocol is SNMPv3trap. The maximum allowable length is 32.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationProtocol</maml:name> <maml:description> <maml:para>Sets the message digest algorithm to use for encoding the authorization passphrase. The message digest is calculated over an appropriate portion of an SNMP message, and is included as a part of the message sent to the recipient. The supported values are MD5, SHA, and SHA256.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MD5</command:parameterValue> <command:parameterValue required="false" variableLength="false">SHA</command:parameterValue> <command:parameterValue required="false" variableLength="false">SHA256</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationPassphrase</maml:name> <maml:description> <maml:para>Sets the passphrase to use for sign operations. Enter a value between 8 and 49 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PrivacyProtocol</maml:name> <maml:description> <maml:para>Sets the encryption algorithm to use for encoding the privacy passphrase. A portion of an SNMP message is encrypted before transmission. The supported values are DES and AES.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DES</command:parameterValue> <command:parameterValue required="false" variableLength="false">AES</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PrivacyPassphrase</maml:name> <maml:description> <maml:para>Sets the passphrase to use for encrypt operations. Enter a value between 8 and 49 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserEngineID</maml:name> <maml:description> <maml:para>The UserEngineID is combined with the SecurityName to create an SNMPv3 user for each manager. It is only used for creating remote accounts used with INFORM messages. If this property is not set, then the INFORM message will be sent by default or by the iLO configured engine ID. This value must be a hexadecimal string with an even number of 10 to 64 characters, excluding the first two characters, 0x (for example, 0x01020304abcdef).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Add-HPEiLOSNMPv3User -SecurityName admin123 -AuthenticationProtocol MD5 -AuthenticationPassphrase abcde1234 -PrivacyProtocol AES -PrivacyPassphrase 123456adb -UserEngineID 0x01020304abcdef</dev:code> <dev:remarks> <maml:para>This cmdlet adds SNMPv3User. The connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Add-HPEiLOSNMPv3User -Connection $connection -SecurityName admin123 -AuthenticationProtocol SHA -AuthenticationPassphrase abcde1234 -PrivacyProtocol DES -PrivacyPassphrase 123456adb -UserEngineID 0x01020304abcdef</dev:code> <dev:remarks> <maml:para>This cmdlet adds SNMPv3User to the iLO. The array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSNMPv3User</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSNMPv3User</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOSNMPv3User</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>Add-HPEiLOSSORecord</command:name> <maml:description> <maml:para>Add a new HPE SIM Single Sign-On (SSO) Server Record.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEiLOSSORecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEiLOSSORecord cmdlet adds an HPE SIM Single Sign-On (SSO) server record to the end of the database on iLO. Duplicate records might be rejected and generate an error.</maml:para> <maml:para>There are three ways to add an HPE SIM Trusted Server record using the Add-HPEiLOSSOServer command:</maml:para> <maml:para>. ImportFromDNSName - The server can be specified by network name (requires SSO trust level set to trust by name or trust all, but is not supported for trust by certificate). Use the fully qualified network name.</maml:para> <maml:para>. ImportFromNetwork - The server certificate can be imported by iLO (the LOM processor requests the certificate from the specified HPE SIM server using anonymous HTTP request). The iLO processor must be able to contact the HPE SIM server on the network at the time This cmdlet is processed for this method to work.</maml:para> <maml:para>. DirectImportCertificate - The server certificate can be directly installed on iLO. However, you must obtain the x.509 certificate in advance. This method enables you to configure the iLO before placing it on the network with the HPE SIM server. The method also enables you to verify the contents of the HPE SIM server certificate.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-HPEiLOSSORecord</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSOInputType</maml:name> <maml:description> <maml:para>Specifies the method of adding an HPE SIM SSO server record by network Name, indirect import, or direct certificate import. The supported values are DirectImportCertificate, ImportFromNetwork, and ImportFromDNSName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DirectImportCertificate</command:parameterValue> <command:parameterValue required="false" variableLength="false">ImportFromNetwork</command:parameterValue> <command:parameterValue required="false" variableLength="false">ImportFromDNSName</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSOInputValue</maml:name> <maml:description> <maml:para>Specifies the server name in case of adding the SSO record by network name if SSOInputType is set as ImportFromNetwork. Specifies the certificate value if SSOType is set as DirectImportCertificate. Specifies the DNS name if SSOType is set as ImportFromDNSName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSOInputType</maml:name> <maml:description> <maml:para>Specifies the method of adding an HPE SIM SSO server record by network Name, indirect import, or direct certificate import. The supported values are DirectImportCertificate, ImportFromNetwork, and ImportFromDNSName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DirectImportCertificate</command:parameterValue> <command:parameterValue required="false" variableLength="false">ImportFromNetwork</command:parameterValue> <command:parameterValue required="false" variableLength="false">ImportFromDNSName</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSOInputValue</maml:name> <maml:description> <maml:para>Specifies the server name in case of adding the SSO record by network name if SSOInputType is set as ImportFromNetwork. Specifies the certificate value if SSOType is set as DirectImportCertificate. Specifies the DNS name if SSOType is set as ImportFromDNSName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Add-HPEiLOSSORecord -SSOInputType ImportFromNetwork -SSOInputValue "hp01.company.net"</dev:code> <dev:remarks> <maml:para>This cmdlet adds the SSO record to iLO from Network. The connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Add-HPEiLOSSORecord -SSOInputType ImportFromDNSName -SSOInputValue abcd.com</dev:code> <dev:remarks> <maml:para>This cmdlet adds the SSO record to iLO from DNSName of server. The connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $cert = @" -----BEGIN CERTIFICATE----- abcd1234certificate -----END CERTIFICATE----- "@ PS C:\> ,$connection | Add-HPEiLOSSORecord -SSOInputType DirectImportCertificate -SSOInputValue $cert</dev:code> <dev:remarks> <maml:para>This cmdlet adds the SSO record directly to the iLO. The connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Add-HPEiLOSSORecord -Connection $connection -SSOInputType ImportFromNetwork -SSOInputValue "hp01.company.net"</dev:code> <dev:remarks> <maml:para>This cmdlet adds a new SSO record to the iLO user accounts. The array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSSOSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSSOSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOSSORecord</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>Add-HPEiLOUser</command:name> <maml:description> <maml:para>Adds a local user account to the iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEiLOUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEiLOUser cmdlet adds a local user account. The newUsername and newUserLogin parameters must not have values that exist in the current user database. The user must have the Administer User Accounts privilege to add new users. This cmdlet has the following parameters:</maml:para> <maml:para>· Username</maml:para> <maml:para>· LoginName</maml:para> <maml:para>· Password</maml:para> <maml:para>. UserConfigPrivilege</maml:para> <maml:para>. RemoteConsolePrivilege</maml:para> <maml:para>. VirtualMediaPrivilege</maml:para> <maml:para>. iLOConfigPrivilege</maml:para> <maml:para>. VirtualPowerAndResetPrivilege</maml:para> <maml:para>. LoginPrivilege (available only on Gen10 servers)</maml:para> <maml:para>. HostBIOSConfigPrivilege (available only on Gen10 servers)</maml:para> <maml:para>. HostNICConfigPrivilege (available only on Gen10 servers)</maml:para> <maml:para>. HostStorageConfigPrivilege (available only on Gen10 servers)</maml:para> <maml:para>. SystemRecoveryConfigPrivilege (available only on Gen10 servers)</maml:para> <maml:para>. ServiceAccount (available only on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-HPEiLOUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to add, edit, and delete local management processor user accounts. A user with this privilege can change privileges for all users. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure Host BIOS Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a Boolean parameter that enables a user to configure the Host NIC Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a Boolean parameter that enables a user to configure the Host Storage Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ConfigiLOPriv"> <maml:name>iLOConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure iLO Settings. The supported values are Yes and No. Aliases : ConfigiLOPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginPrivilege</maml:name> <maml:description> <maml:para>Specifies a Boolean parameter that enables a user to log in to the management processor. All local accounts have the login privilege. This privilege is added automatically if it is not specified. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Yes</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username specifies the new username to be added. This parameter can be a combination of any printable characters up to a maximum length of 39 characters. This parameter is not case sensitive and must not be blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>LoginName is the new modified loginname used to gain access to the respective iLO. This parameter is not case sensitive and must not be left blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>UserLogin is the new modified userlogin used to gain access to the respective iLO. This parameter is not case sensitive and must not be left blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoteConsPriv"> <maml:name>RemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to remotely access the host system Remote Console, including video, keyboard, and mouse control. The supported values are Yes and No. Aliases : RemoteConsPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure SystemRecovery Configuration Privilege. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that gives the user permission to access the virtual media functionality. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ResetServerPriv"> <maml:name>VirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables enables a user to power-cycle or reset the host system. These activities interrupt system availability. A user with this privilege can diagnose the system by using the Generate NMI to System button. The supported values are Yes and No. Aliases : ResetServerPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>Indicates that the account type is a service account. Supported values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to add, edit, and delete local management processor user accounts. A user with this privilege can change privileges for all users. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure Host BIOS Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a Boolean parameter that enables a user to configure the Host NIC Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a Boolean parameter that enables a user to configure the Host Storage Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ConfigiLOPriv"> <maml:name>iLOConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure iLO Settings. The supported values are Yes and No. Aliases : ConfigiLOPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginPrivilege</maml:name> <maml:description> <maml:para>Specifies a Boolean parameter that enables a user to log in to the management processor. All local accounts have the login privilege. This privilege is added automatically if it is not specified. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Yes</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username specifies the new username to be added. This parameter can be a combination of any printable characters up to a maximum length of 39 characters. This parameter is not case sensitive and must not be blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>LoginName is the new modified loginname used to gain access to the respective iLO. This parameter is not case sensitive and must not be left blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>UserLogin is the new modified userlogin used to gain access to the respective iLO. This parameter is not case sensitive and must not be left blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoteConsPriv"> <maml:name>RemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to remotely access the host system Remote Console, including video, keyboard, and mouse control. The supported values are Yes and No. Aliases : RemoteConsPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure SystemRecovery Configuration Privilege. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that gives the user permission to access the virtual media functionality. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ResetServerPriv"> <maml:name>VirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables enables a user to power-cycle or reset the host system. These activities interrupt system availability. A user with this privilege can diagnose the system by using the Generate NMI to System button. The supported values are Yes and No. Aliases : ResetServerPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ServiceAccount</maml:name> <maml:description> <maml:para>Indicates that the account type is a service account. Supported values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Add-HPEiLOUser -Username testuser1 -Password testuser123 -LoginName testuser1 -UserConfigPrivilege Yes -iLOConfigPrivilege No -RemoteConsolePrivilege Yes -VirtualMediaPrivilege No -VirtualPowerAndResetPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet adds a new user to iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.3 -Username admin -Password admin123 PS C:\> ,$connection | Add-HPEiLOUser -Username testuser2 -Password testuser123 -LoginName testuser2 -UserConfigPrivilege Yes -iLOConfigPrivilege No -RemoteConsolePrivilege Yes -VirtualMediaPrivilege No -VirtualPowerAndResetPrivilege Yes -HostBIOSConfigPrivilege Yes -HostNICConfigPrivilege Yes -HostStorageConfigPrivilege Yes -LoginPrivilege Yes -SystemRecoveryConfigPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet adds a new user to iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Add-HPEiLOUser -Connection $connection -Username testuser1 -Password testuser123 -LoginName testuser1 -UserConfigPrivilege Yes -iLOConfigPrivilege No -RemoteConsolePrivilege Yes -VirtualMediaPrivilege No -VirtualPowerAndResetPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet adds a new user to iLO 4 and iLO 5 along with various Privileges and an array of connection objects passed as named paramter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOUser</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>Backup-HPEiLOSetting</command:name> <maml:description> <maml:para>Backs up current iLO setting in a .bak file.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Backup</command:verb> <command:noun>HPEiLOSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The cmdlet backs up current iLO setting in a .bak file. This cmdlet is supported only on iLO 5 servers.</maml:para> <maml:para>NOTE: As with any computer system, backing up your data is a recommended practice to minimize the impact from failures. Hewlett Packard Enterprise recommends performing a backup each time before you update the iLO firmware.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="LocalLocation" default="true"> <!--NAME: LocalLocation--> <!--TAG: DEFAULT--> <maml:name>Backup-HPEiLOSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>BackupFileLocation</maml:name> <maml:description> <maml:para>The file location where backup file gets created. The supported file extension is .bak. For example - C:\Users\admin\testBackupFile.bak</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BackupFilePassword</maml:name> <maml:description> <maml:para>BackupFilePassword to add to the file while creating the backup file. BackupFilePassword cannot be null or empty string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this parameter will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="NANDLocation"> <!--NAME: NANDLocation--> <maml:name>Backup-HPEiLOSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupOnNAND</maml:name> <maml:description> <maml:para>This parameter does the backup of iLO settings on NAND.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this parameter will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>BackupFileLocation</maml:name> <maml:description> <maml:para>The file location where backup file gets created. The supported file extension is .bak. For example - C:\Users\admin\testBackupFile.bak</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BackupFilePassword</maml:name> <maml:description> <maml:para>BackupFilePassword to add to the file while creating the backup file. BackupFilePassword cannot be null or empty string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this parameter will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupOnNAND</maml:name> <maml:description> <maml:para>This parameter does the backup of iLO settings on NAND.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The user must have administrative rights to create the file specified in the BackupFileLocation parameter.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Backup-HPEiLOSetting -BackupFileLocation C:\Users\admin\test.bak -BackupFilePassword backup@1234</dev:code> <dev:remarks> <maml:para>The cmdlet shows the output on iLO 5 with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Backup-HPEiLOSetting -BackupOnNAND</dev:code> <dev:remarks> <maml:para>The cmdlet shows the output on iLO 5 with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Backup-HPEiLOSetting -Connection $connection -BackupFileLocation C:\Users\admin\test.bak</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restore-HPEiLOSetting</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>Clear-HPEiLOAHSData</command:name> <maml:description> <maml:para>Clears the Active Health System Log.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLOAHSData</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEiLOAHSData cmdlet deletes the entire Active Health System Log. You must enable the Configure iLO Settings privilege to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLOAHSData</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.ReturnStatus</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOAHSData | fl IP : 10.20.30.1 Hostname : xyz.example.com Status : INFORMATION StatusInfo : HPE.iLO.Response.StatusInfo</dev:code> <dev:remarks> <maml:para>This cmdlet clears the AHS log on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> Clear-HPEiLOAHSData -Connection $connection | fl IP : 10.20.30.2 Hostname : xyz.example.com Status : INFORMATION StatusInfo : HPE.iLO.Response.StatusInfo</dev:code> <dev:remarks> <maml:para>This cmdlet clears the AHS log on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOAHSData | fl IP : 10.20.30.1 Hostname : xyz.example.com Status : INFORMATION StatusInfo : HPE.iLO.Response.StatusInfo IP : 10.20.30.2 Hostname : xyz.example.com Status : INFORMATION StatusInfo : HPE.iLO.Response.StatusInfo</dev:code> <dev:remarks> <maml:para>This cmdlet clears the AHS log on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Clear-HPEiLOESKMLog</command:name> <maml:description> <maml:para>Clears the ESKM log.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLOESKMLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEiLOESKMLog clears the Enterprise Secure Key Manager(ESKM) log. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLOESKMLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOESKMLog</dev:code> <dev:remarks> <maml:para>This cmdlet clears ESKM logs on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Clear-HPEiLOESKMLog -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet clears ESKM logs on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Clear-HPEiLOEventLog</command:name> <maml:description> <maml:para>Clears the iLO event logs.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLOEventLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEiLOEventLog cmdlet clears the iLO event logs. You must enable the Configure iLO Settings privilege to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLOEventLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOEventLog</dev:code> <dev:remarks> <maml:para>This cmdlet clears Event logs on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOEventLog</dev:code> <dev:remarks> <maml:para>This cmdlet clears Event logs on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOEventLog</dev:code> <dev:remarks> <maml:para>This cmdlet clears Event logs on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOEventLog</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>Clear-HPEiLOHotKeyConfig</command:name> <maml:description> <maml:para>Clears the Hot Key configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLOHotKeyConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Clears the Hot Key configuration on the specified server. Only works on iLO 5.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLOHotKeyConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\Windows\system32>$con = Connect-HPEiLO 10.20.30.1 admin admin123 -DisableCertificateAuthentication PS C:\Windows\system32>$con | Clear-HPEiLOHotKeyConfig -Confirm:$false</dev:code> <dev:remarks> <maml:para>This cmdlet clears hot key configuration on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Set-HPEiLOHotKeyConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOHotKeyConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</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>Clear-HPEiLOIML</command:name> <maml:description> <maml:para>Clears the Integrated Management Logs.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLOIML</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Clear-HPEiLOIML cmdlet clears the Integrated Management Logs. You must enable the Configure iLO Settings privilege to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLOIML</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOIML</dev:code> <dev:remarks> <maml:para>This cmdlet clears the Integrated Management Logs on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOIML</dev:code> <dev:remarks> <maml:para>This cmdlet clears the Integrated Management Logs on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOIML</dev:code> <dev:remarks> <maml:para>This cmdlet clears the Integrated Management Logs on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOIML</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>Clear-HPEiLOInstallationTaskQueue</command:name> <maml:description> <maml:para>Clears the installation queue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLOInstallationTaskQueue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEiLOInstallationTaskQueue cmdlet cLears the installation queue. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLOInstallationTaskQueue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOInstallationTaskQueue</dev:code> <dev:remarks> <maml:para>This cmdlet clears the Installation task queue on iLO 5 with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Clear-HPEiLOInstallationTaskQueue -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet clears the Installation task queue on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOInstallationTaskQueue</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>Clear-HPEiLOInstallSet</command:name> <maml:description> <maml:para>Clears the Install set.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLOInstallSet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEiLOInstallSet cmdlet clears the Install set. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLOInstallSet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeRecoverySet</maml:name> <maml:description> <maml:para>The parameter gets the confirmation to clear the recovery set present in install set. Supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeRecoverySet</maml:name> <maml:description> <maml:para>The parameter gets the confirmation to clear the recovery set present in install set. Supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOInstallSet</dev:code> <dev:remarks> <maml:para>This cmdlet clears the Install set on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Clear-HPEiLOInstallSet -IncludeRecoverySet No -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet clears the Installation task queue on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOInstallSet</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>Clear-HPEiLOLog</command:name> <maml:description> <maml:para>Clears all the logs created by the HPE iLO module.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLOLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet gives you the choice to clear either one or multiple logs using the –Last parameter. If you do not use any parameter, then it will clear all the existing logs including the current log (confirmation is asked before clearing all the logs).</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLOLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Last</maml:name> <maml:description> <maml:para>It takes integer as value. If X value is specified, then X number of logs in the descending order of their age or the older logs will be cleared.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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"> <maml:name>Last</maml:name> <maml:description> <maml:para>It takes integer as value. If X value is specified, then X number of logs in the descending order of their age or the older logs will be cleared.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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: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> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>C:\PS> Clear-HPEiLOLog</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Disable-HPEiLOLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEiLOLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</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>Clear-HPEiLOMaintenanceWindow</command:name> <maml:description> <maml:para>Clears the maintenance window.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLOMaintenanceWindow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet clears the maintenance window. A maintenance window is a configured time period that applies to an installation task. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLOMaintenanceWindow</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$con = Connect-HPEiLO 192.168.10.34 admin admin123 -DisableCertificateAuthentication $con | Clear-HPEiLOMaintenanceWindow</dev:code> <dev:remarks> <maml:para>Clears all maintenance window entries on iLO 5.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOMaintenanceWindow</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>Clear-HPEiLOPowerOnTime</command:name> <maml:description> <maml:para>Clears the virtual clock counter without power-cycling the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLOPowerOnTime</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEiLOPowerOnTime cmdlet clears the virtual clock counter without power-cycling the server. This cmdlet is supported only on iLO 4 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLOPowerOnTime</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOPowerOnTime</dev:code> <dev:remarks> <maml:para>This cmdlet clears the Power on time on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOPowerOnTime</dev:code> <dev:remarks> <maml:para>This cmdlet clears the Power on time on iLO 4 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOPowerOnTime</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>Clear-HPEiLORemoteSupportServiceEventLog</command:name> <maml:description> <maml:para>Clears Service Event log entries from a remote support configured iLO 5 server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLORemoteSupportServiceEventLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Clears all Service Event log entries from a remote support configured iLO 5 server. This will clear log entries only if remote support is configured on the target iLO 5 server.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLORemoteSupportServiceEventLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$con = Connect-HPEiLO 192.168.10.34 admin admin123 -DisableCertificateAuthentication $con | Clear-HPEiLORemoteSupportServiceEventLog</dev:code> <dev:remarks> <maml:para>Clears all Service Event log entries from the iLO 5 target server.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLORemoteSupportServiceEventLog</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>Clear-HPEiLORestAPIState</command:name> <maml:description> <maml:para>Clears the persistent state of the REST API.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLORestAPIState</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEiLORestAPIState clears the persistent state of the REST API. Some portions of the API may not be available until after the server reboots. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLORestAPIState</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLORestAPIState</dev:code> <dev:remarks> <maml:para>This cmdlet clears the RestAPIState on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Clear-HPEiLORestAPIState -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet clears the RestAPIState on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLORestAPIState</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>Clear-HPEiLOSecurityLog</command:name> <maml:description> <maml:para>Clears the iLO Security logs.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLOSecurityLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEiLOSecurityLog cmdlet clears the Security Logs. You must enable the Configure iLO Settings privilege to execute this cmdlet. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLOSecurityLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOSecurityLog</dev:code> <dev:remarks> <maml:para>This cmdlet clears the Security Logs on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOSecurityLog</dev:code> <dev:remarks> <maml:para>This cmdlet clears the Security Logs on iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSecurityLog</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>Clear-HPEiLOSSORecord</command:name> <maml:description> <maml:para>Clears all the SSO Record.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLOSSORecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEiLOSSORecord cmdlet clears all the SSO Record. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLOSSORecord</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOSSORecord</dev:code> <dev:remarks> <maml:para>This cmdlet clears the SSO record on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOSSORecord</dev:code> <dev:remarks> <maml:para>This cmdlet clears the SSO record on iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOSSORecord</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOSSORecord</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>Clear-HPEiLOUnlockedRepositoryComponent</command:name> <maml:description> <maml:para>Clears all the unlocked repository components.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEiLOUnlockedRepositoryComponent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEiLOUnlockedRepositoryComponent cmdlet clears all the unlocked repository components. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEiLOUnlockedRepositoryComponent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Clear-HPEiLOUnlockedRepositoryComponent</dev:code> <dev:remarks> <maml:para>This cmdlet clears the repository component on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Clear-HPEiLOUnlockedRepositoryComponent -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet clears the repository component on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLORepositoryComponent</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>Connect-HPEiLO</command:name> <maml:description> <maml:para>The Connect-HPEiLO cmdlet creates connection to one or multiple iLO targets.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>HPEiLO</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Connect-HPEiLO cmdlet creates connection to one or multiple iLO targets represented by its iLO IP. This cmdlet has the following parameters: • IP - Holds the target iLO IP. • Username - Holds the target iLO username. • Password - Holds the target iLO password. • Credential - Holds the target iLO Credential in a secure manner. • Timeout - Holds the HTTPS protocol time out. • DisableCerificateAuthentication - Using this bypasses the server certificate authentication. • iLOResetWaitTimeout - Holds the iLOResetWaitTime.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet" default="true"> <!--NAME: UsernamePasswordSet--> <!--TAG: DEFAULT--> <maml:name>Connect-HPEiLO</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="IP , HostName , iLO , Server"> <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies iLO IP/Hostname to create a connection. IP can be either IPv4 address or IPv6 address. The port number must be appended with the input IP address in case of a change in the HTTPS port number in iLO settings. Aliases: IP, HostName, Server, iLO ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be given as input along with Password. Username cannot be null or empty string. ParameterSetName: UsernamePasswordSet Aliases: LoginName</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to given along with Username. Password cannot be null or an empty string. ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifes the HTTPS protocol time out. The value is specified in seconds. Default value is 30. The parameter accepts values in the range 1 through 1800. ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BIOSAdminPassword</maml:name> <maml:description> <maml:para>Specifies the BIOS administrator password on Gen9 servers. When the password is set using Set-HPEBIOSAdminPassword or manually in the RBSU menu, you must provide the admin password. This is applicable if the connection object is used to change BIOS configuration using the BIOS cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLOResetWaitTimeout</maml:name> <maml:description> <maml:para>Maximum time in seconds till the cmdlet waits for iLO to return back after iLO reset. Default value is 0. The parameter accepts values is in the range 0 through 300.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DisableCertificateAuthentication</maml:name> <maml:description> <maml:para>If the DisableCertificateAuthentication switch parameter is present, the server certificate authentication is disabled while establishing the target connection. If this parameter is not present, it will execute according to the global certificate authentication setting. The default behavior is to authenticate server certificate. ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this parameter will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Connect-HPEiLO</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="IP , HostName , iLO , Server"> <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies iLO IP/Hostname to create a connection. IP can be either IPv4 address or IPv6 address. The port number must be appended with the input IP address in case of a change in the HTTPS port number in iLO settings. Aliases: IP, HostName, Server, iLO ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifes the HTTPS protocol time out. The value is specified in seconds. Default value is 30. The parameter accepts values in the range 1 through 1800. ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BIOSAdminPassword</maml:name> <maml:description> <maml:para>Specifies the BIOS administrator password on Gen9 servers. When the password is set using Set-HPEBIOSAdminPassword or manually in the RBSU menu, you must provide the admin password. This is applicable if the connection object is used to change BIOS configuration using the BIOS cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLOResetWaitTimeout</maml:name> <maml:description> <maml:para>Maximum time in seconds till the cmdlet waits for iLO to return back after iLO reset. Default value is 0. The parameter accepts values is in the range 0 through 300.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DisableCertificateAuthentication</maml:name> <maml:description> <maml:para>If the DisableCertificateAuthentication switch parameter is present, the server certificate authentication is disabled while establishing the target connection. If this parameter is not present, it will execute according to the global certificate authentication setting. The default behavior is to authenticate server certificate. ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this parameter will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="XAuthTokenSet"> <!--NAME: XAuthTokenSet--> <maml:name>Connect-HPEiLO</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="IP , HostName , iLO , Server"> <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies iLO IP/Hostname to create a connection. IP can be either IPv4 address or IPv6 address. The port number must be appended with the input IP address in case of a change in the HTTPS port number in iLO settings. Aliases: IP, HostName, Server, iLO ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>XAuthToken</maml:name> <maml:description> <maml:para>This parameter specifies the session key generated for the iLO via One View or through Redfish API. It allows the user to create the connection object which can be used later to configure the iLO. This parameter is supported on iLO5 only. ParameterSetName: XAuthTokenSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifes the HTTPS protocol time out. The value is specified in seconds. Default value is 30. The parameter accepts values in the range 1 through 1800. ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BIOSAdminPassword</maml:name> <maml:description> <maml:para>Specifies the BIOS administrator password on Gen9 servers. When the password is set using Set-HPEBIOSAdminPassword or manually in the RBSU menu, you must provide the admin password. This is applicable if the connection object is used to change BIOS configuration using the BIOS cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLOResetWaitTimeout</maml:name> <maml:description> <maml:para>Maximum time in seconds till the cmdlet waits for iLO to return back after iLO reset. Default value is 0. The parameter accepts values is in the range 0 through 300.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DisableCertificateAuthentication</maml:name> <maml:description> <maml:para>If the DisableCertificateAuthentication switch parameter is present, the server certificate authentication is disabled while establishing the target connection. If this parameter is not present, it will execute according to the global certificate authentication setting. The default behavior is to authenticate server certificate. ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this parameter will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="IP , HostName , iLO , Server"> <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies iLO IP/Hostname to create a connection. IP can be either IPv4 address or IPv6 address. The port number must be appended with the input IP address in case of a change in the HTTPS port number in iLO settings. Aliases: IP, HostName, Server, iLO ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to log onto the target iLO. Username needs to be given as input along with Password. Username cannot be null or empty string. ParameterSetName: UsernamePasswordSet Aliases: LoginName</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password to log onto the target iLO. Password needs to given along with Username. Password cannot be null or an empty string. ParameterSetName: UsernamePasswordSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Specifes the HTTPS protocol time out. The value is specified in seconds. Default value is 30. The parameter accepts values in the range 1 through 1800. ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BIOSAdminPassword</maml:name> <maml:description> <maml:para>Specifies the BIOS administrator password on Gen9 servers. When the password is set using Set-HPEBIOSAdminPassword or manually in the RBSU menu, you must provide the admin password. This is applicable if the connection object is used to change BIOS configuration using the BIOS cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLOResetWaitTimeout</maml:name> <maml:description> <maml:para>Maximum time in seconds till the cmdlet waits for iLO to return back after iLO reset. Default value is 0. The parameter accepts values is in the range 0 through 300.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DisableCertificateAuthentication</maml:name> <maml:description> <maml:para>If the DisableCertificateAuthentication switch parameter is present, the server certificate authentication is disabled while establishing the target connection. If this parameter is not present, it will execute according to the global certificate authentication setting. The default behavior is to authenticate server certificate. ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this parameter will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Holds the target iLO Credential in a secure manner. ParameterSetName: CredentialSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>XAuthToken</maml:name> <maml:description> <maml:para>This parameter specifies the session key generated for the iLO via One View or through Redfish API. It allows the user to create the connection object which can be used later to configure the iLO. This parameter is supported on iLO5 only. ParameterSetName: XAuthTokenSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[] System.Management.Automation.PSCredential[] System.UInt32[]</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>If the cmdlet executes successfully it returns System.Management.Automation.PSObject or System.Management.Automation.PSObject[] object. In case of error or warning, the corresponding error message is displayed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>• Hostname property of cmdlet output will always show DNS hostname if it gets resolved, otherwise it will be empty.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Connection using UsernamePasswordSet PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.40 -Username username -Password password PS C:\> $connection IP : 10.20.30.40 Hostname : abc.com Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant SL270s Gen8 SE; ServerFamily=ProLiant; ServerGeneration=Gen8; ServerModel=SL250s; iLOGeneration=iLO4; iLOFirmwareVersion=2.70; SystemROM=P75 05/21/2018; ProcessorName= Intel(R) Xeon(R) CPU E5-2630 v2 @ 2.60GHz } ExtendedInfo : @{UserSuppliedAddress=10.20.30.40; HttpConnectAddress=abc.com; UserName=admin; Modifier1=6t/R7/o+T83f6IXAXEwnGzHQYmdmdo/tqvaZqDX4pvk=; Modifier2=NoDkPZXxrwxrOL2tByM4iQ==} ConnectionInfo : @{RIBCL=} PS C:\> $connection.TargetInfo ProductName : ProLiant SL270s Gen8 SE ServerFamily : ProLiant ServerGeneration : Gen8 ServerModel : SL250s iLOGeneration : iLO4 iLOFirmwareVersion : 2.70 SystemROM : P75 05/21/2018 ProcessorName :Intel(R) Xeon(R) CPU E5-2630 v2 @ 2.60GHz PS C:\> $connection.ExtendedInfo UserSuppliedAddress : 10.20.30.40 HttpConnectAddress : abc.com UserName : admin Modifier1 : 6t/R7/o+T83f6IXAXEwnGzHQYmdmdo/tqvaZqDX4pvk= Modifier2 : NoDkPZXxrwxrOL2tByM4iQ== PS C:\> $connection.ConnectionInfo.RIBCL | fl AuthToken : Kx9pcRKgwEp1DfyyQbYpJA== iLOResetWaitTimeout : 0</dev:code> <dev:remarks> <maml:para>This example shows the output of the Connect-HPEiLO cmdlet with UsernamePasswordSet input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Connection using CredentialSet C:\PS> $Credential = Get-Credential; C:\PS> $connection = Connect-HPEiLO -IP 10.20.30.30 -Credential $Credential -iLOResetWaitTimeout 100 PS C:\> $connection IP : 10.20.30.30 Hostname : genpos2.com Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant XL250a Gen9; ServerFamily=ProLiant; ServerGeneration=Gen9; ServerModel=XL250a; iLOGeneration=iLO4; iLOFirmwareVersion=2.62; SystemROM=U13 v2.70 (12/15/2018); ProcessorName=Intel(R) Xeon(R) CPU E5-2609 v3 @ 1.90GHz} ExtendedInfo : @{UserSuppliedAddress=10.20.30.30; HttpConnectAddress=genpos2.com; UserName=admin; Modifier1=ExdHcZJ4bHdt7Ri4gL1jfLq/x4javFCzaljrg7QDxTc=; Modifier2=sLktxnOYtnOcdqJUfxI4zg==} ConnectionInfo : @{RIBCL=; REST=} PS C:\> $connection ProductName : ProLiant XL250a Gen9 ServerFamily : ProLiant ServerGeneration : Gen9 ServerModel : XL250a iLOGeneration : iLO4 iLOFirmwareVersion : 2.62 SystemROM : U13 v2.70 (12/15/2018) ProcessorName : Intel(R) Xeon(R) CPU E5-2609 v3 @ 1.90GHz PS C:\> $connection.ExtendedInfo UserSuppliedAddress : 10.20.30.30 HttpConnectAddress : genpos2.com UserName : admin Modifier1 : ExdHcZJ4bHdt7Ri4gL1jfLq/x4javFCzaljrg7QDxTc= Modifier2 : sLktxnOYtnOcdqJUfxI4zg== PS C:\Windows\system32> $connection.ConnectionInfo | fl RIBCL : @{AuthToken=E+hg+oOqKCaBu64ZRAHpIQ==; iLOResetWaitTimeout=0} REST : @{RootUrl=https://10.20.30.30/rest/v1; XAuthToken=xScMxn6ls7Cdho5TzLk0/KMKBZ/6TdqahZE3bn6UetVoyICl2x/6GlwsgBC5ClGV; Location=https://10.20.30.30/rest/v1/SessionService/Sessions/admin5dc455d1672b020d; BIOSAdminPassword=; BIOSAttributeRegistryName=HpBiosAttributeRegistryU13.1.1.70}</dev:code> <dev:remarks> <maml:para>This example shows the output of the Connect-HPEiLO cmdlet on Gen9 server with iLO IP and credential.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Connection with positional input C:\PS> $connection = Connect-HPEiLO 10.20.30.40 username password PS C:\> $connection IP : 10.20.30.40 Hostname : abc.com Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant SL270s Gen8 SE; ServerFamily=ProLiant; ServerGeneration=Gen8; ServerModel=SL250s; iLOGeneration=iLO4; iLOFirmwareVersion=2.70; SystemROM=P75 05/21/2018; ProcessorName= Intel(R) Xeon(R) CPU E5-2630 v2 @ 2.60GHz } ExtendedInfo : @{UserSuppliedAddress=10.20.30.40; HttpConnectAddress=abc.com; UserName=admin; Modifier1=6t/R7/o+T83f6IXAXEwnGzHQYmdmdo/tqvaZqDX4pvk=; Modifier2=NoDkPZXxrwxrOL2tByM4iQ==} ConnectionInfo : @{RIBCL=} PS C:\> $connection.TargetInfo ProductName : ProLiant SL270s Gen8 SE ServerFamily : ProLiant ServerGeneration : Gen8 ServerModel : SL250s iLOGeneration : iLO4 iLOFirmwareVersion : 2.70 SystemROM : P75 05/21/2018 ProcessorName :Intel(R) Xeon(R) CPU E5-2630 v2 @ 2.60GHz PS C:\> $connection.ExtendedInfo UserSuppliedAddress : 10.20.30.40 HttpConnectAddress : abc.com UserName : admin Modifier1 : 6t/R7/o+T83f6IXAXEwnGzHQYmdmdo/tqvaZqDX4pvk= Modifier2 : NoDkPZXxrwxrOL2tByM4iQ== PS C:\> $connection.ConnectionInfo.RIBCL | fl AuthToken : Kx9pcRKgwEp1DfyyQbYpJA== iLOResetWaitTimeout : 0</dev:code> <dev:remarks> <maml:para>This example shows the output of the Connect-HPEiLO cmdlet using iLO IP, Username, and Password passed as positional input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $pipelineInput = New-Object psobject PS C:\> $pipelineInput | Add-Member IP 10.20.30.40 PS C:\> $pipelineInput | Add-Member Username username PS C:\> $pipelineInput | Add-Member Password password PS C:\> $connection = $pipelineInput | Connect-HPEiLO PS C:\> $connection IP : 10.20.30.40 Hostname : abc.com Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant SL270s Gen8 SE; ServerFamily=ProLiant; ServerGeneration=Gen8; ServerModel=SL250s; iLOGeneration=iLO4; iLOFirmwareVersion=2.70; SystemROM=P75 05/21/2018; ProcessorName= Intel(R) Xeon(R) CPU E5-2630 v2 @ 2.60GHz } ExtendedInfo : @{UserSuppliedAddress=10.20.30.40; HttpConnectAddress=abc.com; UserName=admin; Modifier1=6t/R7/o+T83f6IXAXEwnGzHQYmdmdo/tqvaZqDX4pvk=; Modifier2=NoDkPZXxrwxrOL2tByM4iQ==} ConnectionInfo : @{RIBCL=} PS C:\> $connection.TargetInfo ProductName : ProLiant SL270s Gen8 SE ServerFamily : ProLiant ServerGeneration : Gen8 ServerModel : SL250s iLOGeneration : iLO4 iLOFirmwareVersion : 2.70 SystemROM : P75 05/21/2018 ProcessorName :Intel(R) Xeon(R) CPU E5-2630 v2 @ 2.60GHz PS C:\> $connection.ExtendedInfo UserSuppliedAddress : 10.20.30.40 HttpConnectAddress : abc.com UserName : admin Modifier1 : 6t/R7/o+T83f6IXAXEwnGzHQYmdmdo/tqvaZqDX4pvk= Modifier2 : NoDkPZXxrwxrOL2tByM4iQ== PS C:\> $connection.ConnectionInfo.RIBCL | fl AuthToken : Kx9pcRKgwEp1DfyyQbYpJA== iLOResetWaitTimeout : 0</dev:code> <dev:remarks> <maml:para>This example shows the output of the Connect-HPEiLO cmdlet with iLO IP, Username, and Password as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 5</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO cmdlet Connect-HPEiLO at command pipeline position 1 Supply values for the following parameters: IP[0]: 10.20.30.1 IP[1]: 10.20.30.2 IP[2]: 10.20.30.3 IP[3]: Username[0]: username Username[1]: username Username[2]: username Username[3]: Password[0]: password Password[1]: password Password[2]: password Password[3]: PS C:\> $connection.Count 3 PS C:\> $connection IP : 10.20.30.1 Hostname : gen8pos.com Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant SL270s Gen8 SE; ServerFamily=ProLiant; ServerGeneration=Gen8; ServerModel=SL250s; iLOGeneration=iLO4; iLOFirmwareVersion=2.62; SystemROM=P75 05/21/2018; ProcessorName= Intel(R) Xeon(R) CPU E5-2630 v2 @ 2.60GHz } ExtendedInfo : @{UserSuppliedAddress=10.20.30.1; HttpConnectAddress=gen8pos.com; UserName=admin; Modifier1=6t/R7/o+T83f6IXAXEwnGzHQYmdmdo/tqvaZqDX4pvk=; Modifier2=NoDkPZXxrwxrOL2tByM4iQ==} ConnectionInfo : @{RIBCL=} IP : 10.20.30.2 Hostname : gen9pos.com Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant XL250a Gen9; ServerFamily=ProLiant; ServerGeneration=Gen9; ServerModel=XL250a; iLOGeneration=iLO4; iLOFirmwareVersion=2.62; SystemROM=U13 v2.70 (12/15/2018); ProcessorName=Intel(R) Xeon(R) CPU E5-2609 v3 @ 1.90GHz} ExtendedInfo : @{UserSuppliedAddress=10.20.30.2; HttpConnectAddress=gen9pos.com; UserName=admin; Modifier1=ExdHcZJ4bHdt7Ri4gL1jfLq/x4javFCzaljrg7QDxTc=; Modifier2=sLktxnOYtnOcdqJUfxI4zg==} ConnectionInfo : @{RIBCL=; REST=} IP : 10.20.30.3 Hostname : gen10pos.com Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant ML110 Gen10; ServerFamily=ProLiant; ServerGeneration=Gen10; ServerModel=ML110; iLOGeneration=iLO5; iLOFirmwareVersion=1.45; SystemROM=U33 v2.20 (09/25/2019); ProcessorName=Intel(R) Genuine processor} ExtendedInfo : @{UserSuppliedAddress=10.20.30.3; HttpConnectAddress=gen10pos.com; UserName=admin; Modifier1=cutDMcS/9GI5NLREeF7NFZIXX6rUrKckPlmE03yVMHI=; Modifier2=b6ZUCqggoN0zOCPkjwNPQA==} ConnectionInfo : @{Redfish=}</dev:code> <dev:remarks> <maml:para>This example shows the output of the Connect-HPEiLO cmdlet with interactive user input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 6</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.50 -Username username -Password password -DisableCertificateAuthentication PS C:\> $connection IP : 10.20.30.50 Hostname : Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant ML110 Gen10; ServerFamily=ProLiant; ServerGeneration=Gen10; ServerModel=ML110; iLOGeneration=iLO5; iLOFirmwareVersion=1.45; SystemROM=U33 v2.20 (09/25/2019); ProcessorName=Intel(R) Genuine processor} ExtendedInfo : @{UserSuppliedAddress=10.20.30.50 ; HttpConnectAddress=10.20.30.50; UserName=admin; Modifier1=cutDMcS/9GI5NLREeF7NFZIXX6rUrKckPlmE03yVMHI=; Modifier2=b6ZUCqggoN0zOCPkjwNPQA==} ConnectionInfo : @{Redfish=} PS C:\> $connection.TargetInfo ProductName : ProLiant ML110 Gen10 ServerFamily : ProLiant ServerGeneration : Gen10 ServerModel : ML110 iLOGeneration : iLO5 iLOFirmwareVersion : 1.45 SystemROM : U33 v2.20 (09/25/2019) ProcessorName : Intel(R) Genuine processor PS C:\> $connection.ExtendedInfo UserSuppliedAddress : 10.20.30.50 HttpConnectAddress : 10.20.30.50 UserName : admin Modifier1 : cutDMcS/9GI5NLREeF7NFZIXX6rUrKckPlmE03yVMHI= Modifier2 : b6ZUCqggoN0zOCPkjwNPQA== PS C:\Windows\system32> $connection.ConnectionInfo.Redfish | fl ResourceDirectoryJSON : {"@odata.context":"/redfish/v1/$metadata#HpeiLOResourceDirectory.HpeiLOResourceDirectory","@odata.etag ":"W/\"DBB0C358\"","@odata.id":"/redfish/v1/ResourceDirectory/","@odata.type":"#HpeiLOResourceDirector y.v2_0_0.HpeiLOResourceDirectory","Id":"ResourceDirectory","Instances":[{"@odata.id":"/redfish/v1/","@ odata.type":"#ServiceRoot.v1_5_0.ServiceRoot","ETag":"W/\"DA16F2D6\"","HttpMethods":["GET","HEAD"],"Me mberType":null,"href":null},{"@odata.id":"/redfish/v1/Managers/1/","@odata.type":"#Manager.v1_3_3.Mana ger","ETag":"W/\"45BE61CA\"","HttpMethods":["GET","HEAD","POST","PATCH"],"MemberType":null,"href":null },{"@odata.id"............ RootUrl : https://10.20.30.50/redfish/v1/ XAuthToken : 0hcP/vrvgQRNlBdkhY5oxC1cPPHQ0PZlfRC8zRFCEpuU56x9axWgWJE6vvvD4Nw/ Location : https://10.20.30.50/redfish/v1/SessionService/Sessions/admin000000000021f0c0dc28f5c2/ ODataVersion : 4.0 iLOResetWaitTimeout : 0 BIOSAttributeRegistryName : BiosAttributeRegistryU33.v1_1_50</dev:code> <dev:remarks> <maml:para>This example shows the output of the Connect-HPEiLO cmdlet with DisableCerificateAuthentication check. This will bypass server certification check while establishing the connection on target.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 7</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Connection using IP address in range PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.40-42 -Username username -Password password PS C:\> $connection IP : 10.20.30.40 Hostname : abc.com Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant SL270s Gen8 SE; ServerFamily=ProLiant; ServerGeneration=Gen8; ServerModel=SL250s; iLOGeneration=iLO4; iLOFirmwareVersion=2.62; SystemROM=P75 05/21/2018; ProcessorName= Intel(R) Xeon(R) CPU E5-2630 v2 @ 2.60GHz } ExtendedInfo : @{UserSuppliedAddress=10.20.30.40; HttpConnectAddress=abc.com; UserName=admin; Modifier1=6t/R7/o+T83f6IXAXEwnGzHQYmdmdo/tqvaZqDX4pvk=; Modifier2=NoDkPZXxrwxrOL2tByM4iQ==} ConnectionInfo : @{RIBCL=} IP : 10.20.30.41 Hostname : genpos1.com Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant XL250a Gen9; ServerFamily=ProLiant; ServerGeneration=Gen9; ServerModel=XL250a; iLOGeneration=iLO4; iLOFirmwareVersion=2.62; SystemROM=U13 v2.70 (12/15/2018); ProcessorName=Intel(R) Xeon(R) CPU E5-2609 v3 @ 1.90GHz} ExtendedInfo : @{UserSuppliedAddress=10.20.30.41; HttpConnectAddress=gen9pos1.com; UserName=admin; Modifier1=ExdHcZJ4bHdt7Ri4gL1jfLq/x4javFCzaljrg7QDxTc=; Modifier2=sLktxnOYtnOcdqJUfxI4zg==} ConnectionInfo : @{RIBCL=; REST=} IP : 10.20.30.42 Hostname : gen10pos1.com Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant ML110 Gen10; ServerFamily=ProLiant; ServerGeneration=Gen10; ServerModel=ML110; iLOGeneration=iLO5; iLOFirmwareVersion=1.45; SystemROM=U33 v2.20 (09/25/2019); ProcessorName=Intel(R) Genuine processor} ExtendedInfo : @{UserSuppliedAddress=10.20.30.42; HttpConnectAddress=gen10pos1.com; UserName=admin; Modifier1=cutDMcS/9GI5NLREeF7NFZIXX6rUrKckPlmE03yVMHI=; Modifier2=b6ZUCqggoN0zOCPkjwNPQA==} ConnectionInfo : @{Redfish=}</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 8</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Connection using IP address with comma separated value PS C:\> $connection = Connect-HPEiLO -IP "10.20.30.40,41" -Username username -Password password PS C:\> $connection IP : 10.20.30.40 Hostname : abc.com Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant SL270s Gen8 SE; ServerFamily=ProLiant; ServerGeneration=Gen8; ServerModel=SL250s; iLOGeneration=iLO4; iLOFirmwareVersion=2.62; SystemROM=P75 05/21/2018; ProcessorName= Intel(R) Xeon(R) CPU E5-2630 v2 @ 2.60GHz } ExtendedInfo : @{UserSuppliedAddress=10.20.30.40; HttpConnectAddress=abc.com; UserName=admin; Modifier1=6t/R7/o+T83f6IXAXEwnGzHQYmdmdo/tqvaZqDX4pvk=; Modifier2=NoDkPZXxrwxrOL2tByM4iQ==} ConnectionInfo : @{RIBCL=} IP : 10.20.30.41 Hostname : gen9pos1.com Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant XL250a Gen9; ServerFamily=ProLiant; ServerGeneration=Gen9; ServerModel=XL250a; iLOGeneration=iLO4; iLOFirmwareVersion=2.62; SystemROM=U13 v2.70 (12/15/2018); ProcessorName=Intel(R) Xeon(R) CPU E5-2609 v3 @ 1.90GHz} ExtendedInfo : @{UserSuppliedAddress=10.20.30.41; HttpConnectAddress=gen9pos1.com; UserName=admin; Modifier1=ExdHcZJ4bHdt7Ri4gL1jfLq/x4javFCzaljrg7QDxTc=; Modifier2=sLktxnOYtnOcdqJUfxI4zg==} ConnectionInfo : @{RIBCL=; REST=}</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 9</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Connection using XAuthTokenSet PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.40 -XAuthToken bf7d08a0d7c6321810be52af41926c1f -DisableCertificateAuthentication PS C:\> $connection IP : 10.20.30.50 Hostname : Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant ML110 Gen10; ServerFamily=ProLiant; ServerGeneration=Gen10; ServerModel=ML110; iLOGeneration=iLO5; iLOFirmwareVersion=1.45; SystemROM=U33 v2.20 (09/25/2019); ProcessorName=Intel(R) Genuine processor} ExtendedInfo : @{UserSuppliedAddress=10.20.30.50 ; HttpConnectAddress=10.20.30.50; UserName=admin; Modifier1=cutDMcS/9GI5NLREeF7NFZIXX6rUrKckPlmE03yVMHI=; Modifier2=b6ZUCqggoN0zOCPkjwNPQA==} ConnectionInfo : @{Redfish=} PS C:\> $connection.TargetInfo ProductName : ProLiant ML110 Gen10 ServerFamily : ProLiant ServerGeneration : Gen10 ServerModel : ML110 iLOGeneration : iLO5 iLOFirmwareVersion : 1.45 SystemROM : U33 v2.20 (09/25/2019) ProcessorName : Intel(R) Genuine processor PS C:\> $connection.ExtendedInfo UserSuppliedAddress : 10.20.30.50 HttpConnectAddress : 10.20.30.50 UserName : admin Modifier1 : cutDMcS/9GI5NLREeF7NFZIXX6rUrKckPlmE03yVMHI= Modifier2 : b6ZUCqggoN0zOCPkjwNPQA== PS C:\Windows\system32> $connection.ConnectionInfo.Redfish | fl ResourceDirectoryJSON : {"@odata.context":"/redfish/v1/$metadata#HpeiLOResourceDirectory.HpeiLOResourceDirectory","@odata.etag ":"W/\"DBB0C358\"","@odata.id":"/redfish/v1/ResourceDirectory/","@odata.type":"#HpeiLOResourceDirector y.v2_0_0.HpeiLOResourceDirectory","Id":"ResourceDirectory","Instances":[{"@odata.id":"/redfish/v1/","@ odata.type":"#ServiceRoot.v1_5_0.ServiceRoot","ETag":"W/\"DA16F2D6\"","HttpMethods":["GET","HEAD"],"Me mberType":null,"href":null},{"@odata.id":"/redfish/v1/Managers/1/","@odata.type":"#Manager.v1_3_3.Mana ger","ETag":"W/\"45BE61CA\"","HttpMethods":["GET","HEAD","POST","PATCH"],"MemberType":null,"href":null },{"@odata.id"............ RootUrl : https://10.20.30.50/redfish/v1/ XAuthToken : 0hcP/vrvgQRNlBdkhY5oxC1cPPHQ0PZlfRC8zRFCEpuU56x9axWgWJE6vvvD4Nw/ Location : https://10.20.30.50/redfish/v1/SessionService/Sessions/admin000000000021f0c0dc28f5c2/ ODataVersion : 4.0 iLOResetWaitTimeout : 0 BIOSAttributeRegistryName : BiosAttributeRegistryU33.v1_1_50</dev:code> <dev:remarks> <maml:para>This example shows the output of the Connect-HPEiLO cmdlet with XAuthTokenSet input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-HPEiLOConnection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEiLO</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-HPEiLOFunctionality</command:name> <maml:description> <maml:para>Disables iLO Functionality.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>HPEiLOFunctionality</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disable-HPEiLOFunctionality disables the iLO Functionality.</maml:para> <maml:para>WARNING: The iLO becomes un reacheable after the execution of this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disable-HPEiLOFunctionality</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Disable-HPEiLOFunctionality</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Disable-HPEiLOFunctionality -Connection $connection</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOLog</command:name> <maml:description> <maml:para>Disables the logging for the HPE iLO module.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>HPEiLOLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet switches OFF the logging behavior of iLO cmdlets.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disable-HPEiLOLog</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:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEiLOLog</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-HPEiLOMCTP</command:name> <maml:description> <maml:para>Disables the MCTP recovery setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>HPEiLOMCTP</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disable-HPEiLOMCTP cmdlet disables the MCTP recovery setting. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disable-HPEiLOMCTP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>Additional Parameters</maml:para> <maml:para>-Confirm [<SwitchParameter>] Prompts you for confirmation before running the cmdlet. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false</maml:para> <maml:para>-WhatIf [<SwitchParameter>] Shows what would happen if the cmdlet runs. The cmdlet is not run. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Disable-HPEiLOMCTP -Confirm:$true</dev:code> <dev:remarks> <maml:para>This cmdlet disables the MCTP setting on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Disable-HPEiLOMCTP -Connection $connection -Confirm:$true</dev:code> <dev:remarks> <maml:para>This cmdlet disables the MCTP setting in iLO 5, in which, the array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEiLOMCTP</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLODeviceInventory</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-HPEiLOSecurityDashboardSetting</command:name> <maml:description> <maml:para>Disables Security dashboard Ignore flags.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>HPEiLOSecurityDashboardSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Security Dashboard page displays the status of important security features and the Overall Security Status for the system. This cmdlet will give the option to disable the different security features. This is supported only on iLO5.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disable-HPEiLOSecurityDashboardSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreSecurityOverrideSwitch</maml:name> <maml:description> <maml:para>The server Security Override Switch (also called the System Maintenance Switch) is enabled. This configuration is a not recommended because login authentication is not required when the Security Override Switch is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreSecureBoot</maml:name> <maml:description> <maml:para>The UEFI Secure Boot option is disabled. In this configuration, the UEFI system firmware skips validation for the boot loader, Option ROM firmware, and other system software executable for trusted signatures. It breaks the chain of trust established by iLO from power-on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnorePasswordComplexity</maml:name> <maml:description> <maml:para>iLO is not configured to enforce the password complexity guidelines, which makes the server vulnerable to dictionary attacks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreIPMIDCMIOverLAN</maml:name> <maml:description> <maml:para>The IPMI/DCMI over LAN feature is enabled, which exposes the server to known IPMI security vulnerabilities.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreMinimumPasswordLength</maml:name> <maml:description> <maml:para>The minimum password length is less than the recommended length, which makes the server vulnerable to dictionary attacks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreRequireLoginforiLORBSU</maml:name> <maml:description> <maml:para>iLO is not configured to require login credentials to access the iLO Configuration Utility in the UEFI System Utilities. This configuration allows unauthenticated access to the iLO configuration during system boot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreAuthenticationFailureLogging</maml:name> <maml:description> <maml:para>iLO is not configured to log authentication failures.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreLastFirmwareScanResult</maml:name> <maml:description> <maml:para>The last firmware verification test failed. A firmware component is inconsistent or its integrity is compromised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreRequireHostAuthentication</maml:name> <maml:description> <maml:para>Determines whether iLO user credentials are required for host-based utilities such as HPONCFG and iLOREST. When this flag is set, the iLO credentials are not required. HPONCFG and iLOREST operate with iLO administrator privileges.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreDefaultSSLInUse</maml:name> <maml:description> <maml:para>When this flag is set, the default SSL Certificate is in use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreSecurityOverrideSwitch</maml:name> <maml:description> <maml:para>The server Security Override Switch (also called the System Maintenance Switch) is enabled. This configuration is a not recommended because login authentication is not required when the Security Override Switch is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreSecureBoot</maml:name> <maml:description> <maml:para>The UEFI Secure Boot option is disabled. In this configuration, the UEFI system firmware skips validation for the boot loader, Option ROM firmware, and other system software executable for trusted signatures. It breaks the chain of trust established by iLO from power-on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnorePasswordComplexity</maml:name> <maml:description> <maml:para>iLO is not configured to enforce the password complexity guidelines, which makes the server vulnerable to dictionary attacks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreIPMIDCMIOverLAN</maml:name> <maml:description> <maml:para>The IPMI/DCMI over LAN feature is enabled, which exposes the server to known IPMI security vulnerabilities.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreMinimumPasswordLength</maml:name> <maml:description> <maml:para>The minimum password length is less than the recommended length, which makes the server vulnerable to dictionary attacks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreRequireLoginforiLORBSU</maml:name> <maml:description> <maml:para>iLO is not configured to require login credentials to access the iLO Configuration Utility in the UEFI System Utilities. This configuration allows unauthenticated access to the iLO configuration during system boot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreAuthenticationFailureLogging</maml:name> <maml:description> <maml:para>iLO is not configured to log authentication failures.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreLastFirmwareScanResult</maml:name> <maml:description> <maml:para>The last firmware verification test failed. A firmware component is inconsistent or its integrity is compromised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreRequireHostAuthentication</maml:name> <maml:description> <maml:para>Determines whether iLO user credentials are required for host-based utilities such as HPONCFG and iLOREST. When this flag is set, the iLO credentials are not required. HPONCFG and iLOREST operate with iLO administrator privileges.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreDefaultSSLInUse</maml:name> <maml:description> <maml:para>When this flag is set, the default SSL Certificate is in use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $con = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $d = $con | Disable-HPEiLOSecurityDashboardSetting -IgnoreSecureBoot -IgnoreSecurityOverrideSwitch -IgnorePasswordComplexity -IgnoreIPMIDCMIOverLAN -IgnoreMinimumPasswordLength -IgnoreRequireLoginforiLORBSU -IgnoreAuthenticationFailureLogging -IgnoreLastFirmwareScanResult -IgnoreRequireHostAuthentication -IgnoreDefaultSSLInUse PS C:\> $d</dev:code> <dev:remarks> <maml:para>On an iLO5 server you will be disabling the ignore flag of all security parameters available on that server.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSecurityDashboardInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEiLOSecurityDashboardSetting</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>Disconnect-HPEiLO</command:name> <maml:description> <maml:para>The Disconnect-HPEiLO cmdlet closes the connection.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>HPEiLO</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disconnect-HPEiLO cmdlet closes the connection and cleans up the connection object.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet" default="true"> <!--NAME: UsernamePasswordSet--> <!--TAG: DEFAULT--> <maml:name>Disconnect-HPEiLO</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Disconnect-HPEiLO $connection</dev:code> <dev:remarks> <maml:para>$connection is the connection object or an array of iLO connection objects passed as the positional parameter to the cmdlet that has to be disconnected.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>C:\PS> ,$connection | Disconnect-HPEiLO</dev:code> <dev:remarks> <maml:para>$connection is the connection object or an array of iLO connection objects passed as pipeline input to the cmdlet that has to be disconnected.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-HPEiLOConnection</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>Dismount-HPEiLOVirtualMedia</command:name> <maml:description> <maml:para>Dismounts the Virtual Media image if one is mounted.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Dismount</command:verb> <command:noun>HPEiLOVirtualMedia</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Dismount-HPEiLOVirtualMedia cmdlet dismounts the Virtual Media image if one is mounted. You must purchase the iLO Advanced license to enable this feature.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Dismount-HPEiLOVirtualMedia</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Specifies the Virtual Media device target. The possible values are Floppy, CD, USBStick, and DVD.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD</command:parameterValue> <command:parameterValue required="false" variableLength="false">Floppy</command:parameterValue> <command:parameterValue required="false" variableLength="false">USBStick</command:parameterValue> <command:parameterValue required="false" variableLength="false">DVD</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Specifies the Virtual Media device target. The possible values are Floppy, CD, USBStick, and DVD.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD</command:parameterValue> <command:parameterValue required="false" variableLength="false">Floppy</command:parameterValue> <command:parameterValue required="false" variableLength="false">USBStick</command:parameterValue> <command:parameterValue required="false" variableLength="false">DVD</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Dismount-HPEiLOVirtualMedia -Device Floppy</dev:code> <dev:remarks> <maml:para>This cmdlet dismounts the Device on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Dismount-HPEiLOVirtualMedia -Device CD</dev:code> <dev:remarks> <maml:para>This cmdlet dismounts the Device on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Dismount-HPEiLOVirtualMedia -Connection $connection -Device CD,Floppy,DVD</dev:code> <dev:remarks> <maml:para>This cmdlet dismount the device in iLO 4 and iLO 5, in which, the array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Mount-HPEiLOVirtualMedia</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOVirtualMediaStatus</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-HPEiLOLog</command:name> <maml:description> <maml:para>Enables the logging for the HPE iLO module. By default, logging is disabled. If you require the logging feature, you must enable it explicitly.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>HPEiLOLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet switches ON the logging behavior of iLO cmdlets.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Enable-HPEiLOLog</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:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Clear-HPEiLOLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEiLOLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</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-HPEiLOMCTP</command:name> <maml:description> <maml:para>Enables the MCTP recovery setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>HPEiLOMCTP</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Enable-HPEiLOMCTP cmdlet enables the MCTP recovery setting. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Enable-HPEiLOMCTP</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Enable-HPEiLOMCTP -Confirm:$true</dev:code> <dev:remarks> <maml:para>This cmdlet enables the MCTP setting on iLO 5 with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Enable-HPEiLOMCTP -Connection $connection -Confirm:$true</dev:code> <dev:remarks> <maml:para>This cmdlet enables the MCTP setting in iLO 5, in which, the array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEiLOMCTP</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLODeviceInventory</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-HPEiLOSecurityDashboardSetting</command:name> <maml:description> <maml:para>Enables Security dashboard Ignore flags.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>HPEiLOSecurityDashboardSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Security Dashboard page displays the status of important security features and the Overall Security Status for the system. This cmdlet will give the option to enable different security features. This is supported only on iLO5.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Enable-HPEiLOSecurityDashboardSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreSecurityOverrideSwitch</maml:name> <maml:description> <maml:para>The server Security Override Switch (also called the System Maintenance Switch) is enabled. This configuration is not recommended because login authentication is not required when the Security Override Switch is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreSecureBoot</maml:name> <maml:description> <maml:para>The UEFI Secure Boot option is disabled. In this configuration, the UEFI system firmware skips validation for the boot loader, Option ROM firmware, and other system software executable for trusted signatures. It breaks the chain of trust established by iLO from power-on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnorePasswordComplexity</maml:name> <maml:description> <maml:para>iLO is not configured to enforce the password complexity guidelines, which makes the server vulnerable to dictionary attacks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreIPMIDCMIOverLAN</maml:name> <maml:description> <maml:para>The IPMI/DCMI over LAN feature is enabled, which exposes the server to known IPMI security vulnerabilities.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreMinimumPasswordLength</maml:name> <maml:description> <maml:para>The minimum password length is less than the recommended length, which makes the server vulnerable to dictionary attacks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreRequireLoginforiLORBSU</maml:name> <maml:description> <maml:para>iLO is not configured to require login credentials to access the iLO Configuration Utility in the UEFI System Utilities. This configuration allows unauthenticated access to the iLO configuration during system boot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreAuthenticationFailureLogging</maml:name> <maml:description> <maml:para>iLO is not configured to log authentication failures.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreLastFirmwareScanResult</maml:name> <maml:description> <maml:para>The last firmware verification test failed. A firmware component is inconsistent or its integrity is compromised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreRequireHostAuthentication</maml:name> <maml:description> <maml:para>Determines whether iLO user credentials are required for host-based utilities such as HPONCFG and iLOREST. When this flag is set, the iLO credentials are not required. HPONCFG and iLOREST operate with iLO administrator privileges.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreDefaultSSLInUse</maml:name> <maml:description> <maml:para>When this flag is set the default SSL certificate is not in use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreSecurityOverrideSwitch</maml:name> <maml:description> <maml:para>The server Security Override Switch (also called the System Maintenance Switch) is enabled. This configuration is not recommended because login authentication is not required when the Security Override Switch is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreSecureBoot</maml:name> <maml:description> <maml:para>The UEFI Secure Boot option is disabled. In this configuration, the UEFI system firmware skips validation for the boot loader, Option ROM firmware, and other system software executable for trusted signatures. It breaks the chain of trust established by iLO from power-on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnorePasswordComplexity</maml:name> <maml:description> <maml:para>iLO is not configured to enforce the password complexity guidelines, which makes the server vulnerable to dictionary attacks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreIPMIDCMIOverLAN</maml:name> <maml:description> <maml:para>The IPMI/DCMI over LAN feature is enabled, which exposes the server to known IPMI security vulnerabilities.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreMinimumPasswordLength</maml:name> <maml:description> <maml:para>The minimum password length is less than the recommended length, which makes the server vulnerable to dictionary attacks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreRequireLoginforiLORBSU</maml:name> <maml:description> <maml:para>iLO is not configured to require login credentials to access the iLO Configuration Utility in the UEFI System Utilities. This configuration allows unauthenticated access to the iLO configuration during system boot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreAuthenticationFailureLogging</maml:name> <maml:description> <maml:para>iLO is not configured to log authentication failures.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreLastFirmwareScanResult</maml:name> <maml:description> <maml:para>The last firmware verification test failed. A firmware component is inconsistent or its integrity is compromised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreRequireHostAuthentication</maml:name> <maml:description> <maml:para>Determines whether iLO user credentials are required for host-based utilities such as HPONCFG and iLOREST. When this flag is set, the iLO credentials are not required. HPONCFG and iLOREST operate with iLO administrator privileges.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreDefaultSSLInUse</maml:name> <maml:description> <maml:para>When this flag is set the default SSL certificate is not in use.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $con = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $e = $con | Enable-HPEiLOSecurityDashboardSetting -IgnoreSecureBoot -IgnoreSecurityOverrideSwitch -IgnorePasswordComplexity -IgnoreIPMIDCMIOverLAN -IgnoreMinimumPasswordLength -IgnoreRequireLoginforiLORBSU -IgnoreAuthenticationFailureLogging -IgnoreLastFirmwareScanResult -IgnoreRequireHostAuthentication -IgnoreDefaultSSLInUse PS C:\> $e</dev:code> <dev:remarks> <maml:para>On an iLO5 server you will be enabling ignore flag of all security parameters available on that server.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSecurityDashboardInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEiLOSecurityDashboardSetting</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-HPEiLOSystemIntelligentDiagnosticsMode</command:name> <maml:description> <maml:para>Enables the Intelligent Diagnostics Mode.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>HPEiLOSystemIntelligentDiagnosticsMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Enable-HPEiLOSystemIntelligentDiagnosticsMode cmdlet enables the entry of Intelligent Diagnostics mode on supported servers. In this mode, the system can automatically diagnose a boot failure during POST. This is supported only on iLO5 Gen10 Plus systems.</maml:para> <maml:para>The server must be powered off to enable this feature.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Enable-HPEiLOSystemIntelligentDiagnosticsMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 C:\PS> $out = $connection | Enable-HPEiLOSystemIntelligentDiagnosticsMode</dev:code> <dev:remarks> <maml:para>This cmdlet enables the Intelligent Diagnostic Mode setting on iLO 5 Gen10 plus systems with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Enable-HPEiLOSystemIntelligentDiagnosticsMode -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSystemDiagnosticsModeSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOSystemSafeMode</command:name> <maml:description> <maml:para>Enables the server to boot in safe mode.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>HPEiLOSystemSafeMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The cmdlet Enable-HPEiLOSystemSafeMode allows you to boot the server with a safe minimum configuration. This is supported only on iLO5 Gen10 Plus systems.</maml:para> <maml:para>To enable this feature, the server must be powered off.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Enable-HPEiLOSystemSafeMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 C:\PS> $out = $connection | Enable-HPEiLOSystemSafeMode</dev:code> <dev:remarks> <maml:para>This cmdlet enables to boot in safe mode on iLO 5 Gen10 plus systems with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Enable-HPEiLOSystemSafeMode -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSystemDiagnosticsModeSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Find-HPEiLO</command:name> <maml:description> <maml:para>Find the array of iLO in a specified subnet.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Find</command:verb> <command:noun>HPEiLO</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Find-HPEiLO cmdlet lists available iLOs in the subnet provided. You must provide the subnet in which the iLOs have to be searched. By default, it searches the default port in the iLOs. You can provide a port number by appending a port number (":#") to the IP range. The port number must be appended with an input IP address in case of a change in the HTTPS port number in iLO settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Find-HPEiLO</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="IP , iLOIP"> <maml:name>Range</maml:name> <maml:description> <maml:para>Specifies the lower parts of the IP addresses, which is the subnet where the iLOs are being searched. For the IP address format “a.b.c.d,” where a, b, c, d represent an integer from 0 to 255.</maml:para> <maml:para>Aliases : IP,iLOIP</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout period for ping request. Timeout period can be specified by the user where there can be a possible lag due to geographical distance between the client and server. The value is specified in seconds. Default value is 30 seconds. If the default timeout is not long enough, no iLOs will be found and no errors will be displayed. The parameter accepts values in the range of 1 to 1800.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Full</maml:name> <maml:description> <maml:para>Retrieves the complete data for further processing or is pipelined to another command or cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="IP , iLOIP"> <maml:name>Range</maml:name> <maml:description> <maml:para>Specifies the lower parts of the IP addresses, which is the subnet where the iLOs are being searched. For the IP address format “a.b.c.d,” where a, b, c, d represent an integer from 0 to 255.</maml:para> <maml:para>Aliases : IP,iLOIP</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout period for ping request. Timeout period can be specified by the user where there can be a possible lag due to geographical distance between the client and server. The value is specified in seconds. Default value is 30 seconds. If the default timeout is not long enough, no iLOs will be found and no errors will be displayed. The parameter accepts values in the range of 1 to 1800.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Full</maml:name> <maml:description> <maml:para>Retrieves the complete data for further processing or is pipelined to another command or cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</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> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>For IP address format “a.b.c.d,” where a, b, c, d represent an integer from 0 to 255, the Range parameter can have the following values: a – Such as 10 in all IP addresses from 10.0.0.0 to 10.255.255.255; a.b – Such as 10.44 in all IP addresses from 10.44.0.0 to 10.44.255.255; a.b.c – Such as 10.44.111 in all IP addresses from 10.44.111.0 to 10.44.111.255; a.b.c.d – Such as 10.44.111.222 in IP address 10.44.111.222.</maml:para> <maml:para>Each division of the IP address can specify a range using a hyphen. For example, 10.44.111.10–12 returns IP addresses 10.44.111.10, 10.44.111.11, and 10.44.111.12. Each division of the IP address can specify a set using a comma. For example, 10.44.111.10,12 returns IP addresses 10.44.111.10 and 10.44.11.12. Both IPv4 and IPv6 ranges are supported. Port number is optional. Using port number 8888, the inputs are 10:8888, 10.44:8888, 10.44.111:8888, and 10.44.111.222:8888. Without a port number, the default port in iLO is used.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Find-HPEiLO "6.4.217"</dev:code> <dev:remarks> <maml:para>This will list the IP addresses of iLOs ranging from 6.4.217.0 to 6.4.217.255.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Find-HPEiLO "2607:f0d0:1002:51::0-FFFF"</dev:code> <dev:remarks> <maml:para>This will list the IP addresses of iLOs ranging from 2607:f0d0:1002:51::0 to 2607:f0d0:1002:51::FFFF.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Find-HPEiLO "6.4.217.93,103" -Timeout 200</dev:code> <dev:remarks> <maml:para>This will list the IP addresses of iLOs 6.4.217.93 and 6.4.217.103. The timeout for the ping response of each IP will be 200 seconds.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Find-HPEiLO "6.4.217" -Timeout 1000</dev:code> <dev:remarks> <maml:para>This will list the IP addresses of iLOs ranging from 6.4.217.0 to 6.4.217.255. The timeout for the ping response of each IP will be 1000 seconds.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 5</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Find-HPEiLO "6.4"</dev:code> <dev:remarks> <maml:para>This will list the IP addresses of iLOs 6.4.0.0 to 6.4.0.255, 6.4.1.0 to 6.4.1.255 until 6.4.255.0 to 6.4.255.255.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 6</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Find-HPEiLO "6.4:8080"</dev:code> <dev:remarks> <maml:para>This will list the IP addresses of iLOs 6.4.0.0 to 6.4.0.255, 6.4.1.0 to 6.4.1.255 until 6.4.255.0 to 6.4.255.255. Port 8080 is used when searching all the IP addresses.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 7</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Find-HPEiLO "[2607:f0d0:1002:51::4]:8080" -Timeout 1000</dev:code> <dev:remarks> <maml:para>This will list the IP addresses of iLOs 2607:f0d0:1002:51::4. Port 8080 is used. The timeout for the ping response of each IP will be 1000 seconds.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 8</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Find-HPEiLO "6.4.217" -Full</dev:code> <dev:remarks> <maml:para>This will list the IP addresses along with other details of iLOs ranging from 6.4.217.0 to 6.4.217.255.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 9</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $out = Find-HPEiLO 10.20.30.1 -Full PS C:\> $out IP : 10.20.30.1 Hostname : xyz.domain.com HostSystemInformation : HPE.iLO.Response.HSI ManagementProcessor : HPE.iLO.Response.MP BladeSystem : HPE.iLO.Response.RIMPBladeSystem Spatial : HPE.iLO.Response.RIMPSpatial Health : HPE.iLO.Response.RIMPHealth PS C:\> $out.ManagementProcessor ST : 1 PN : Integrated Lights-Out 4 (iLO 4) FWRI : 2.44 BBLK : 05/05/2012 HWRI : ASIC: 12 SN : ILOCN76130987 UUID : ILO000 IPM : 1 SSO : 1 PWRM : UNKNOWN ERS : 0 EALERT : 1 PS C:\> $out.HostSystemInformation SerialNumber : CN76130987 SPN : ProLiant BL465c Gen8 UUID : 000 SP : 0 cUUID : 00000000-0000-4E43-3736-313330393837 Virtual : HPE.iLO.Response.HSI_Virtual ProductID : NICS : {HPE.iLO.Response.HSI_NIC, HPE.iLO.Response.HSI_NIC, HPE.iLO.Response.HSI_NIC, HPE.iLO.Response.HSI_NIC...} PS C:\> $out.BladeSystem | fl Bay : 4 Manager : HPE.iLO.Response.RIMPBladeSystemManager PS C:\> $out.Spatial DiscoveryRack : Not Supported DiscoveryData : Server does not support Location Discovery Services TagVersion : 0 RackID : 0 RackID_PN : 0 RackDescription : 0 RackUHeight : 0 UPosition : 0 ULocation : 0 cUUID : 00000000-0000-4E43-3736-313330393837 UHeight : 1000 UOffSet : 2 Bay : 4 EnclosurecUUID : 53553930-3945-3432-4D56-4131 0 0 0 0 0 04B41545345455246 PS C:\> $out.Health | fl Status : 2</dev:code> <dev:remarks> <maml:para>This example shows the cmdlet output when the -Full parameter is used.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOAccessSetting</command:name> <maml:description> <maml:para>Gets the iLO access settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOAccessSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOAccessSetting cmdlet gets the respective iLO access settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOAccessSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.iLO3.AccessSettingInfo[] or HPE.iLO.Response.Redfish.AccessSettingInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOAccessSetting AuthenticationFailuresBeforeDelay : 1 AuthenticationFailureDelayTimeSeconds : 10 iLOFunctionalityEnabled : Yes IPMIPort : 623 LockConfiguration : No SNMPProtocolEnabled : Yes SNMPPort : 1234 SNMPTrapPort : 192 SerialOverLANLoggingEnabled : Yes AuthenticationFailureLoggingThreshold : Enabled-Every3rdFailure EnforceAES3DESEncryption : Yes HTTPSPort : 443 HTTPPort : 85 iLORBSUEnabled : No IPMIProtocolEnabled : Yes MinimumPasswordLength : 8 PropagateTimeToHost : Yes RBSUPostIP : Yes RemoteConsolePort : 17990 RequiredLoginForiLORBSU : No SerialCLISpeed : 9600 SerialCLIStatus : Enabled-AuthenticationRequired SessionTimeoutMinutes : 120 SSHProtocolEnabled : Yes SSHPort : 22 VirtualMediaPort : 10 IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> Get-HPEiLOAccessSetting -Connection $connection AuthenticationFailuresBeforeDelay : 5 AuthenticationFailureDelayTimeSeconds : 5 AuthenticationFailureLoggingThreshold : Disabled FederationEnabled : No FederationSupported : Yes FQDN : xyz.com HTTPPort : 5 HTTPProtocolEnabled : Yes HTTPSPort : 443 HTTPSProtocolEnabled : Yes iLOFunctionalityEnabled : Yes iLORBSUEnabled : Yes IPMIPort : 65534 IPMIProtocolEnabled : Yes MinimumPasswordLength : 0 PasswordComplexityEnabled : No PhysicalMonitorHealthStatusEnabled : No RIBCLEnabled : No RemoteConsolePort : 11212 RemoteConsoleProtocolEnabled : Yes RemoteConsoleThumbnailEnabled : Yes RequireHostAuthentication : No RequiredLoginForiLORBSU : No SerialCLISpeed : 115200 SerialCLIStatus : Disabled SerialCLIUART : Present SessionTimeoutMinutes : 120 SNMPProtocolEnabled : No SNMPPort : 255 SNMPTrapPort : 162 SSHProtocolEnabled : Yes SSDPNotifyIPv6Scope : Organization SSDPNotifyMulticastIntervalSeconds : 1800 SSDPNotifyTTL : 1 SSDPPort : 1900 SSDPProtocolEnabled : Yes SSHPort : 2222 VirtualMediaProtocolEnabled : No VirtualMediaEncryptionEnabled : Yes VideoPresenceDetectOverride : Yes VideoPresenceDetectOverrideSupported : Yes VirtualNICEnabled : Yes VirtualMediaPort : 65535 VSPLogDownloadEnabled : No WebGUIEnabled : Yes XMLReplyEnabled : Yes SerialOverLANLoggingEnabled : No VSPDlLoggingEnabled : No ServerName : ServerFQDN : IP : 10.20.30.40 Hostname : xyz.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOAccessSetting -Connection $connection AuthenticationFailuresBeforeDelay : 1 AuthenticationFailureDelayTimeSeconds : 10 iLOFunctionalityEnabled : Yes IPMIPort : 623 LockConfiguration : No SNMPProtocolEnabled : Yes SNMPPort : 1234 SNMPTrapPort : 192 SerialOverLANLoggingEnabled : Yes AuthenticationFailureLoggingThreshold : Enabled-Every3rdFailure EnforceAES3DESEncryption : Yes HTTPSPort : 443 HTTPPort : 85 iLORBSUEnabled : No IPMIProtocolEnabled : Yes MinimumPasswordLength : 8 PropagateTimeToHost : Yes RBSUPostIP : Yes RemoteConsolePort : 17990 RequiredLoginForiLORBSU : No SerialCLISpeed : 9600 SerialCLIStatus : Enabled-AuthenticationRequired SessionTimeoutMinutes : 120 SSHProtocolEnabled : Yes SSHPort : 22 VirtualMediaPort : 10 IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo : AuthenticationFailuresBeforeDelay : 5 AuthenticationFailureDelayTimeSeconds : 5 AuthenticationFailureLoggingThreshold : Disabled FederationEnabled : No FederationSupported : Yes FQDN : xyz.com HTTPPort : 5 HTTPProtocolEnabled : Yes HTTPSPort : 443 HTTPSProtocolEnabled : Yes iLOFunctionalityEnabled : Yes iLORBSUEnabled : Yes IPMIPort : 65534 IPMIProtocolEnabled : Yes MinimumPasswordLength : 0 PasswordComplexityEnabled : No PhysicalMonitorHealthStatusEnabled : No RIBCLEnabled : No RemoteConsolePort : 11212 RemoteConsoleProtocolEnabled : Yes RemoteConsoleThumbnailEnabled : Yes RequireHostAuthentication : No RequiredLoginForiLORBSU : No SerialCLISpeed : 115200 SerialCLIStatus : Disabled SerialCLIUART : Present SessionTimeoutMinutes : 120 SNMPProtocolEnabled : No SNMPPort : 255 SNMPTrapPort : 162 SSHProtocolEnabled : Yes SSDPNotifyIPv6Scope : Organization SSDPNotifyMulticastIntervalSeconds : 1800 SSDPNotifyTTL : 1 SSDPPort : 1900 SSDPProtocolEnabled : Yes SSHPort : 2222 VirtualMediaProtocolEnabled : No VirtualMediaEncryptionEnabled : Yes VideoPresenceDetectOverride : Yes VideoPresenceDetectOverrideSupported : Yes VirtualNICEnabled : Yes VirtualMediaPort : 65535 VSPLogDownloadEnabled : No WebGUIEnabled : Yes XMLReplyEnabled : Yes SerialOverLANLoggingEnabled : No VSPDlLoggingEnabled : No ServerName : ServerFQDN : IP : 10.20.30.40 Hostname : xyz.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOAccessSetting</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-HPEiLOAHSStatus</command:name> <maml:description> <maml:para>Gets the AHS status.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOAHSStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOAHSStatus cmdlet gets the value of the Active Health System status.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOAHSStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.AHSStatus[] or HPE.iLO.Response.Redfish.AHSStatus[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOAHSStatus AHSEnabled : No AHSHardwareEnabled : Yes AHSTemporaryHoldEnabled : No IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOAHSStatus AHSEnabled : No AHSHardwareEnabled : Yes AHSSoftwareEnabled : No AHSTemporaryHoldEnabled : No IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEiLOAHSStatus -Connection $connection AHSEnabled : No AHSHardwareEnabled : Yes AHSTemporaryHoldEnabled : No IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : AHSEnabled : No AHSHardwareEnabled : Yes AHSSoftwareEnabled : No AHSTemporaryHoldEnabled : No IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOAHSStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOAlertMailSetting</command:name> <maml:description> <maml:para>Gets the AlertMail setting of the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOAlertMailSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOAlertMailSetting cmdlet gets the value of the AlertMail setting of the server.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOAlertMailSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.iLO4.AlertMailSettingInfo[] or HPE.iLO.Response.Redfish.AlertMailSettingInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOAlertMailSetting AlertMailEmail : yv@hpe.com AlertMailEnabled : Yes AlertMailSMTPAuthEnabled : No AlertMailSMTPSecureEnabled : Yes AlertMailSenderDomain : 1.1.1.1 AlertMailSMTPPort : 100 AlertMailSMTPServer : 10.10.10.10 AlertMailSMTPAuthUser : IP : 192.168.10.34 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEiLOAlertMailSetting -Connection $connection AlertMailEmail : am1@hpe.com AlertMailEnabled : Yes AlertMailSMTPAuthEnabled : No AlertMailSMTPSecureEnabled : Yes AlertMailSenderDomain : 1.1.1.1 AlertMailSMTPPort : 100 AlertMailSMTPServer : 10.10.10.10 AlertMailSMTPAuthUser : IP : 10.20.30.1 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo : AlertMailEmail : am2@hpe.com AlertMailEnabled : Yes AlertMailSMTPAuthEnabled : No AlertMailSMTPSecureEnabled : Yes AlertMailSenderDomain : 1.1.1.1 AlertMailSMTPPort : 100 AlertMailSMTPServer : 10.10.10.10 AlertMailSMTPAuthUser : AlertMailSMTPAuthPw : IP : 10.20.30.2 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo : AlertMailEmail : am3@hpe.com AlertMailEnabled : Yes AlertMailSMTPAuthEnabled : No AlertMailSMTPSecureEnabled : Yes AlertMailSenderDomain : 1.1.1.1 AlertMailSMTPPort : 100 AlertMailSMTPServer : 10.10.10.10 AlertMailSMTPAuthUser : AlertMailSMTPAuthPw : IP : 10.20.30.3 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOAlertMailSetting</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-HPEiLOAssetTag</command:name> <maml:description> <maml:para>Gets the Asset tag.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOAssetTag</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOAssetTag cmdlet gets the value of the asset tag of the server.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOAssetTag</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.AssetTagInfo[] or HPE.iLO.Response.Redfish.AssetTagInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOAssetTag | fl AssetTag : Test123 IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEiLOAssetTag -Connection $connection | fl AssetTag : Test1234 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOAssetTag | fl AssetTag : Test123 IP : 10.20.30.1 Hostname : bl465cgen8-01.powershvpn.com Status : OK StatusInfo : AssetTag : Test1234 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOAssetTag</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-HPEiLOBatteryBackUpUnit</command:name> <maml:description> <maml:para>Gets the Battery Back up Unit detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOBatteryBackUpUnit</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOBatteryBackUpUnit cmdlet gets the Battery Back up Unit detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOBatteryBackUpUnit</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.BatteryBackUpUnitInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOBatteryBackUpUnit BbuPowerSupplyAction : MomentaryPowerButtonPress BatteryBackUpUnit : IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOBatteryBackUpUnit -Connection $connection BbuPowerSupplyAction : MomentaryPowerButtonPress BatteryBackUpUnit : IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : BbuPowerSupplyAction : MomentaryPowerButtonPress BatteryBackUpUnit : IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOBatteryBackUpUnit</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-HPEiLOBootMode</command:name> <maml:description> <maml:para>Gets the supported boot mode, current boot mode, and pending boot mode of the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOBootMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOBootMode cmdlet retrieves the supported boot mode, current boot mode, and pending boot mode of the server.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOBootMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.BootModeInfo[] or HPE.iLO.Response.Redfish.BootModeInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 192.168.10.34 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOBootMode SupportedBootMode : {LegacyBios, UEFI} CurrentBootMode : UEFI PendingBootMode : UEFI IsColdBooting : False IP : 192.168.10.34 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Get-HPEiLOBootMode -Connection $connection SupportedBootMode : {LegacyBios, UEFI} CurrentBootMode : UEFI PendingBootMode : UEFI IsColdBooting : False IP : 10.20.30.40 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo : SupportedBootMode : {LegacyBios, UEFI} CurrentBootMode : UEFI PendingBootMode : UEFI IsColdBooting : True IP : 10.20.30.41 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo : SupportedBootMode : {LegacyBios, UEFI} CurrentBootMode : UEFI PendingBootMode : UEFI IsColdBooting : False IP : 10.20.30.42 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOBootMode</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-HPEiLOBootOption</command:name> <maml:description> <maml:para>Gets the boot options available in the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOBootOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOBootOption cmdlet retrieves the boot options available for the server. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOBootOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.BootOption[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\>$output = ,$connection | Get-HPEiLOBootOption PS C:\> $output BootOptionInfo : {HPE.iLO.Response.Redfish.BootOptionInfo, HPE.iLO.Response.Redfish.BootOptionInfo} IP : 10.20.30.40 Hostname : abc.poseidon.com Status : OK StatusInfo : PS C:\> $output.BootOptionInfo Id : 1 Alias : USB BootOptionReference : Boot000D DisplayName : Generic USB Boot UefiDevicePath : UsbClass(0xFFFF,0xFFFF,0xFF,0xFF,0xFF) Id : 2 Alias : HDD BootOptionReference : Boot000E DisplayName : Internal SD Card 1 : Generic USB3.0-CRW UefiDevicePath : PciRoot(0x3)/Pci(0x8,0x1)/Pci(0x0,0x3)/USB(0x3,0x0)/USB(0x2,0x0)</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOBootOption BootOptionInfo : {HPE.iLO.Response.Redfish.BootOptionInfo, HPE.iLO.Response.Redfish.BootOptionInfo} IP : 10.20.30.40 Hostname : abc.poseidon.com Status : OK StatusInfo : BootOptionInfo : {HPE.iLO.Response.Redfish.BootOptionInfo, HPE.iLO.Response.Redfish.BootOptionInfo, HPE.iLO.Response.Redfish.BootOptionInfo, HPE.iLO.Response.Redfish.BootOptionInfo...} IP : 10.20.30.41 Hostname : xyz.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOBrownout</command:name> <maml:description> <maml:para>Gets the brownout recovery setting of the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOBrownout</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOBrownout cmdlet gets the server recovery settings when a brownout condition occurs in the server. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOBrownout</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.Brownout[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOBrownout | fl BrownoutEnabled : No IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 server with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEiLOBrownout -Connection $connection | fl BrownoutEnabled : No IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : BrownoutEnabled : Yes IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOBrownout</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-HPEiLOCACSmartCardAuthentication</command:name> <maml:description> <maml:para>Gets the CAC smart card detail</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOCACSmartCardAuthentication</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOCACSmartAuthentication gets the CAC smart card detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOCACSmartCardAuthentication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.CACSmartCardAuthentication[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOCACSmartCardAuthentication CRLIssuer : CRLSerial : CertificateLoginEnabled : No LDAPCertificateNameMapping : SANUPN StrictCACModeEnabled : No OCSPUri : IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOCACSmartCardAuthentication CRLIssuer : CRLSerial : CertificateLoginEnabled : No LDAPCertificateNameMapping : SANUPN StrictCACModeEnabled : No OCSPUri : IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : CRLIssuer : CRLSerial : CertificateLoginEnabled : No LDAPCertificateNameMapping : SANUPN StrictCACModeEnabled : No OCSPUri : IP : 10.20.30.41 Hostname : xyz.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOCertificateSigningRequest</command:name> <maml:description> <maml:para>Gets the Certificate Signing Request status.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOCertificateSigningRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOCertificateSigningRequest cmdlet gets a certificate from iLO. Execute the Start-HPEiLOCertificateSigningRequest cmdlet before executing this cmdlet to start the Certificate Signing Request. A gap of 10 minutes is recommended between the execution of the two cmdlets.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOCertificateSigningRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.String</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>HPE.iLO.Response.RIBCL.CertificateSigningRequestInfo[] or HPE.iLO.Response.Redfish.CertificateSigningRequestInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOCertificateSigningRequest CertificateSigningRequest : -----BEGIN CERTIFICATE REQUEST----- MIIDBjCCAe4CAQAwgYYxJTAjBgNVBAMMHGJsNDY1Y2dlbjgtMDEucG93ZXJzaHZw bi5jb20xDDAKBgNVBAsMA0lTUzEgMB4GA1UECgwXSGV3bGV0dC1QYWNrYXJkIENv bXBhbnkxEDAOBgNVBAcMB0hvdXN0b24xDjAMBgNVBAgMBVRleGFzMQswCQYDVQQG EwJVUzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL+EL/Bw3t9OW9mb iV2Dp3Yw0rjoUf1+8J5nc4vmrHVVG4DOxO2Xs3NaixLOdnDgmZLmMmqCi0wZcbKj XV9gwkqPQ7aV6YoD0BI0psHcxTvI2GjgSiSEW6eugAuoB2dPU4jCHO9uZPgYf7ml o6dpmqXSPJbxrlErJlzzADc0+h0uYrs3Kw7cy6I/u/KFFUe1YuqO7POJk9ygbPMu L4CUPs0aAwxMojbov9oB/czl7qNIBIGGUlhvx0Cgb5y2osiisojNuOYPgMWOQm80 Grb93sO8Tfvo0n6VctONAqte4NNjErbISCDxc50GuU7+WxjGeo4ao7YyFtnACsxj Gk+wmkECAwEAAaA6MDgGCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoIcYmw0NjVj Z2VuOC0wMS5wb3dlcnNodnBuLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEADgFhxB/8 hw0i1hjEoUJy0uWcVL4e+Ty9+YyQFJA8xMGNVdDCZJU5s5UnCpylH0R18T+/5jwT jGW5kzpsOuWBqj3MlKTqWsaZUwPm4Lx2vGObRNZ9748MOGjami9W+7ZQaVxPpgdA akzzJrFnDm2XsQTUfClPHoP2vXV4Ad6ajSZ40ZDf9N7nigTYOcLx0DKFecnwxpDh fBPS+Gw4BquWTf2lU+KbxDFc5kLYUly2qTUGW7ortG9fyPTbcJyRYN4vP4OT9as6 127fzuMGC2xElh8KHcVe3z/054F9DnAmg72fcEc5Cjd76L9ZLAol9XvGtnp8CPQ/ UH3hXEqMDvcZpw== -----END CERTIFICATE REQUEST----- IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOCertificateSigningRequest -Connection $connection CertificateSigningRequest : -----BEGIN CERTIFICATE REQUEST----- MIIDBjCCAe4CAQAwgYYxJTAjBgNVBAMMHGJsNDY1Y2dlbjgtMDEucG93ZXJzaHZw bi5jb20xDDAKBgNVBAsMA0lTUzEgMB4GA1UECgwXSGV3bGV0dC1QYWNrYXJkIENv bXBhbnkxEDAOBgNVBAcMB0hvdXN0b24xDjAMBgNVBAgMBVRleGFzMQswCQYDVQQG EwJVUzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL+EL/Bw3t9OW9mb iV2Dp3Yw0rjoUf1+8J5nc4vmrHVVG4DOxO2Xs3NaixLOdnDgmZLmMmqCi0wZcbKj XV9gwkqPQ7aV6YoD0BI0psHcxTvI2GjgSiSEW6eugAuoB2dPU4jCHO9uZPgYf7ml o6dpmqXSPJbxrlErJlzzADc0+h0uYrs3Kw7cy6I/u/KFFUe1YuqO7POJk9ygbPMu L4CUPs0aAwxMojbov9oB/czl7qNIBIGGUlhvx0Cgb5y2osiisojNuOYPgMWOQm80 Grb93sO8Tfvo0n6VctONAqte4NNjErbISCDxc50GuU7+WxjGeo4ao7YyFtnACsxj Gk+wmkECAwEAAaA6MDgGCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoIcYmw0NjVj Z2VuOC0wMS5wb3dlcnNodnBuLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEADgFhxB/8 hw0i1hjEoUJy0uWcVL4e+Ty9+YyQFJA8xMGNVdDCZJU5s5UnCpylH0R18T+/5jwT jGW5kzpsOuWBqj3MlKTqWsaZUwPm4Lx2vGObRNZ9748MOGjami9W+7ZQaVxPpgdA akzzJrFnDm2XsQTUfClPHoP2vXV4Ad6ajSZ40ZDf9N7nigTYOcLx0DKFecnwxpDh fBPS+Gw4BquWTf2lU+KbxDFc5kLYUly2qTUGW7ortG9fyPTbcJyRYN4vP4OT9as6 127fzuMGC2xElh8KHcVe3z/054F9DnAmg72fcEc5Cjd76L9ZLAol9XvGtnp8CPQ/ UH3hXEqMDvcZpw== -----END CERTIFICATE REQUEST----- IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : CertificateSigningRequest : -----BEGIN CERTIFICATE REQUEST----- MIIDBjCCAe4CAQAwgYYxJTAjBgNVBAMMHGJsNDY1Y2dlbjgtMDEucG93ZXJzaHZw bi5jb20xDDAKBgNVBAsMA0lTUzEgMB4GA1UECgwXSGV3bGV0dC1QYWNrYXJkIENv bXBhbnkxEDAOBgNVBAcMB0hvdXN0b24xDjAMBgNVBAgMBVRleGFzMQswCQYDVQQG EwJVUzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL+EL/Bw3t9OW9mb iV2Dp3Yw0rjoUf1+8J5nc4vmrHVVG4DOxO2Xs3NaixLOdnDgmZLmMmqCi0wZcbKj XV9gwkqPQ7aV6YoD0BI0psHcxTvI2GjgSiSEW6eugAuoB2dPU4jCHO9uZPgYf7ml o6dpmqXSPJbxrlErJlzzADc0+h0uYrs3Kw7cy6I/u/KFFUe1YuqO7POJk9ygbPMu L4CUPs0aAwxMojbov9oB/czl7qNIBIGGUlhvx0Cgb5y2osiisojNuOYPgMWOQm80 Grb93sO8Tfvo0n6VctONAqte4NNjErbISCDxc50GuU7+WxjGeo4ao7YyFtnACsxj Gk+wmkECAwEAAaA6MDgGCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoIcYmw0NjVj Z2VuOC0wMS5wb3dlcnNodnBuLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEADgFhxB/8 hw0i1hjEoUJy0uWcVL4e+Ty9+YyQFJA8xMGNVdDCZJU5s5UnCpylH0R18T+/5jwT jGW5kzpsOuWBqj3MlKTqWsaZUwPm4Lx2vGObRNZ9748MOGjami9W+7ZQaVxPpgdA akzzJrFnDm2XsQTUfClPHoP2vXV4Ad6ajSZ40ZDf9N7nigTYOcLx0DKFecnwxpDh fBPS+Gw4BquWTf2lU+KbxDFc5kLYUly2qTUGW7ortG9fyPTbcJyRYN4vP4OT9as6 127fzuMGC2xElh8KHcVe3z/054F9DnAmg72fcEc5Cjd76L9ZLAol9XvGtnp8CPQ/ UH3hXEqMDvcZpw== -----END CERTIFICATE REQUEST----- IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPEiLOCertificateSigningRequest</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-HPEiLOChassisInfo</command:name> <maml:description> <maml:para>Gets the chassis information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOChassisInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets the comprehensive target chassis information. This cmdlet is supported only on iLO5.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOChassisInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.ChassisInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = Get-HPEiLOChassisInfo -Connection $connection PS C:\> $obj | fl Id : 1 AssetTag : ChassisType : Blade Description : IndicatorLED : Manufacturer : HPE Model : ProLiant BL460c Gen10 Name : Computer System Chassis PartNumber : PhysicalSecurity : SKU : BL460cGen10 SerialNumber : 2M270801TB EnclosureIndicatorLED : off EnclosureModel : EnclosureUUID : BayNumber : 3 BaysConsumedHeight : 1 BaysConsumedWidth : 1 Firmware : HPE.iLO.Response.Redfish.ChassisFirmware Images : OnboardAdministrator : Location : MCTPEnabledOnServer : PowerAlertMode : HPE.iLO.Response.Redfish.PowerAlertMode SmartStorageBattery : SystemMaintenanceSwitches : HPE.iLO.Response.Redfish.SystemMaintenanceSwitches ChassisStatus : HPE.iLO.Response.Redfish.Status IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $obj.ChassisStatus Health State HealthRollUp ------ ----- ------------ OK Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.50 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOChassisInfo PS C:\> $obj | fl Id : 1 AssetTag : ChassisType : Blade Description : IndicatorLED : Manufacturer : HPE Model : ProLiant BL460c Gen10 Name : Computer System Chassis PartNumber : PhysicalSecurity : SKU : BL460cGen10 SerialNumber : 2M270801TB EnclosureIndicatorLED : Off EnclosureModel : EnclosureUUID : BayNumber : 3 BaysConsumedHeight : 1 BaysConsumedWidth : 1 Firmware : HPE.iLO.Response.Redfish.ChassisFirmware Images : OnboardAdministrator : Location : MCTPEnabledOnServer : PowerAlertMode : HPE.iLO.Response.Redfish.PowerAlertMode SmartStorageBattery : SystemMaintenanceSwitches : HPE.iLO.Response.Redfish.SystemMaintenanceSwitches ChassisStatus : HPE.iLO.Response.Redfish.Status IP : 10.20.30.40 Hostname : ab.com Status : OK StatusInfo : Id : 1 AssetTag : ChassisType : Blade Description : IndicatorLED : Manufacturer : HPE Model : ProLiant BL460 Gen10 Name : Computer System Chassis PartNumber : PhysicalSecurity : SKU : BL460Gen10 SerialNumber : 2M279601TC EnclosureIndicatorLED : Off EnclosureModel : EnclosureUUID : BayNumber : 3 BaysConsumedHeight : 1 BaysConsumedWidth : 1 Firmware : HPE.iLO.Response.Redfish.ChassisFirmware Images : OnboardAdministrator : Location : MCTPEnabledOnServer : PowerAlertMode : HPE.iLO.Response.Redfish.PowerAlertMode SmartStorageBattery : SystemMaintenanceSwitches : HPE.iLO.Response.Redfish.SystemMaintenanceSwitches ChassisStatus : HPE.iLO.Response.Redfish.Status IP : 10.20.30.50 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $obj[0].ChassisStatus Health State HealthRollUp ------ ----- ------------ OK Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with an array of iLO connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOChassisPowerCalibrationData</command:name> <maml:description> <maml:para>Gets the Apollo chassis power calibration data.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOChassisPowerCalibrationData</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlets gets detailed calibration data of the Apollo chassis server on iLO 5 only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOChassisPowerCalibrationData</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.ChassisPowerCalibrationData[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\Windows\system32> $con = Connect-HPEiLO 192.168.10.28 admin admin123 -DisableCertificateAuthentication PS C:\Windows\system32>$data = $con | Get-HPEiLOChassisPowerCalibrationData CalibrationInProgress : False CalibrationData : HPE.iLO.Response.Redfish.CalibrationData IP : 192.168.10.28 Hostname : xl170r-01gen10.powershvpn.com Status : OK StatusInfo : PS C:\Windows\system32> $data.CalibrationData EndTime : 2017-01-19 07:30:07 StartTime : 2017-01-19 07:28:57 State : True ZoneNumber : 2 ThrottlePeakPower : HPE.iLO.Response.Redfish.ThrottlePeakPower PS C:\Windows\system32> $data.CalibrationData.ThrottlePeakPower | ft Percent_000 Percent_005 Percent_010 Percent_015 Percent_020 Percent_025 Percent_030 Percent_035 Percent_040 Percent_045 ----------- ----------- ----------- ----------- ----------- ----------- ----------- ----------- ----------- ----------- 31 30 30 29 29 29 29 28 28 28</dev:code> <dev:remarks> <maml:para>Gets calibration data on iLO 5 Apollo chassis server</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPEiLOChassisPowerCalibrationConfiguration</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-HPEiLOChassisPowerCapSetting</command:name> <maml:description> <maml:para>Gets Apollo Chassis power cap settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOChassisPowerCapSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet gets the chassis power cap settings information and is supported only on Apollo series iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOChassisPowerCapSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.PowerCapSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$con = Connect-HPEiLO 192.168.10.28 admin admin123 -DisableCertificateAuthentication -Verbose PS C:\Windows\system32> $chasis = $con | get-hpeiloChassisPowerCapSetting PS C:\Windows\system32> $chasis IP : 192.168.10.28 Hostname : xl170r-01gen10.powershvpn.com Status : OK StatusInfo : ActualPowerLimits : {HPE.iLO.Response.Redfish.ActualPowerLimits, HPE.iLO.Response.Redfish.ActualPowerLimits, HPE.iLO.Response.Redfish.ActualPowerLimits, HPE.iLO.Response.Redfish.ActualPowerLimits} PowerLimitRanges : {HPE.iLO.Response.Redfish.PowerLimitRanges, HPE.iLO.Response.Redfish.PowerLimitRanges, HPE.iLO.Response.Redfish.PowerLimitRanges, HPE.iLO.Response.Redfish.PowerLimitRanges} PowerLimits : {HPE.iLO.Response.Redfish.PowerLimits, HPE.iLO.Response.Redfish.PowerLimits, HPE.iLO.Response.Redfish.PowerLimits, HPE.iLO.Response.Redfish.PowerLimits} PS C:\Windows\system32> $chasis.ActualPowerLimits PowerLimitInWatts ZoneNumber ----------------- ---------- 6 0 200 1 300 2 400 3 PS C:\Windows\system32> $chasis.PowerLimitRanges MaximumPowerLimit MinimumPowerLimit ZoneNumber ----------------- ----------------- ---------- 1562 965 0 0 0 1 404 108 2 404 108 3 PS C:\Windows\system32> $chasis.PowerLimits PowerLimitInWatts ZoneNumber ----------------- ---------- 1200 0 200 1 300 2 400 3</dev:code> <dev:remarks> <maml:para>Gets chassis power cap settings on iLO 5.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOChassisPowerCapSetting</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-HPEiLOChassisPowerNodeInfo</command:name> <maml:description> <maml:para>Gets Apollo chassis server Power Node information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOChassisPowerNodeInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlets contains the node configuration for each node of an Apollo chassis server platform only on an iLO5 target.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOChassisPowerNodeInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.ChassisPowerNodeInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\Windows\system32> $con = Connect-HPEiLO 192.168.10.34 admin admin123 -DisableCertificateAuthentication PS C:\Windows\system32> $nod = $con | Get-HPEiLOChassisPowerNodeInfo PS C:\Windows\system32> $nod MaxSupportedNodes : 4 NodeInfoList : {HPE.iLO.Response.Redfish.NodeInfoList, HPE.iLO.Response.Redfish.NodeInfoList} IP : 192.168.10.34 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo : PS C:\Windows\system32> $nod.NodeInfoList NodeNumber Throttle WarningStatus ---------- -------- ------------- 1 0 False 2 0 False</dev:code> <dev:remarks> <maml:para>Gets Apollo server node information on an iLO 5 Apollo server.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOChassisPowerRegulatorSetting</command:name> <maml:description> <maml:para>Gets Apollo chassis Power regulator settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOChassisPowerRegulatorSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets Apollo chassis Power regulator settings and works only on Apollo iLO 5 servers. Determines whether the EEPROM save is enabled or disabled and whether power regulation is enabled or disabled. Power regulation displays the following values : 1) ACRedundancy: AC Redundancy with Throttling Mode (Max Performance w/ Redundancy) 2) FullACDCRedundancy: Full AC/DC Redundancy Mode 3) UserConfig: User Configurable Mode 4) APM: APM Power Regulator Mode. Cannot be configured by iLO 5) PowerFeedProtect: Power Feed Protection Mode</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOChassisPowerRegulatorSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.ChassisPowerRegulatorSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$con34 = Connect-HPEiLO 192.168.10.34 admin admin123 -DisableCertificateAuthentication PS C:\Windows\system32> $con34 | Get-HPEiLOChassisPowerRegulatorSetting EEPROMSaveEnabled : Yes PowerRegulationEnabled : No PowerRegulatorMode : ACRedundancyiwthThrottlingMode IP : 192.168.10.34 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>Gets chassis power regulator settings.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOChassisPowerRegulatorSetting</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-HPEiLOChassisPowerZoneConfiguration</command:name> <maml:description> <maml:para>Gets Apollo chassis server Power Zone configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOChassisPowerZoneConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmlet gets power zone configuration on the Apollo chassis server platform. It is supported only on iLO 5 Apollo servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOChassisPowerZoneConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.ChassisPowerZoneConfiguration[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>PowerZonePriority</maml:title> <maml:alert> <maml:para>The power regulation zone priority, the range must between 1 - 5. 5 is default and the lowest priority.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\Windows\system32> $con = Connect-HPEiLO 10.20.30.40 admin admin123 -DisableCertificateAuthentication -Verbose PS C:\Windows\system32> $z = $con | Get-HPEiLOChassisPowerZoneConfiguration PS C:\Windows\system32> $z Zone : {HPE.iLO.Response.Redfish.Zone, HPE.iLO.Response.Redfish.Zone} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\Windows\system32> $z.Zone Node ZoneNumber ZonePriority ---- ---------- ------------ {HPE.iLO.Response.Redfish.Node} 1 5 {HPE.iLO.Response.Redfish.Node} 2 5 PS C:\Windows\system32> $z.Zone.Node NodeNumber NodePriority ---------- ------------ 1 5 3 5</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\Windows\system32>$con = Connect-HPEiLO 10.20.30.40,10.20.30.50 admin admin123 -DisableCertificateAuthentication -Verbose PS C:\Windows\system32> $z = ,$con | Get-HPEiLOChassisPowerZoneConfiguration PS C:\Windows\system32> $z Zone : {HPE.iLO.Response.Redfish.Zone, HPE.iLO.Response.Redfish.Zone} IP : 10.20.30.40 Hostname : ab.com Status : OK StatusInfo : Zone : {HPE.iLO.Response.Redfish.Zone, HPE.iLO.Response.Redfish.Zone} IP : 10.20.30.50 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with an array of iLO connection objects passed as pipeline parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOComputerLockConfiguration</command:name> <maml:description> <maml:para>Gets the Computer lock configuration information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOComputerLockConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOComputerLockConfiguration gets the Computer lock configuration information. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOComputerLockConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.ComputerLockConfiguration[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOComputerLockConfiguration LockType : Custom KeySequence : {', `, =, PG_UP...} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOComputerLockConfiguration -Connection $connection LockType : Custom KeySequence : {', `, =, PG_UP...} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : LockType : Disabled KeySequence : IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOCriticalTemperatureAction</command:name> <maml:description> <maml:para>Retrieves the configured critical temperature shutdown behavior of the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOCriticalTemperatureAction</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOCriticalTemperatureAction cmdlet retrieves the configured critical temperature shutdown behavior of the server. This cmdlet is supported only on iLO 4 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOCriticalTemperatureAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.CriticalTemperatureAction[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOCriticalTemperatureAction RebootAfterShutdown : Yes IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOCriticalTemperatureAction -Connection $connection RebootAfterShutdown : Yes IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : RebootAfterShutdown : No IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOCriticalTemperatureAction</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLODeviceDiscoveryStatus</command:name> <maml:description> <maml:para>Retrieves the device discovery status of the iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLODeviceDiscoveryStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLODeviceDiscoveryStatus retrieves the device discovery status of the iLO. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLODeviceDiscoveryStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.DeviceDiscoveryStatus[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLODeviceDiscoveryStatus AMSDeviceDiscovery : NoAMS DeviceDiscovery : vMainDeviceDiscoveryComplete SmartArrayDiscovery : Complete IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLODeviceDiscoveryStatus -Connection $connection AMSDeviceDiscovery : NoAMS DeviceDiscovery : vMainDeviceDiscoveryComplete SmartArrayDiscovery : Complete IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : AMSDeviceDiscovery : NoAMS DeviceDiscovery : vMainDeviceDiscoveryComplete SmartArrayDiscovery : Complete IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLODeviceInventory</command:name> <maml:description> <maml:para>Gets the device inventory detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLODeviceInventory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLODeviceInventory cmdlet gets the device inventory detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLODeviceInventory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.IMLInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>Enable device discovery using the Enable-HPEiLOMCTP setting cmdlet.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLODeviceInventory PS C:\> $out Devices : {HPE.iLO.Response.Redfish.DeviceInfo, HPE.iLO.Response.Redfish.DeviceInfo, HPE.iLO.Response.Redfish.DeviceInfo, HPE.iLO.Response.Redfish.DeviceInfo...} MCTPEnabledOnServer : True IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.Devices DeviceType : Unknown FirmwareVersion : HPE.iLO.Response.Redfish.Firmwareversion Location : Embedded LOM Manufacturer : Name : Empty PartNumber : ProductPartNumber : ProductVersion : SerialNumber : Status : HPE.iLO.Response.Redfish.Status MCTPProtocolDisabled : False DeviceType : Smart Storage Battery FirmwareVersion : HPE.iLO.Response.Redfish.Firmwareversion Location : Embedded Device Manufacturer : STL Name : HPE Smart Storage Battery PartNumber : 871264-001 ProductPartNumber : 727258-B21 ProductVersion : 01 SerialNumber : 6WEJD0JB2887BD Status : HPE.iLO.Response.Redfish.Status MCTPProtocolDisabled : False DeviceType : LOM/NIC FirmwareVersion : HPE.iLO.Response.Redfish.Firmwareversion Location : Embedded LOM Manufacturer : Name : HPE Ethernet 1Gb 4-port 331i Adapter - NIC PartNumber : ProductPartNumber : ProductVersion : SerialNumber : Status : HPE.iLO.Response.Redfish.Status MCTPProtocolDisabled : False DeviceType : Smart Storage FirmwareVersion : HPE.iLO.Response.Redfish.Firmwareversion Location : Embedded RAID Manufacturer : Name : HPE Smart Array P816i-a SR Gen10 PartNumber : ProductPartNumber : ProductVersion : SerialNumber : Status : HPE.iLO.Response.Redfish.Status MCTPProtocolDisabled : False DeviceType : Unknown FirmwareVersion : HPE.iLO.Response.Redfish.Firmwareversion Location : PCI-E Slot 1 Manufacturer : Name : Empty slot 1 PartNumber : ProductPartNumber : ProductVersion : SerialNumber : Status : HPE.iLO.Response.Redfish.Status MCTPProtocolDisabled : False DeviceType : Unknown FirmwareVersion : HPE.iLO.Response.Redfish.Firmwareversion Location : PCI-E Slot 2 Manufacturer : Name : Empty slot 2 PartNumber : ProductPartNumber : ProductVersion : SerialNumber : Status : HPE.iLO.Response.Redfish.Status MCTPProtocolDisabled : False</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEiLODeviceInventory -Connection $connection Devices : {HPE.iLO.Response.Redfish.DeviceInfo, HPE.iLO.Response.Redfish.DeviceInfo, HPE.iLO.Response.Redfish.DeviceInfo, HPE.iLO.Response.Redfish.DeviceInfo...} MCTPEnabledOnServer : True IP : 10.20.30.1 Hostname : xyz.com Status : OK StatusInfo : Devices : {HPE.iLO.Response.Redfish.DeviceInfo, HPE.iLO.Response.Redfish.DeviceInfo, HPE.iLO.Response.Redfish.DeviceInfo, HPE.iLO.Response.Redfish.DeviceInfo...} MCTPEnabledOnServer : True IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEiLOMCTP</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEiLOMCTP</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-HPEiLODirectoryGroup</command:name> <maml:description> <maml:para>Gets the Directory Group user information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLODirectoryGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLODirectoryGroup gets the Directory Group information. This cmdlet is supported on iLO 4 and iLO5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLODirectoryGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.DirectoryGroupInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLODirectorySetting PS C:\> $out GroupAccountInfo : {Administrators, Authenticated Users} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.GroupAccountInfo GroupName : Administrators GroupSID : iLOConfigPrivilege : Yes LoginPrivilege : Yes RemoteConsolePrivilege : Yes UserConfigPrivilege : Yes VirtualPowerAndResetPrivilege : Yes VirtualMediaPrivilege : Yes GroupName : Authenticated Users GroupSID : S-1-5-11 iLOConfigPrivilege : No LoginPrivilege : Yes RemoteConsolePrivilege : No UserConfigPrivilege : No VirtualPowerAndResetPrivilege : No VirtualMediaPrivilege : No</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLODirectoryGroup -Connection $connection GroupAccountInfo : {Administrators, Authenticated Users} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : GroupAccountInfo : {Administrators, Authenticated Users} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$con = Connect-HPEiLO 192.168.10.31 admin admin123 -DisableCertificateAuthentication $dg = $con | Get-HPEiLODirectoryGroup PS C:\Windows\System32\WindowsPowerShell\v1.0> $dg GroupAccountInfo : {HPE.iLO.Response.Redfish.GroupAccountInfo} IP : 192.168.10.31 Hostname : bl460cgen10-03.powershvpn.com Status : OK StatusInfo : PS C:\Windows\System32\WindowsPowerShell\v1.0> $dg.GroupAccountInfo GroupName : tg5 GroupSID : iLOConfigPrivilege : Yes LoginPrivilege : Yes RemoteConsolePrivilege : Yes UserConfigPrivilege : Yes VirtualPowerAndResetPrivilege : Yes VirtualMediaPrivilege : Yes HostBIOSConfigPrivilege : Yes HostNICConfigPrivilege : Yes HostStorageConfigPrivilege : Yes SystemRecoveryConfigPrivilege : No</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO5 with an iLO connection.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLODirectoryGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLODirectoryGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLODirectoryGroup</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-HPEiLODirectorySetting</command:name> <maml:description> <maml:para>Gets the Directory Setting detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLODirectorySetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLODirectorySetting gets the Directory Setting detail. This cmdlet is supported on iLO 4 and iLO5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLODirectorySetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.DirectorySettingInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPE.iLO.Response.Redfish.DirectorySettingInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLODirectorySetting PS C:\> $out[0] DirectoryServerAddress : DirectoryServerPort : 636 GenericLDAPEnabled : No LDAPDirectoryAuthentication : Disabled LocalUserAccountEnabled : Yes LOMObjectDN : UserContextInfo : {HPE.iLO.Response.RIBCL.UserContextInfo, HPE.iLO.Response.RIBCL.UserContextInfo, HPE.iLO.Response.RIBCL.UserContextInfo, HPE.iLO.Response.RIBCL.UserContextInfo...} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out[1] DirectoryServerAddress : DirectoryServerPort : 236 GenericLDAPEnabled : Yes LDAPDirectoryAuthentication : DefaultSchema LocalUserAccountEnabled : Yes LOMObjectDN : ldapuser UserContext : {CN=iLOUser,DC=powershvpn, DC=com} IP : 10.20.30.41 Hostname : bl460cgen10-03.powershvpn.com Status : OK StatusInfo : PS C:\> $out[0].UserContextInfo | fl UserContextIndex : 1 UserContext : UserContextIndex : 2 UserContext : UserContextIndex : 3 UserContext : UserContextIndex : 4 UserContext : UserContextIndex : 5 UserContext : UserContextIndex : 6 UserContext : UserContextIndex : 7 UserContext : UserContextIndex : 8 UserContext : UserContextIndex : 9 UserContext : UserContextIndex : 10 UserContext : UserContextIndex : 11 UserContext : UserContextIndex : 12 UserContext : UserContextIndex : 13 UserContext : UserContextIndex : 14 UserContext : UserContextIndex : 15 UserContext :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO4 and iLO5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLODirectorySetting -Connection $connection DirectoryServerAddress : DirectoryServerPort : 636 GenericLDAPEnabled : No LDAPDirectoryAuthentication : Disabled LocalUserAccountEnabled : Yes LOMObjectDN : UserContextInfo : {HPE.iLO.Response.RIBCL.UserContextInfo, HPE.iLO.Response.RIBCL.UserContextInfo, HPE.iLO.Response.RIBCL.UserContextInfo, HPE.iLO.Response.RIBCL.UserContextInfo...} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : DirectoryServerAddress : DirectoryServerPort : 636 GenericLDAPEnabled : No LDAPDirectoryAuthentication : Disabled LocalUserAccountEnabled : Yes LOMObjectDN : UserContextInfo : {HPE.iLO.Response.RIBCL.UserContextInfo, HPE.iLO.Response.RIBCL.UserContextInfo, HPE.iLO.Response.RIBCL.UserContextInfo, HPE.iLO.Response.RIBCL.UserContextInfo...} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO4 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.41 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLODirectorySetting PS C:\> $out DirectoryServerAddress : DirectoryServerPort : 236 GenericLDAPEnabled : Yes LDAPDirectoryAuthentication : DefaultSchema LocalUserAccountEnabled : Yes LOMObjectDN : ldapuser UserContext : {CN=iLOUser,DC=powershvpn, DC=com} IP : 10.20.30.41 Hostname : bl460cgen10-03.powershvpn.com Status : OK StatusInfo : PS C:\> $out.UserContext CN=iLOUser,DC=powershvpn, DC=com</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLODirectorySetting</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-HPEiLODirectorySettingTestResult</command:name> <maml:description> <maml:para>Gets the Directory Setting Test Result.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLODirectorySettingTestResult</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLODirectorySettingTestResult cmdlet gets the Directory Setting Test Result. This cmdlet is supported on iLO 4 and iLO5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLODirectorySettingTestResult</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.iLO4.DirectoryGroupInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>HPE.iLO.Response.Redfish.DirectoryGroupInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLODirectorySettingTestResult PS C:\> $out DirectoryTestResult : {HPE.iLO.Response.RIBCL.TestResult, HPE.iLO.Response.RIBCL.TestResult, HPE.iLO.Response.RIBCL.TestResult, HPE.iLO.Response.RIBCL.TestResult...} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.DirectoryTestResult | fl Test : DirectoryServerDNSName Status : Failed Description : Unable to resolve host name Test : PingDirectoryServer Status : Failed Description : Test : ConnectToDirectoryServer Status : Failed Description : Unable to connect to the directory server LDAP port within timeout. Verify directory server address. Test : ConnectUsingSSL Status : Failed Description : Unable to connect to directory server within timeout. Test : BindTODirectoryServer Status : Failed Description : Test : DirectoryAdministratorLogin Status : Failed Description : Test : UserAuthentication Status : Failed Description : Unable to authenticate test user admin [Internal Error] Test : UserAuthorization Status : Failed Description : Test : DirectoryUserContexts Status : Not Run Description : Test : LOMObjectExists Status : Not Run Description :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLODirectorySettingTestResult -Connection $connection DirectoryTestResult : {HPE.iLO.Response.RIBCL.TestResult, HPE.iLO.Response.RIBCL.TestResult, HPE.iLO.Response.RIBCL.TestResult, HPE.iLO.Response.RIBCL.TestResult...} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : DirectoryTestResult : {HPE.iLO.Response.RIBCL.TestResult, HPE.iLO.Response.RIBCL.TestResult, HPE.iLO.Response.RIBCL.TestResult, HPE.iLO.Response.RIBCL.TestResult...} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $con = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $test = $con | Get-HPEiLODirectorySettingTestResult PS C:\> $test DirectoryTestResult : {HPE.iLO.Response.Redfish.TestResult, HPE.iLO.Response.Redfish.TestResult, HPE.iLO.Response.Redfish.TestResult, HPE.iLO.Response.Redfish.TestResult...} OverallStatus : Failed IP : 192.168.10.31 Hostname : bl460cgen10-03.powershvpn.com Status : OK StatusInfo : PS C:\> $test.DirectoryTestResult Test Status Description ---- ------ ----------- DirectoryServerDNSName Failed Unable to resolve host name PingDirectoryServer Failed ConnectToDirectoryServer Failed Unable to connect to the directory server LDAP port within timeout. Verify directory server address. ConnectUsingSSL Failed Unable to connect to directory server within timeout. BindToDirectoryServer NotRun DirectoryAdministratorLogin NotRun UserAuthentication NotRun UserAuthorization Failed DirectoryUserContexts NotRun LOMObjectExists NotRun</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPEiLODirectorySettingTest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-HPEiLODirectorySettingTest</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-HPEiLOEmbeddedMedia</command:name> <maml:description> <maml:para>Gets the EmbeddedMedia information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOEmbeddedMedia</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOEmbeddedMedia gets EmbeddedMedia information.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOEmbeddedMedia</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.iLO4.EmbeddedMedia[] or HPE.iLO.Response.Redfish.EmbeddedMedia[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOEmbeddedMedia PS C:\> $out SDCard : HPE.iLO.Response.RIBCL.iLO 4.SDCard IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $out.SDCard | fl Status : Absent</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOEmbeddedMedia PS C:\> $out SDCard : HPE.iLO.Response.Redfish.SDCard Controller : HPE.iLO.Response.Redfish.Controller IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $out.SDCard | fl Status : Absent SizeMB : PS C:\> $out.Controller | fl CurrentFirmwareVersion : 02.10.00 Health : OK State : Enabled</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOEmbeddedMedia -Connection $connection SDCard : HPE.iLO.Response.RIBCL.iLO 4.SDCard IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo : SDCard : HPE.iLO.Response.Redfish.SDCard Controller : HPE.iLO.Response.Redfish.Controller IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOEncryptionSetting</command:name> <maml:description> <maml:para>Gets the current Security encryption setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOEncryptionSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOEncryptionSetting cmdlet gets the current Security encryption setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOEncryptionSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Objects</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Objects</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.EncryptionSetting[] or HPE.iLO.Response.Redfish.EncryptionSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOEncryptionSetting SecurityState : FIPS IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOEncryptionSetting -Connection $connection SecurityState : Production SupportedSecurityState : {Production, HighSecurity, FIPS} CurrentEncryptionCipher : ECDHE-RSA-AES256-SHA384 IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20,30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOEncryptionSetting SecurityState : FIPS IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : SecurityState : Production SupportedSecurityState : {Production, HighSecurity, FIPS} CurrentEncryptionCipher : ECDHE-RSA-AES256-SHA384 IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOEncryptionSetting</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-HPEiLOESKMSetting</command:name> <maml:description> <maml:para>Gets the Enterprise Secure Key Manager (ESKM) setting information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOESKMSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOESKMSetting cmdlet displays the Enterprise Secure Key Manager (ESKM) settings configured in iLO for the specified server.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOESKMSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.ESKMSetting[] or HPE.iLO.Response.Redfish.ESKMSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOESKMSetting PS C:\> $out AccountGroup : posidongroup AccountName : ilo-fc15b4972d88 EnableRedundancy : No ESKMLocalCACertificateName : Local CA ImportedCertificateIssuer : /C=US/ST=TX/L=Houston/O=HP/OU=ISS/CN=Local CA/emailAddress=support@hpe.com ImportedCertificateSubject : /C=US/ST=TX/L=Houston/O=HP/OU=ISS/CN=Local CA/emailAddress=support@hpe.com PrimaryKeyServerAddress : 15.114.233.81 PrimaryKeyServerPort : 9444 SecondaryKeyServerAddress : 15.114.233.82 SecondaryKeyServerPort : 9444 IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOESKMSetting PS C:\> $out AccountGroup : posidongroup AccountName : ilo-fc15b4972d88 EnableRedundancy : No ESKMLocalCACertificateName : Local CA ImportedCertificateIssuer : /C=US/ST=TX/L=Houston/O=HP/OU=ISS/CN=Local CA/emailAddress=support@hpe.com ImportedCertificateSubject : /C=US/ST=TX/L=Houston/O=HP/OU=ISS/CN=Local CA/emailAddress=support@hpe.com PrimaryKeyServerAddress : 15.114.233.81 PrimaryKeyServerPort : 9444 SecondaryKeyServerAddress : 15.114.233.82 SecondaryKeyServerPort : 9444 ESKMEventLog : {HPE.iLO.Response.Redfish.ESKMEventLog, HPE.iLO.Response.Redfish.ESKMEventLog, HPE.iLO.Response.Redfish.ESKMEventLog, HPE.iLO.Response.Redfish.ESKMEventLog...} IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.ESKMEventLog | fl Event : iLO account ilo-fc15b4972d88 verified Timestamp : 2017-05-27T14:49:58Z Event : Account ilo-fc15b4972d88 is already a member of posidongroup. Timestamp : 2017-05-27T14:49:59Z Event : Requested group name does not match existing group name. Will use existing group name posidongroup. Timestamp : 2017-05-27T14:49:59Z Event : ESKM server at 15.114.233.81:9444 is accessible Timestamp : 2017-05-27T14:50:14Z Event : ESKM server at 15.114.233.82:9444 is accessible Timestamp : 2017-05-27T14:50:16Z Event : ESKM server at 15.114.233.81:9444 is accessible Timestamp : 2017-05-27T14:50:50Z</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOESKMSetting -Connection $connection AccountGroup : posidongroup AccountName : ilo-fc15b4972d88 EnableRedundancy : No ESKMLocalCACertificateName : Local CA ImportedCertificateIssuer : /C=US/ST=TX/L=Houston/O=HP/OU=ISS/CN=Local CA/emailAddress=support@hpe.com ImportedCertificateSubject : /C=US/ST=TX/L=Houston/O=HP/OU=ISS/CN=Local CA/emailAddress=support@hpe.com PrimaryKeyServerAddress : 15.114.233.81 PrimaryKeyServerPort : 9444 SecondaryKeyServerAddress : 15.114.233.82 SecondaryKeyServerPort : 9444 IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : AccountGroup : posidongroup AccountName : ilo-fc15b4972d88 EnableRedundancy : No ESKMLocalCACertificateName : Local CA ImportedCertificateIssuer : /C=US/ST=TX/L=Houston/O=HP/OU=ISS/CN=Local CA/emailAddress=support@hpe.com ImportedCertificateSubject : /C=US/ST=TX/L=Houston/O=HP/OU=ISS/CN=Local CA/emailAddress=support@hpe.com PrimaryKeyServerAddress : 15.114.233.81 PrimaryKeyServerPort : 9444 SecondaryKeyServerAddress : 15.114.233.82 SecondaryKeyServerPort : 9444 ESKMEventLog : {HPE.iLO.Response.Redfish.ESKMEventLog, HPE.iLO.Response.Redfish.ESKMEventLog, HPE.iLO.Response.Redfish.ESKMEventLog, HPE.iLO.Response.Redfish.ESKMEventLog...} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOESKMSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-HPEiLOESKMConnection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOESKMLog</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-HPEiLOEventLog</command:name> <maml:description> <maml:para>Gets the iLO event logs.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOEventLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOEventLog cmdlet gets the iLO event logs. The response includes all of the events recorded in the order that they occurred. Events are not sorted by severity or other criteria. Each event includes a common set of attributes: · Severity - Indicates the importance of the error and how it might impact server or iLO availability: -> FAILED - Indicates a problem or component failure that might impact operational time if it is not addressed. -> CAUTION - Indicates an event that is not expected during normal system operation. This might not indicate a platform issue. -> DEGRADED - Indicates the device or subsystem is operating at a reduced capacity. -> REPAIRED - Indicates that an event or component failure has been addressed. -> INFORMATIONAL - Indicates that something noteworthy occurred, but operational time is not impacted. -> OK - Indicates that nothing noteworthy occurred.</maml:para> <maml:para>· Created - Indicates when this event first occurred.</maml:para> <maml:para>. Id - Indicates an identifier for the resource (available only on Gen10 and above).</maml:para> <maml:para>. Name - Indicates the name of the resource or array element (available only on Gen10 and above).</maml:para> <maml:para>. EntryType - Indicates the log entry type (available only on Gen10 and above).</maml:para> <maml:para>· Source - Indicates the subsystem that generated the event, and can include iLO, environment, power, system error, rack infrastructure, and more.</maml:para> <maml:para>· Updated - Indicates the most recent time this event was modified.</maml:para> <maml:para>. EventCode - Indicates the hexadecimal event code.</maml:para> <maml:para>. Categories - Indicates the log entry categories (available only on Gen10 and above).</maml:para> <maml:para>. Class - Indicates the event class (available only on Gen10 and above).</maml:para> <maml:para>. ClassDescription - Indicates the event class description(available only on Gen10 and above).</maml:para> <maml:para>. EventNumber - Indicates event log identification number. Events are numbered in the order in which they are generated (available only on Gen10 and above).</maml:para> <maml:para>. LearnMoreLink - Indicates the HPSC link for troubleshooting information (available only on Gen10 and above).</maml:para> <maml:para>. RecommendedAction - Indicates the recommended action for the event (available only on Gen10 and above).</maml:para> <maml:para>· Count - Indicates the number of times a duplicate event happened.</maml:para> <maml:para>· Message - Indicates the nature of the event and all recorded details.</maml:para> <maml:para>. OemRecordFormat - Indicates the format of an OEM record (available only on Gen10 and above).</maml:para> <maml:para>. Repaired - Indicates the repaired status of the IML event.</maml:para> <maml:para>. Destination- The destination host name or IP address of the remote server that received the service event (available only on Gen10 and above).</maml:para> <maml:para>. SubmitStatus- The service event log submission status.(available only on Gen10 and above).</maml:para> <maml:para>. UserAction- Indicates the user action for the event.(available only on Gen10 and above).</maml:para> <maml:para>. Identifier - The unique identifier of the service event (available only on Gen10 and above).</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOEventLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]System.String</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>HPE.iLO.Response.RIBCL.EventLogInfo[] or HPE.iLO.Response.Redfish.EventLogInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOEventLog PS C:\> $obj Description : iLO 4 Event Log EventLog : {HPE.iLO.Response.RIBCL.LogEntry, HPE.iLO.Response.RIBCL.LogEntry, HPE.iLO.Response.RIBCL.LogEntry, HPE.iLO.Response.RIBCL.LogEntry...} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $obj.EventLog Count : 3 Created : 04/06/2001 00:18 EventCode : 144 Message : XML login: admin - 15.146.44.58 (DNS name not found). Severity : Informational Source : #ILO 4 Updated : 04/06/2001 00:18 Count : 3 Created : 04/06/2001 00:18 EventCode : 145 Message : XML logout: admin - 15.146.44.58(DNS name not found). Severity : Informational Source : #ILO 4 Updated : 04/06/2001 00:18</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOEventLog PS C:\> $obj Description : iLO Event Logs view EventLog : {HPE.iLO.Response.Redfish.LogEntry, HPE.iLO.Response.Redfish.LogEntry, HPE.iLO.Response.Redfish.LogEntry, HPE.iLO.Response.Redfish.LogEntry...} IP : 10.20.30.40 Hostname : xyz.example.com Status : OK PS C:\> $obj.EventLog Id : 1 Name : iLO Event Log Categories : {Security, Administration} EntryType : Oem EventNumber : 10278 OemRecordFormat : Hpe-iLOEventLog LearnMoreLink : RecommendedAction : Repaired : Destination : Count : 3 Created : 2017-04-04T15:22:06Z EventCode : 1017 Class : 35 ClassDescription : Maintenance Message : Browser login: admin - 16.85.88.14(DNS name not found). Severity : OK Updated : 2017-04-04T15:22:28Z UserAction : SubmitStatus : Identifier : Id : 2 Name : iLO Event Log Categories : {Security, Administration} EntryType : Oem EventNumber : 10279 OemRecordFormat : Hpe-iLOEventLog LearnMoreLink : RecommendedAction : Repaired : Destination : Count : 3 Created : 2017-04-04T15:22:06Z EventCode : 1018 Class : 35 ClassDescription : Maintenance Message : Browser logout: admin - 16.85.88.14(DNS name not found). Severity : OK Updated : 2017-04-04T15:22:28Z UserAction : SubmitStatus : Identifier :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOEventLog PS C:\> $obj Description : iLO 4 Event Log EventLog : {HPE.iLO.Response.RIBCL.LogEntry, HPE.iLO.Response.RIBCL.LogEntry, HPE.iLO.Response.RIBCL.LogEntry, HPE.iLO.Response.RIBCL.LogEntry...} IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo : Description : iLO Event Logs view EventLog : {HPE.iLO.Response.Redfish.LogEntry, HPE.iLO.Response.Redfish.LogEntry, HPE.iLO.Response.Redfish.LogEntry, HPE.iLO.Response.Redfish.LogEntry...} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOEventLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOFan</command:name> <maml:description> <maml:para>Gets the Fan health details from the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOFan</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOFan cmdlet gets the Fan health details of the server. The details are returned for the list of fans.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOFan</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.FanInformation[] or HPE.iLO.Response.Redfish.FanInformation[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOFan PS C:\> $obj | fl Fans : {HPE.iLO.Response.RIBCL.Fan, HPE.iLO.Response.RIBCL.Fan, HPE.iLO.Response.RIBCL.Fan, HPE.iLO.Response.RIBCL.Fan...} IP : 10.20.30.2 Status : OK StatusInfo : PS C:\> $obj.Fans Name : Fan 1 Location : System SpeedPercentage : 21 Status : OK Name : Fan 2 Location : System SpeedPercentage : 21 Status : OK Name : Fan 3 Location : System SpeedPercentage : 21 Status : OK Name : Fan 4 Location : System SpeedPercentage : 21 Status : OK Name : Fan 5 Location : System SpeedPercentage : 21 Status : OK Name : Fan 6 Location : System SpeedPercentage : 21 Status : OK Name : Fan 7 Location : System SpeedPercentage : 21 Status : OK Name : Fan 8 Location : System SpeedPercentage : 21 Status : OK Name : Fan 9 Location : System SpeedPercentage : 21 Status : OK Name : Fan 10 Location : System SpeedPercentage : 21 Status : OK</dev:code> <dev:remarks> <maml:para>This example shows the usage of the cmdlet on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.3 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOFan PS C:\> $obj | fl Fans : {HPE.iLO.Response.Redfish.Fan, HPE.iLO.Response.Redfish.Fan, HPE.iLO.Response.Redfish.Fan, HPE.iLO.Response.Redfish.Fan...} IP : 10.20.30.3 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $obj.Fans HotPluggable : Yes Redundant : No CorrelatableID : LowerThresholdCritical : LowerThresholdFatal : LowerThresholdNonCritical : MaximumValue : MinimumValue : PhysicalContext : UpperThresholdCritical : UpperThresholdFatal : UpperThresholdNonCritical : Name : Fan 1 Location : System SpeedPercentage : 13 Status : OK HotPluggable : Yes Redundant : No CorrelatableID : LowerThresholdCritical : LowerThresholdFatal : LowerThresholdNonCritical : MaximumValue : MinimumValue : PhysicalContext : UpperThresholdCritical : UpperThresholdFatal : UpperThresholdNonCritical : Name : Fan 2 Location : System SpeedPercentage : 13 Status : OK HotPluggable : Yes Redundant : Yes CorrelatableID : LowerThresholdCritical : LowerThresholdFatal : LowerThresholdNonCritical : MaximumValue : MinimumValue : PhysicalContext : UpperThresholdCritical : UpperThresholdFatal : UpperThresholdNonCritical : Name : Fan 3 Location : System SpeedPercentage : 13 Status : OK HotPluggable : Yes Redundant : Yes CorrelatableID : LowerThresholdCritical : LowerThresholdFatal : LowerThresholdNonCritical : MaximumValue : MinimumValue : PhysicalContext : UpperThresholdCritical : UpperThresholdFatal : UpperThresholdNonCritical : Name : Fan 4 Location : System SpeedPercentage : 13 Status : OK HotPluggable : Yes Redundant : Yes CorrelatableID : LowerThresholdCritical : LowerThresholdFatal : LowerThresholdNonCritical : MaximumValue : MinimumValue : PhysicalContext : UpperThresholdCritical : UpperThresholdFatal : UpperThresholdNonCritical : Name : Fan 5 Location : System SpeedPercentage : 13 Status : OK HotPluggable : Yes Redundant : Yes CorrelatableID : LowerThresholdCritical : LowerThresholdFatal : LowerThresholdNonCritical : MaximumValue : MinimumValue : PhysicalContext : UpperThresholdCritical : UpperThresholdFatal : UpperThresholdNonCritical : Name : Fan 6 Location : System SpeedPercentage : 13 Status : OK</dev:code> <dev:remarks> <maml:para>This example shows the usage of the cmdlet on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEiLOFan -Connection $connection | fl Fans : {HPE.iLO.Response.RIBCL.Fan} IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : Fans : {HPE.iLO.Response.RIBCL.Fan} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo : Fans : {HPE.iLO.Response.Redfish.Fan, HPE.iLO.Response.Redfish.Fan, HPE.iLO.Response.Redfish.Fan, HPE.iLO.Response.Redfish.Fan...} IP : 10.20.30.3 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the usage of the cmdlet on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOFederationGroup</command:name> <maml:description> <maml:para>Retrieves a list of all iLO Federation group names.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOFederationGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOFederationGroup cmdlet retrieves a list of all iLO Federation group names.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOFederationGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies the group whose complete privilege details have to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies the group whose complete privilege details have to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.FederationGroupList[] or HPE.iLO.Response.Redfish.FederationGroupList[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOFederationGroup PS C:\> $obj | fl FederationGroup : {HPE.iLO.Response.RIBCL.FederationGroup, HPE.iLO.Response.RIBCL.FederationGroup, HPE.iLO.Response.RIBCL.FederationGroup} IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $obj.FederationGroup GroupName : DEFAULT AdminPrivilege : No RemoteConsolePrivilege : No VirtualMediaPrivilege : No iLOConfigPrivilege : No HostBIOSConfigPrivilege : HostNICConfigPrivilege : HostStorageConfigPrivilege : LoginPrivilege : Yes SystemRecoveryConfigPrivilege : VirtualPowerAndResetPrivilege : No GroupName : testgroup AdminPrivilege : Yes RemoteConsolePrivilege : Yes VirtualMediaPrivilege : Yes iLOConfigPrivilege : Yes HostBIOSConfigPrivilege : Yes HostNICConfigPrivilege : No HostStorageConfigPrivilege : No LoginPrivilege : Yes SystemRecoveryConfigPrivilege : Yes VirtualPowerAndResetPrivilege : Yes</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $obj = Get-HPEiLOFederationGroup -Connection $connection PS C:\> $obj | fl FederationGroup : {HPE.iLO.Response.Redfish.FederationGroup, HPE.iLO.Response.Redfish.FederationGroup} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $obj.FederationGroup GroupName : DEFAULT AdminPrivilege : No RemoteConsolePrivilege : No VirtualMediaPrivilege : No iLOConfigPrivilege : No HostBIOSConfigPrivilege : Yes HostNICConfigPrivilege : Yes HostStorageConfigPrivilege : No LoginPrivilege : Yes SystemRecoveryConfigPrivilege : Yes VirtualPowerAndResetPrivilege : No GroupName : testgroup AdminPrivilege : Yes RemoteConsolePrivilege : Yes VirtualMediaPrivilege : Yes iLOConfigPrivilege : Yes HostBIOSConfigPrivilege : Yes HostNICConfigPrivilege : Yes HostStorageConfigPrivilege : No LoginPrivilege : Yes SystemRecoveryConfigPrivilege : No VirtualPowerAndResetPrivilege : Yes</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOFederationGroup PS C:\> $obj | fl FederationGroup : {HPE.iLO.Response.RIBCL.FederationGroup, HPE.iLO.Response.RIBCL.FederationGroup, HPE.iLO.Response.RIBCL.FederationGroup} IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : FederationGroup : {HPE.iLO.Response.Redfish.FederationGroup, HPE.iLO.Response.Redfish.FederationGroup} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOFederationGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOFederationGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOFederationGroup</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-HPEiLOFederationMulticast</command:name> <maml:description> <maml:para>Gets the iLO Federation status and also the iLO federation multicast options.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOFederationMulticast</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOFederationMulticast cmdlet returns information on whether iLO Federation is enabled or disabled, and iLO Federation multicast options, which include Multicast Discovery, Multicast Announcement Interval, IPv6Multicast Scope, and Multicast Time to Live (TTL).</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOFederationMulticast</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.FederationMulticast [] or HPE.iLO.Response.Redfish.FederationMulticast[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.10.10.1 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOFederationMulticast AnnouncementInterval : 30 DiscoveryAuthentication : Yes FederationManagement : Enabled MulticastScope : Organization MulticastTTL : 55 IP : 10.10.10.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.10.10.2 -Username admin -Password admin123 PS C:\> Get-HPEiLOFederationMulticast -Connection $connection AnnouncementInterval : 30 DiscoveryAuthentication : Yes FederationManagement : Enabled MulticastScope : Organization MulticastTTL : 55 IP : 10.10.10.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOFederationMulticast | fl AnnouncementInterval : 30 DiscoveryAuthentication : Yes FederationManagement : Enabled MulticastScope : Organization MulticastTTL : 55 IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : AnnouncementInterval : Disabled DiscoveryAuthentication : Yes FederationManagement : Disabled MulticastScope : Organization MulticastTTL : 55 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOFederationGroup</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-HPEiLOFederationPeer</command:name> <maml:description> <maml:para>Gets Federation Peer information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOFederationPeer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets Federation Peer inforamtion on the target iLO and is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOFederationPeer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies the group name for which user wants to fetch peer's information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies the group name for which user wants to fetch peer's information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>HPE.iLO.Response.Redfish.FederationPeers[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$con = Connect-HPEiLO 192.168.10.31 admin admin123 -DisableCertificateAuthentication -Verbose PS C:\Windows\system32> $p = $con | Get-HPEiLOFederationPeers PS C:\Windows\system32> $p Peers : {HPE.iLO.Response.Redfish.Peers} IP : 192.168.10.31 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo : PS C:\Windows\system32> $p.Peers Id Name PeerInfo -- ---- -------- DEFAULT DEFAULT {240e419f-e157-5fac-a32e-08c941ae569f, 0505df7c-f607-59f3-a498-b3c386a9b805, 53d429e2-9617-53f3-88f2-84ad6ad9bae6, e76880a7-0129-5b44-828a-46a5eb599f93} PS C:\Windows\system32> $p.Peers[0].PeerInfo HttpErrorCode : 0 ManagerIPAddress : 192.168.10.8 Time : 2018-07-03T04:29:06Z URL : http://192.168.10.8:801/ UUID : 240e419f-e157-5fac-a32e-08c941ae569f HttpErrorCode : 0 ManagerIPAddress : 192.168.10.9 Time : 2018-07-03T04:22:47Z URL : http://192.168.10.9:80/ UUID : 0505df7c-f607-59f3-a498-b3c386a9b805 HttpErrorCode : 0 ManagerIPAddress : 192.168.10.28 Time : 2018-07-03T04:29:06Z URL : http://192.168.10.28:80/ UUID : 53d429e2-9617-53f3-88f2-84ad6ad9bae6 HttpErrorCode : 0 ManagerIPAddress : 192.168.10.23 Time : 2018-07-03T04:28:47Z URL : http://192.168.10.23:80/ UUID : e76880a7-0129-5b44-828a-46a5eb599f9</dev:code> <dev:remarks> <maml:para>Gets Federation peer information on iLO 5.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\Windows\system32>$con = Connect-HPEiLO 192.168.10.34 admin admin123 -DisableCertificateAuthentication PS C:\Windows\system32>$p = $con | Get-HPEiLOFederationPeer -GroupName Test123 PS C:\Windows\system32> $p Id : Test123 Name : Test123 PeerInfo : {HPE.iLO.Response.Redfish.PeerInfo, HPE.iLO.Response.Redfish.PeerInfo, HPE.iLO.Response.Redfish.PeerInfo, HPE.iLO.Response.Redfish.PeerInfo} IP : 192.168.10.34 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo : PS C:\Windows\system32> $p.PeerInfo HttpErrorCode : 0 ManagerIPAddress : fe80::9af2:b3ff:fe37:52e6 Time : 2017-02-04T01:48:22Z URL : http://[fe80::9af2:b3ff:fe37:52e6]:80/ UUID : f31344e0-2238-5119-bb96-d1641bd850d5 HttpErrorCode : 0 ManagerIPAddress : fe80::7210:6fff:fe49:fe96 Time : 2017-02-04T01:47:43Z URL : http://[fe80::7210:6fff:fe49:fe96]:80/ UUID : d5442933-e623-505e-b8df-aec51671ac97 HttpErrorCode : 0 ManagerIPAddress : fe80::fe15:b4ff:fe97:c6c8 Time : 2017-02-04T01:48:11Z URL : http://[fe80::fe15:b4ff:fe97:c6c8]:80/ UUID : b6364d8f-9eb0-5176-afb3-59636ada4010 HttpErrorCode : 0 ManagerIPAddress : fe80::9618:82ff:fe03:3a70 Time : 2017-02-04T01:48:31Z URL : http://[fe80::9618:82ff:fe03:3a70]:80/ UUID : 55ba8586-ac8b-5ba2-b84d-163256daf212</dev:code> <dev:remarks> <maml:para>Gets peer information of a specified group by name—Test123.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEiLO</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-HPEiLOFirmwareInventory</command:name> <maml:description> <maml:para>Gets the firmware details for the iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOFirmwareInventory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOFirmwareInventory cmdlet gets the name and version details for the various firmware on the server.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOFirmwareInventory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.FirmwareInfo[] or HPE.iLO.Response.Redfish.FirmwareInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 admin admin123 PS C:\> $obj = Get-HPEiLOFirmwareInventory -Connection $connection PS C:\> $obj | fl FirmwareInformation : {HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation...} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo : $obj.FirmwareInformation Index : 1 FirmwareName : iLO FirmwareVersion : 2.55 Jun 16 2017 FirmwareFamily : Index : 2 FirmwareName : System ROM FirmwareVersion : I36 v2.40 (02/17/2017) FirmwareFamily : Index : 3 FirmwareName : Redundant System ROM FirmwareVersion : I36 v2.40 (02/17/2017) FirmwareFamily : Index : 4 FirmwareName : Intelligent Provisioning FirmwareVersion : 2.30.75 FirmwareFamily : Index : 5 FirmwareName : Intelligent Platform Abstraction Data FirmwareVersion : 22.27 FirmwareFamily : Index : 6 FirmwareName : Power Management Controller Firmware FirmwareVersion : 1.0.7 FirmwareFamily : 14h Index : 7 FirmwareName : Power Management Controller FW Bootloader FirmwareVersion : 1.0 FirmwareFamily : Index : 8 FirmwareName : System Programmable Logic Device FirmwareVersion : Version 0x16 FirmwareFamily : Index : 9 FirmwareName : SAS Programmable Logic Device FirmwareVersion : Version 0x01 FirmwareFamily : Index : 10 FirmwareName : Server Platform Services (SPS) Firmware FirmwareVersion : 3.0.6.267.4 FirmwareFamily : Index : 11 FirmwareName : HPE Smart Storage Battery 1 Firmware FirmwareVersion : 1.3 FirmwareFamily : Index : 12 FirmwareName : Smart Array P244br Controller FirmwareVersion : V3.00_B0 FirmwareFamily :</dev:code> <dev:remarks> <maml:para>This example shows the usage of cmdlet on iLO 4 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.3 admin admin123 PS C:\> $obj = ,$connection | Get-HPEiLOFirmwareInventory PS C:\> $obj | fl FirmwareInformation : {HPE.iLO.Response.Redfish.FirmwareInformation, HPE.iLO.Response.Redfish.FirmwareInformation, HPE.iLO.Response.Redfish.FirmwareInformation, HPE.iLO.Response.Redfish.FirmwareInformation...} IP : 10.20.30.3 Hostname : xyz.example.com Status : OK StatusInfo : $obj.FirmwareInformation Index : 1 FirmwareName : iLO 5 FirmwareVersion : 1.20 Aug 07 2017 DeviceClass : 2f317b9d-c9e3-4d76-bff6-b9d0d085a952 DeviceInstance : Location : System Board Targets : {4764a662-b342-4fc7-9ce9-258c5d99e815} Status : OK Index : 2 FirmwareName : System ROM FirmwareVersion : U30 v1.20 (05/17/2017) DeviceClass : aa148d2e-6e09-453e-bc6f-63baa5f5ccc4 DeviceInstance : Location : System Board Targets : {00000000-0000-0000-0000-000000000205, 00000000-0000-0000-0000-000001553330, 00000000-0000-0000-0000-0000018c3d8a, 00000000-0000-0000-0000-000001553330} Status : OK Index : 3 FirmwareName : Intelligent Platform Abstraction Data FirmwareVersion : 1.98.0 Build 9 DeviceClass : b8f46d06-85db-465c-94fb-d106e61378ed DeviceInstance : Location : System Board Targets : {00000000-0000-0000-0000-000000000205, 00000000-0000-0000-0000-000001553330, 00000000-0000-0000-0000-0000018c3d8a, 00000000-0000-0000-0000-000001553330} Status : Index : 4 FirmwareName : System Programmable Logic Device FirmwareVersion : 0x2A DeviceClass : b1ad439a-9dd1-41c1-a496-2da9313f1f07 DeviceInstance : Location : System Board Targets : {00000000-0000-0000-0000-000000000205} Status : OK Index : 5 FirmwareName : Power Management Controller Firmware FirmwareVersion : 1.0.0 DeviceClass : 9e48a28a-586c-4519-8405-a04f84e27f0f DeviceInstance : Location : System Board Targets : {00000000-0000-0000-0000-000000000205, 00000000-0000-0000-0000-000000504d05} Status : Index : 6 FirmwareName : Innovation Engine (IE) Firmware FirmwareVersion : 0.1.0.25 DeviceClass : c734e171-8721-48c9-9ed6-d5bc7da5ef8d DeviceInstance : Location : System Board Targets : {00000000-0000-0000-0000-000000000205, a6b1a447-382a-5a4f-3c10-3c100a000303} Status : OK Index : 7 FirmwareName : Server Platform Services (SPS) Firmware FirmwareVersion : 4.0.3.199 DeviceClass : b34e5677-21dc-45d3-872b-42f76fee9053 DeviceInstance : Location : System Board Targets : {00000000-0000-0000-0000-000000000205, a6b1a447-382a-5a4f-3c10-86800a000101} Status : OK Index : 8 FirmwareName : Redundant System ROM FirmwareVersion : U30 v1.20 (07/01/2017) DeviceClass : DeviceInstance : Location : System Board Targets : Status : Index : 9 FirmwareName : Intelligent Provisioning FirmwareVersion : 3.00.382 DeviceClass : ac963eeb-ed78-4f36-c18c-29d85f34a0ac DeviceInstance : Location : System Board Targets : Status : Index : 10 FirmwareName : Power Management Controller FW Bootloader FirmwareVersion : 1.0 DeviceClass : DeviceInstance : Location : System Board Targets : Status : Index : 11 FirmwareName : HPE Ethernet 1Gb 4-port 331i Adapter - NIC FirmwareVersion : 20.6.315 DeviceClass : DeviceInstance : PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0) Location : Embedded LOM 1 Targets : {a6b1a447-382a-5a4f-14e4-1657103c22be} Status : Index : 12 FirmwareName : HPE Smart Array P450ar FirmwareVersion : 1.00 DeviceClass : DeviceInstance : PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0) Location : Embedded RAID 1 Targets : {a6b1a447-382a-5a4f-9005-028f103c0602} Status : Index : 13 FirmwareName : HPE Smart Array S100i SR Gen10 FirmwareVersion : N/A DeviceClass : DeviceInstance : PciRoot(0x0)/Pci(0x1C,0x4)/Pci(0x0,0x7) Location : Embedded Storage Targets : {a6b1a447-382a-5a4f-103c-193f159000e4} Status : Index : 14 FirmwareName : Drive FirmwareVersion : HPD1 DeviceClass : f6de0320-2e0f-489a-b238-6dd8ae7c3811 DeviceInstance : Location : Embedded controller Port P1 Box 3 Bay 1 Targets : {002340a5-4d00-314d-3030-304a464a5448} Status :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the usage of cmdlet on iLO 5 with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 admin admin123 -Disablecertificateauthentication PS C:\> Get-HPEiLOFirmwareInventory -Connection $connection | fl FirmwareInformation : {HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation...} IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo : FirmwareInformation : {HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation...} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo : FirmwareInformation : {HPE.iLO.Response.Redfish.FirmwareInformation, HPE.iLO.Response.Redfish.FirmwareInformation, HPE.iLO.Response.Redfish.FirmwareInformation, HPE.iLO.Response.Redfish.FirmwareInformation...} IP : 10.20.30.42 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 and iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOFirmwarePolicy</command:name> <maml:description> <maml:para>Gets the firmware downgrade policy information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOFirmwarePolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOFirmwarePolicy gets the firmware downgrade policy information. This cmdlet is supported on iLO 5 servers only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOFirmwarePolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.FirmwarePolicy[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\>$output = ,$connection | Get-HPEiLOFirmwarePolicy PS C:\>$output DowngradePolicy : AllowDowngrade IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.50 -Username admin -Password admin123 PS C:\>$output = Get-HPEiLOFirmwarePolicy -Connection $connection PS C:\>$output DowngradePolicy : AllowDowngrade IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : DowngradePolicy : NoDowngrade IP : 10.20.30.50 Hostname : ab.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOFirmwarePolicy</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-HPEiLOFirmwareVerificationLastScanResult</command:name> <maml:description> <maml:para>Gets the firmware verification scan result.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOFirmwareVerificationLastScanResult</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOFirmwareVerificationLastScanResult cmdlet gets the latest firmware verification scan result. Advanced License is required for this feature without which properties with empty value will be returned. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOFirmwareVerificationLastScanResult</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.FirmwareVerificationLastScanResult[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\>$output = ,$connection | Get-HPEiLOFirmwareVerificationLastScanResult FirmwareStatus : {HPE.iLO.Response.Redfish.FirmwareStatus, HPE.iLO.Response.Redfish.FirmwareStatus, HPE.iLO.Response.Redfish.FirmwareStatus, HPE.iLO.Response.Redfish.FirmwareStatus} LastScanTime : 7/3/2017 2:44:41 PM LastScanResult : OK LastFailedImageUri : IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $output.FirmwareStatus | fl Name : iLO 5 Version : 1.30 May 31 2018 Status : HPE.iLO.Response.Redfish.Status RecoverySetVersion : 1.30 Name : System ROM Version : U33 v1.22 (09/29/2017) Status : HPE.iLO.Response.Redfish.Status RecoverySetVersion : Name : System Programmable Logic Device Version : 0x13 Status : HPE.iLO.Response.Redfish.Status RecoverySetVersion : Name : Innovation Engine (IE) Firmware Version : 0.1.6.0 Status : HPE.iLO.Response.Redfish.Status RecoverySetVersion : Name : Server Platform Services (SPS) Firmware Version : 4.0.4.288 Status : HPE.iLO.Response.Redfish.Status RecoverySetVersion :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOFirmwareVerificationLastScanResult -Connection $connection FirmwareStatus : {HPE.iLO.Response.Redfish.FirmwareStatus, HPE.iLO.Response.Redfish.FirmwareStatus, HPE.iLO.Response.Redfish.FirmwareStatus, HPE.iLO.Response.Redfish.FirmwareStatus} LastScanTime : 7/3/2017 2:44:41 PM LastScanResult : OK LastFailedImageUri : IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : FirmwareStatus : {HPE.iLO.Response.Redfish.FirmwareStatus, HPE.iLO.Response.Redfish.FirmwareStatus, HPE.iLO.Response.Redfish.FirmwareStatus, HPE.iLO.Response.Redfish.FirmwareStatus} LastScanTime : 7/3/2018 2:44:41 PM LastScanResult : OK LastFailedImageUri : IP : 10.20.30.41 Hostname : xyz.domain.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOFirmwareVerificationScan</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-HPEiLOFirmwareVerificationScanSetting</command:name> <maml:description> <maml:para>Gets the firmware verification scan setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOFirmwareVerificationScanSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOFirmwareVerificationScanSetting cmdlet gets the firmware verification scan setting. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOFirmwareVerificationScanSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.FirmwareVerificationScanSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOFirmwareVerificationScanSetting BackgroundScanEnabled : No IntegrityFailureAction : LogOnly ScanInterval : 3 IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOFirmwareVerificationScanSetting -Connection $connection BackgroundScanEnabled : No IntegrityFailureAction : LogOnly ScanInterval : 3 IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : BackgroundScanEnabled : Yes IntegrityFailureAction : LogAndRepairAutomatically ScanInterval : 10 IP : 10.20.30.41 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOFirmwareVerificationScanSetting</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-HPEiLOFirmwareVersion</command:name> <maml:description> <maml:para>Gets the iLO firmware information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOFirmwareVersion</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOFirmwareVersion cmdlet gets the respective iLO firmware information.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOFirmwareVersion</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.FirmwareVersionInfo[] or HPE.iLO.Response.Redfish.FirmwareVersionInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOFirmwareVersion FirmwareDate : Jul 19 2016 FirmwareVersion : 2.44 ManagerType : iLO4 IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.41 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOFirmwareVersion FirmwareVersion : iLO 5 v1.20 MajorVersion : 1 MinorVersion : 20 FirmwareDate : Oct 02 2017 ManagerType : iLO5 BuildNumber : DebugBuild : False Family : Time : IP : 10.20.30.41 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> $obj = Get-HPEiLOFirmwareVersion -Connection $connection FirmwareDate : Jul 12 2017 FirmwareVersion : 2.55 ManagerType : iLO4 IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : FirmwareVersion : iLO 5 v1.20 MajorVersion : 1 MinorVersion : 20 FirmwareDate : Oct 02 2017 ManagerType : iLO5 BuildNumber : DebugBuild : False Family : Time : IP : 10.20.30.41 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOHealthSummary</command:name> <maml:description> <maml:para>Gets the health information summary of the host server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOHealthSummary</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOHealthSummary cmdlet gets the health information summary for the server where the iLO is located. The command gets the status of BIOS hardware, fans, memory, network, power supply, processors, storage, and temperature of the host.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOHealthSummary</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.iLO4.HealthSummary[] or HPE.iLO.Response.Redfish.HealthSummary[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOHealthSummary BatteryStatus : OK BIOSHardwareStatus : OK FanStatus : OK FanRedundancy : Redundant MemoryStatus : OK NetworkStatus : OK PowerSuppliesStatus : OK PowerSuppliesRedundancy : Redundant ProcessorStatus : OK StorageStatus : OK TemperatureStatus : OK IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusMessage :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOHealthSummary PS C:\> $obj AgentlessManagementService : Unavailable BIOSHardwareStatus : OK FanStatus : OK FanRedundancy : Redundant MemoryStatus : OK NetworkStatus : OK PowerSuppliesStatus : OK PowerSuppliesRedundancy : NonRedundant PowerSuppliesMismatch : No ProcessorStatus : OK SmartStorageBatteryStatus : StorageStatus : Critical TemperatureStatus : OK IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> $obj = Get-HPEiLOHealthSummary -Connection $connection AgentlessManagementService : Unavailable BIOSHardwareStatus : OK FanStatus : OK FanRedundancy : Redundant MemoryStatus : OK NetworkStatus : OK PowerSuppliesStatus : OK PowerSuppliesRedundancy : NonRedundant PowerSuppliesMismatch : No ProcessorStatus : OK SmartStorageBatteryStatus : StorageStatus : Critical TemperatureStatus : OK IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : AgentlessManagementService : Unavailable BIOSHardwareStatus : OK FanStatus : OK FanRedundancy : Redundant MemoryStatus : OK NetworkStatus : OK PowerSuppliesStatus : OK PowerSuppliesRedundancy : NonRedundant PowerSuppliesMismatch : No ProcessorStatus : OK SmartStorageBatteryStatus : StorageStatus : Critical TemperatureStatus : OK IP : 10.20.30.41 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOHostData</command:name> <maml:description> <maml:para>Gets the host data displayed on the Server Information page.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOHostData</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOHostData cmdlet gets the host data displayed on the Server Information page. The data is extracted from SMBIOS records stored on the host. The raw data in the SMBIOS records is retrieved using this cmdlet. You can access the data by base 64 decoding the returned data. The same fields that are displayed on the web page are also decoded through this interface.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOHostData</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.HostDataInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\>$connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\>$output = ,$connection | Get-HPEiLOHostData PS C:\>$output SMBIOSRecord : {HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord...} IP : 10.20.30.40 Hostname : xyz.example.com Status : OK PS C:\>$output.SMBIOSRecord | fl B64Data : ABgIAAECAPAD/4DayX0AAAAAAw8CKgI1SFAAUDg5ADA0LzI1LzIwMTcAAA== Field : {Family, Date} Type : 0 B64Data : ARsJCAAM3NTI2ODlNUwQ0JKBgQFSFAAUHJvTGlhbnQgREwzODAgR2VuOQBNWFE1NDUwQ0JKADc1MjY4OS1CMjEAUHJvTGlhbnQAAA== Field : {Product Name, Serial Number, UUID, cUUID} Type : 1 B64Data : AhEoAAECAAMEDQUAAAoAAFudCBETDM4MCBHZW45AE1YUTU0NTBDQkoASFBFIFByb2xpYW50IFIICAgICAgICAgICAgAAA= Field : Type : 2 B64Data : AxUpAAEXAAIDAwMDAgAAAAACAgADSFAATVhRNTQ1MENCSgBIUEUgUHJvbGlhbnQgU2VydmVyAAA= Field : Type : 3 B64Data : BCoDAAEDswUHJvYyAxAEludGVsKFIpIENvcnBvcmF0aW9uAEludGVsKFIpIFhlb24oUikgQ1BVIh6AFVOS05PV04AAA== Field : {Label, Speed, Execution Technology, Memory Technology} Type : 4 B64Data : BCoHAAEDswLyvYyAyAEludGVsKFIpIENvcnBvcmF0aW9uAEludGVsKFIpIFhlb24oUikgQ1BVIEU1LTI2NTVOS05PV04AAA== Field : {Label, Speed, Execution Technology, Memory Technology} Type : 4 B64Data : BxMAAAGAAYACgAIgACAAAAUFB0wxLUNhY2hlAAA= Field : Type : 7</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\>$connection = Connect-HPEiLO 10.20.30.42 -Username admin -Password admin123 PS C:\>$output = ,$connection | Get-HPEiLOHostData PS C:\>$output SMBIOSRecord : {HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord...} IP : 10.20.30.42 Hostname : xyz.example.com Status : OK PS C:\>$output.SMBIOSRecord | fl B64Data : ABgIAAECAPAD/4DayX0AAAAAAw8CKgI1SFAAUDg5ADA0LzI1LzIwMTcAAA== Field : {Family, Date} Type : 0 B64Data : ARsJCAAM3NTI2ODlNUwQ0JKBgQFSFAAUHJvTGlhbnQgREwzODAgR2VuOQBNWFE1NDUwQ0JKADc1MjY4OS1CMjEAUHJvTGlhbnQAAA== Field : {Product Name, Serial Number, UUID, cUUID} Type : 1 B64Data : AhEoAAECAAMEDQUAAAoAAFudCBETDM4MCBHZW45AE1YUTU0NTBDQkoASFBFIFByb2xpYW50IFIICAgICAgICAgICAgAAA= Field : Type : 2 B64Data : AxUpAAEXAAIDAwMDAgAAAAACAgADSFAATVhRNTQ1MENCSgBIUEUgUHJvbGlhbnQgU2VydmVyAAA= Field : Type : 3 B64Data : BCoDAAEDswUHJvYyAxAEludGVsKFIpIENvcnBvcmF0aW9uAEludGVsKFIpIFhlb24oUikgQ1BVIh6AFVOS05PV04AAA== Field : {Label, Speed, Execution Technology, Memory Technology} Type : 4 B64Data : BCoHAAEDswLyvYyAyAEludGVsKFIpIENvcnBvcmF0aW9uAEludGVsKFIpIFhlb24oUikgQ1BVIEU1LTI2NTVOS05PV04AAA== Field : {Label, Speed, Execution Technology, Memory Technology} Type : 4 B64Data : BxMAAAGAAYACgAIgACAAAAUFB0wxLUNhY2hlAAA= Field : Type : 7</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Get-HPEiLOHostData -Connection $connection | fl SMBIOSRecord : {HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord...} IP : 10.20.30.40 Hostname : xyz.example.com Status : OK SMBIOSRecord : {HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord...} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK SMBIOSRecord : {HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord, HPE.iLO.DataEntity.SMBIOSRecord...} IP : 10.20.30.42 Hostname : xyz.example.com Status : OK</dev:code> <dev:remarks> <maml:para>This example shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Read-HPEiLOSMBIOSRecord</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-HPEiLOHotKeyConfig</command:name> <maml:description> <maml:para>Gets hot keys available for use in remote console sessions.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOHotKeyConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOHotKeyConfig cmdlet gets hot keys available for use in remote console sessions. There are six hotkeys: CtrlT, CtrlU, CtrlV, CtrlW, CtrlX, CtrlY. Each hot key represents a combination of up to five different keys (for example, CtrlT="Ctrl,Alt,Esc,F2,F4"). If a particular key in a hot key is not set, it is displayed as 'NONE' in the output (for example, CtrlT : L_CTRL,L_ALT,ESC,NONE,NONE).</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOHotKeyConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.HotKeyConfig[] or HPE.iLO.Response.Redfish.HotKeyConfig[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOHotKeyConfig CtrlT : a,a,b,b,c CtrlU : a,a,b,b,c CtrlV : a,a,b,b,c CtrlW : a,a,b,b,c CtrlX : NONE,NONE,NONE,NONE,NONE CtrlY : NONE,NONE,NONE,NONE,NONE IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEiLOHotKeyConfig -Connection $connection CtrlT : a,a,b,b,c CtrlU : a,a,b,b,c CtrlV : a,a,b,b,c CtrlW : a,a,b,b,c CtrlX : NONE,NONE,NONE,NONE,NONE CtrlY : NONE,NONE,NONE,NONE,NONE IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : CtrlT : NONE,NONE,NONE,NONE,NONE CtrlU : NONE,NONE,NONE,NONE,NONE CtrlV : NONE,NONE,NONE,NONE,NONE CtrlW : NONE,NONE,NONE,NONE,NONE CtrlX : NONE,NONE,NONE,NONE,NONE CtrlY : NONE,NONE,NONE,NONE,NONE IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOHotKeyConfig</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-HPEiLOIML</command:name> <maml:description> <maml:para>Gets the integrated management logs.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOIML</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOIML cmdlet gets the integrated management logs. The response includes all of the events recorded in the order that they occurred. Events are not sorted by severity or other criteria. Each event includes a common set of attributes:</maml:para> <maml:para>• Severity - Indicates the importance of the error and how it might impact server or iLO availability. Possible output values are: o FAILED - Indicates a problem or component failure that might impact operational time if it is not addressed. o CAUTION - Indicates an event that is not expected during normal system operation. This might not indicate a platform issue. o DEGRADED - Indicates the device or subsystem is operating at a reduced capacity. o REPAIRED - Indicates that an event or component failure has been addressed. o INFORMATIONAL - Indicates that something exceptional occurred, but the operational time is not impacted.</maml:para> <maml:para>• Created - Indicates when this event first occurred.</maml:para> <maml:para>• Count - Indicates the number of times a duplicate event happened.</maml:para> <maml:para>• Categories - Indicates the log entry categories (available only on Gen10 and above).</maml:para> <maml:para>• Class - Indicates the event class (available only on Gen10 and above).</maml:para> <maml:para>• ClassDescription- Indicates the event class description (available only on Gen10 and above).</maml:para> <maml:para>• EventCode - Indicates the IML event code.</maml:para> <maml:para>• Destination- The destination host name or IP address of the remote server that received the service event (available only on Gen10 and above).</maml:para> <maml:para>• SubmitStatus- The service event log submission status (available only on Gen10 and above).</maml:para> <maml:para>• Identifier - The unique identifier of the service event (available only on Gen10 and above).</maml:para> <maml:para>• EventNumber - Indicates the event log identification number. Events are numbered in the order in which they are generated.</maml:para> <maml:para>• EntryType - Indicates the log entry type.</maml:para> <maml:para>• Id - Uniquely identifies the resource (available only on Gen10 and above).</maml:para> <maml:para>• LearnMoreLink - The HPSC link for troubleshooting information (available only on Gen10 and above).</maml:para> <maml:para>• Message - indicates the nature of the event and all recorded details.</maml:para> <maml:para>• Name - The name of the resource.</maml:para> <maml:para>• RecommendedAction - Indicates the recommended action for the event (available only on Gen10 and above).</maml:para> <maml:para>• Repaired - Indicates the repaired status of the IML event.</maml:para> <maml:para>• Source - Indicates the subsystem that generated the event and can include iLO, environment, power, system error, rack infrastructure, and more.</maml:para> <maml:para>• Updated - Indicates the date and time of the latest log entry update.</maml:para> <maml:para>• UserAction- Indicates the user action for the event (available only on Gen10 and above).</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOIML</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.IMLInfo[] or HPE.iLO.Response.Redfish.IMLInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOIML PS C:\> $obj | fl Description : Integrated Management Log IMLLog : {HPE.iLO.Response.RIBCL.LogEntry} IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $obj.IMLLog Count : 1 Created : 10/02/2017 05:25 EventCode : 1 Class : 33 Message : IML Cleared (iLO 4 user:admin) Severity : Informational Source : Maintenance Updated : 10/02/2017 05:25</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOIML PS C:\> $obj | fl Description : Integrated Management Log IMLLog : {HPE.iLO.Response.RIBCL.LogEntry} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $obj.IMLLog Id : 1 Name : Integrated Management Log Categories : {Maintenance, Administration} EntryType : Oem EventNumber : 214 OemRecordFormat : Hpe-IML LearnMoreLink : RecommendedAction : Repaired : Destination : Count : 1 Created : 2001-03-17T10:49:19Z EventCode : 1 Class : 33 ClassDescription : Maintenance Message : IML Cleared (iLO 5 user: admin) Severity : Informational Updated : 2001-03-17T10:49:19Z UserAction : SubmitStatus : Identifier :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOIML PS C:\> $obj | fl Description : Integrated Management Log IMLLog : {HPE.iLO.Response.RIBCL.LogEntry} IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : Description : Integrated Management Log IMLLog : {HPE.iLO.Response.RIBCL.LogEntry} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOIML</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-HPEiLOInfo</command:name> <maml:description> <maml:para>Gets the basic unauthenticated iLO information using redfish API.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOInfo cmdlet queries the redfish/v1/ root url and gets the unauthenticated details of the target iLO IP. This cmdlet is supported only on iLO 4 and iLO 5.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="IP , HostName , iLOIP"> <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies the target iLO IP or hostname of which the information has to be fetched using redfish call. The Address also accepts IP value as a range. Example: 10.1.10.1-30 attempts to get the iLO information for all the iLO ranging from 1-30 in the last octet of IP address 10.1.10.</maml:para> <maml:para>Aliases: IP , HostName , iLOIP</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout period for Http request. Timeout period can be specified by the user where there can be a possible lag due to geographical distance between the client and server. The value is specified in seconds. Default value is 30 seconds. If the default timeout is not long enough, no iLOs will be found and errors will be displayed. The parameter accepts values in the range of 1 to 1800.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableCertificateAuthentication</maml:name> <maml:description> <maml:para>If the DisableCertificateAuthentication switch parameter is present, the server certificate authentication is disabled during the Http request. If not present, it will execute according to the global certificate authentication setting. The default behavior is to authenticate server certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="IP , HostName , iLOIP"> <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies the target iLO IP or hostname of which the information has to be fetched using redfish call. The Address also accepts IP value as a range. Example: 10.1.10.1-30 attempts to get the iLO information for all the iLO ranging from 1-30 in the last octet of IP address 10.1.10.</maml:para> <maml:para>Aliases: IP , HostName , iLOIP</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout period for Http request. Timeout period can be specified by the user where there can be a possible lag due to geographical distance between the client and server. The value is specified in seconds. Default value is 30 seconds. If the default timeout is not long enough, no iLOs will be found and errors will be displayed. The parameter accepts values in the range of 1 to 1800.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisableCertificateAuthentication</maml:name> <maml:description> <maml:para>If the DisableCertificateAuthentication switch parameter is present, the server certificate authentication is disabled during the Http request. If not present, it will execute according to the global certificate authentication setting. The default behavior is to authenticate server certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</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>HPE.iLO.Response.Redfish.iLOInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $iLOInfo = Get-HPEiLOInfo 10.20.30.1 PS C:\> $iLOInfo UUID : c0e6700d-fc0d-5e8a-9b49-0939c3d1b985 DevSystem : Manager : HPE.iLO.Response.Redfish.Manager Moniker : HPE.iLO.Response.Redfish.Moniker Sessions : HPE.iLO.Response.Redfish.HpeiLOServiceExtSession System : Time : 2018-08-31T06:17:40Z IP : 10.20.30.1 Hostname : bl460cgen10-4.powershvpn.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>using Timeout parameter PS C:\> $iLOInfo = Get-HPEiLOInfo 10.20.30.1 -Timeout 20 PS C:\> $iLOInfo UUID : c0e6700d-fc0d-5e8a-9b49-0939c3d1b985 DevSystem : Manager : HPE.iLO.Response.Redfish.Manager Moniker : HPE.iLO.Response.Redfish.Moniker Sessions : HPE.iLO.Response.Redfish.HpeiLOServiceExtSession System : Time : 2018-08-31T06:17:40Z IP : 10.20.30.1 Hostname : bl460cgen10-4.powershvpn.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Address parameter value is IP Range PS C:\> $iLOInfo = Get-HPEiLOInfo 10.20.30.1-3 PS C:\> $iLOInfo UUID : c0e6700d-fc0d-5e8a-9b49-0939c3d1b985 DevSystem : Manager : HPE.iLO.Response.Redfish.Manager Moniker : HPE.iLO.Response.Redfish.Moniker Sessions : HPE.iLO.Response.Redfish.HpeiLOServiceExtSession System : Time : 2018-08-31T06:17:40Z IP : 10.20.30.1 Hostname : bl460cgen10-4.powershvpn.com Status : OK StatusInfo : UUID : e0e6700d-fc0d-5e7a-9b49-0939c3d1b984 DevSystem : Manager : HPE.iLO.Response.Redfish.Manager Moniker : HPE.iLO.Response.Redfish.Moniker Sessions : HPE.iLO.Response.Redfish.HpeiLOServiceExtSession System : Time : 2018-08-31T06:17:40Z IP : 10.20.30.2 Hostname : bl460cgen10-2.powershvpn.com Status : OK StatusInfo : UUID : d0e6700d-fc0d-5e9a-9b49-0939c3d1b986 DevSystem : Manager : HPE.iLO.Response.Redfish.Manager Moniker : HPE.iLO.Response.Redfish.Moniker Sessions : HPE.iLO.Response.Redfish.HpeiLOServiceExtSession System : Time : 2018-08-31T06:17:40Z IP : 10.20.30.3 Hostname : dl360cgen10-3.powershvpn.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</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-HPEiLOInstallationTaskQueue</command:name> <maml:description> <maml:para>Gets the Installation Task Queue detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOInstallationTaskQueue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOInstallationTaskQueue cmdlet gets the Installation Task Queue detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOInstallationTaskQueue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.InstallationTaskQueue[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOInstallationTaskQueue PS C:\> $out InstallationTaskQueueInfo : {HPE.iLO.Response.Redfish.InstallationTaskQueueInfo, HPE.iLO.Response.Redfish.InstallationTaskQueueInfo, HPE.iLO.Response.Redfish.InstallationTaskQueueInfo, HPE.iLO.Response.Redfish.InstallationTaskQueueInfo...} IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.InstallationTaskQueueInfo Command : ApplyUpdate Id : 506b3169 Component : Unavailable Created : 6/30/2017 6:18:50 PM Expire : Filename : Modified : 6/30/2017 6:18:50 PM TaskName : TestTask UpdatableBy : TPMOverride : false UpdateRecoverySet : false Result : HPE.iLO.Response.Redfish.Result State : Pending StartAfter : Command : ApplyUpdate Id : 1240c3cc Component : /redfish/v1/UpdateService/ComponentRepository/b00b43a7 Created : 6/30/2017 6:18:50 PM Expire : Filename : ilo5_115.bin Modified : 6/30/2017 6:18:50 PM TaskName : System Recovery Set item (iLO 5) UpdatableBy : {Bmc} TPMOverride : true UpdateRecoverySet : false Result : State : Pending StartAfter : Command : ApplyUpdate Id : 82820adf Component : /redfish/v1/UpdateService/ComponentRepository/0d51810a Created : 6/30/2017 6:18:50 PM Expire : Filename : IEGen10_0.1.5.2.signed.bin Modified : 6/30/2017 6:18:50 PM TaskName : System Recovery Set item (Innovation Engine) UpdatableBy : {Bmc} TPMOverride : true UpdateRecoverySet : false Result : State : Pending StartAfter : Command : ApplyUpdate Id : ff35842f Component : /redfish/v1/UpdateService/ComponentRepository/26b7abcb Created : 2018-01-17T05:08:25Z Expire : Filename : CPLD_DL360_DL380_Gen10_VP1_v2A2A_full_signed.vme Modified : 2018-01-17T05:08:25Z TaskName : System Recovery Set item (System Programmable Logic Device) UpdatableBy : {Bmc} TPMOverride : true UpdateRecoverySet : false Result : State : Pending StartAfter : Command : ApplyUpdate Id : 2f0e29f0 Component : /redfish/v1/UpdateService/ComponentRepository/b9a1ecb4 Created : 2018-01-17T05:08:25Z Expire : Filename : U30_1.26_11_14_2017.signed.flash Modified : 2018-01-17T05:08:25Z TaskName : System Recovery Set item (System ROM) UpdatableBy : {Bmc} TPMOverride : true UpdateRecoverySet : false Result : State : Pending StartAfter : Command : Wait Id : e5e30857 Component : Created : 2001-06-23T15:39:04Z Expire : Filename : Modified : 2001-06-23T15:39:04Z TaskName : waittask UpdatableBy : {Bmc} TPMOverride : UpdateRecoverySet : Result : State : Pending StartAfter : WaitTimeSeconds : 20</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEiLOInstallationTaskQueue -Connection $connection InstallationTaskQueueInfo : {HPE.iLO.Response.Redfish.InstallationTaskQueueInfo, HPE.iLO.Response.Redfish.InstallationTaskQueueInfo, HPE.iLO.Response.Redfish.InstallationTaskQueueInfo, HPE.iLO.Response.Redfish.InstallationTaskQueueInfo...} IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : InstallationTaskQueueInfo : {HPE.iLO.Response.Redfish.InstallationTaskQueueInfo, HPE.iLO.Response.Redfish.InstallationTaskQueueInfo, HPE.iLO.Response.Redfish.InstallationTaskQueueInfo, HPE.iLO.Response.Redfish.InstallationTaskQueueInfo...} IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOInstallationTaskQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</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-HPEiLOInstallSet</command:name> <maml:description> <maml:para>Gets the install set detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOInstallSet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOInstallSet cmdlet gets the install set detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOInstallSet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.InstallSet[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOInstallSet PS C:\> $out InstallSetInfo : {HPE.iLO.Response.Redfish.InstallSetInfo} IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.InstallSetInfo Id : a74b22b6 Created : 6/30/2017 6:18:50 PM Description : Essential system firmware components IsRecovery : true Modified : 6/30/2017 6:18:50 PM Name : System Recovery Set Sequence : {HPE.iLO.Response.Redfish.Sequence, HPE.iLO.Response.Redfish.Sequence, HPE.iLO.Response.Redfish.Sequence, HPE.iLO.Response.Redfish.Sequence...} PS C:\> $out.InstallSetInfo[0].Sequence Command : ApplyUpdate Component : /redfish/v1/UpdateService/ComponentRepository/b00b43a7 Filename : ilo5_115.bin ComponentName : comp1 UpdatableBy : {Bmc} WaitTimeSeconds : ExecutionTimeoutMinutes : 1 Command : ApplyUpdate Component : /redfish/v1/UpdateService/ComponentRepository/0d51810a Filename : IEGen10_0.1.5.2.signed.bin ComponentName : System Recovery Set item (Innovation Engine) UpdatableBy : {Bmc} WaitTimeSeconds : ExecutionTimeoutMinutes : Command : ApplyUpdate Component : /redfish/v1/UpdateService/ComponentRepository/26b7abcb Filename : CPLD_DL360_DL380_Gen10_VP1_v2A2A_full_signed.vme ComponentName : System Recovery Set item (System Programmable Logic Device) UpdatableBy : {Bmc} WaitTimeSeconds : ExecutionTimeoutMinutes : 15 Command : ApplyUpdate Component : /redfish/v1/UpdateService/ComponentRepository/b9a1ecb4 Filename : U30_1.26_11_14_2017.signed.flash ComponentName : System Recovery Set item (System ROM) UpdatableBy : {Bmc} WaitTimeSeconds : ExecutionTimeoutMinutes : Command : ApplyUpdate Component : /redfish/v1/UpdateService/ComponentRepository/47a612b8 Filename : SPSGen10_04.00.04.288.signed.bin ComponentName : System Recovery Set item (Server Platform Services) UpdatableBy : {Bmc} WaitTimeSeconds : ExecutionTimeoutMinutes :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEiLOInstallSet -Connection $connection InstallSetInfo : {HPE.iLO.Response.Redfish.InstallSetInfo} IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : InstallSetInfo : {HPE.iLO.Response.Redfish.InstallSetInfo} IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOInstallSet</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-HPEiLOIntegratedRemoteConsoleTrustSetting</command:name> <maml:description> <maml:para>Gets Integrated remote console or IRC Trust settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOIntegratedRemoteConsoleTrustSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets Integrated remote console trust settings of the target iLO. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOIntegratedRemoteConsoleTrustSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.IntegratedRemoteConsoleSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$con = Connect-HPEiLO 192.168.10.28, 192.168.10.31 admin admin123 -DisableCertificateAuthentication -Verbose PS C:\Windows\system32> $i = $con | Get-HPEiLOIntegratedRemoteConsoleSetting PS C:\Windows\system32> $i TrustedCertificateRequired : No IP : 192.168.10.28 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo : TrustedCertificateRequired : Yes IP : 192.168.10.31 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>Gets IRC trust settings of two iLO 5 servers.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOIntegratedRemoteConsoleTrustSetting</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-HPEiLOIntelligentProvisioningInfo</command:name> <maml:description> <maml:para>Gets the Intelligent Provisioning information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOIntelligentProvisioningInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOIntelligentProvisioningInfo gets the Intelligent provisioning information. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOIntelligentProvisioningInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.IPv6NetworkSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\>,$connection | Get-HPEiLOIntelligentProvisioningInfo IntelligentProvisioningAlwaysOn : Yes IntelligentProvisioningIndex : 11 IntelligentProvisioningLocation : System Board IntelligentProvisioningVersion : 3.00.382 IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the usage of cmdlet on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1-2 -Username admin -Password admin123 PS C:\>Get-HPEiLOIntelligentProvisioningInfo -Connection $connection IntelligentProvisioningAlwaysOn : Yes IntelligentProvisioningIndex : 11 IntelligentProvisioningLocation : System Board IntelligentProvisioningVersion : 3.00.382 IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : IntelligentProvisioningAlwaysOn : Yes IntelligentProvisioningIndex : 11 IntelligentProvisioningLocation : System Board IntelligentProvisioningVersion : 3.00.382 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOInvalidFirmwareImage</command:name> <maml:description> <maml:para>IGets invalid firmware image details from iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOInvalidFirmwareImage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets invalid firmware image details such as Id, Created date, filename, size in bytes, and others from iLO. This cmdlet works only on iLO 5.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOInvalidFirmwareImage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.InvalidFirmwareImage[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\Windows\system32> $connection= Connect-HPEiLO 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\Windows\system32> $info = $connection | Get-HPEiLOInvalidFirmwareImage PS C:\Windows\system32> $info InvalidFirmwareImageInfo : {HPE.iLO.Response.Redfish.InvalidFirmwareImg} IP : 10.20.30.40 Hostname : abc.com Status : OK StatusInfo : PS C:\Windows\system32> $info.InvalidFirmwareImageInfo Id : 9f9ebbd5 Name : Invalid iLO image ImageUri : /fwrepo/invalid/Invalid_iLO Created : 2018-06-22T05:13:02Z DeviceClass : 2f317b9d-c9e3-4d76-bff6-b9d0d085a952 Filename : Invalid_iLO Filepath : invalid/Invalid_iLO SizeBytes : 33554432</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\Windows\system32> $connection= Connect-HPEiLO 10.20.30.40,10.20.30.50 admin admin123 -DisableCertificateAuthentication PS C:\Windows\system32> $info = ,$connection | Get-HPEiLOInvalidFirmwareImage PS C:\Windows\system32> $info InvalidFirmwareImageInfo : {HPE.iLO.Response.Redfish.InvalidFirmwareImg} IP : 10.20.30.40 Hostname : abc.com Status : OK StatusInfo : InvalidFirmwareImageInfo : {HPE.iLO.Response.Redfish.InvalidFirmwareImg} IP : 10.20.30.50 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with an array of connection objects passed as pipeline parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOFirmwareInventory</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-HPEiLOIPv4NetworkSetting</command:name> <maml:description> <maml:para>Gets the current iLO IPv4 network settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOIPv4NetworkSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOIPv4NetworkSetting cmdlet gets the current iLO IPv4 network settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOIPv4NetworkSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>InterfaceType specifies the type of network connection present in the manager. The possible values are Dedicated and Shared. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dedicated</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shared</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>InterfaceType specifies the type of network connection present in the manager. The possible values are Dedicated and Shared. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dedicated</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shared</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.IPv4NetworkSetting or HPE.iLO.Response.Redfish.IPv4NetworkSetting</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>In case of iLO 5 servers, when the InterfaceType parameter is not provided, the cmdlet retrieves the data of the port in which NIC is enabled.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\>$out = ,$connection | Get-HPEiLOIPv4NetworkSetting PS C:\> $out IPv4Address : 10.20.30.2 IPv4SubnetMask : 255.255.0.0 IPv4Gateway : 0.0.0.0 IPv4StaticRoute : {HPE.iLO.Response.RIBCL.IPv4StaticRoute, HPE.iLO.Response.RIBCL.IPv4StaticRoute, HPE.iLO.Response.RIBCL.IPv4StaticRoute} DNSServer : {1.1.1.1, 0.0.0.0, 0.0.0.0} RegisterDDNSServer : Enabled DHCPv4DomainName : Enabled DHCPv4DNSServer : Enabled DHCPv4Enabled : Yes DHCPv4SNTPSetting : Enabled DHCPv4Gateway : Enabled DHCPStaticRoute : Enabled DHCPv4WINSServer : Enabled RegisterWINSServer : Enabled InterfaceType : Dedicated NICEnabled : Yes LinkSpeedMbps : Automatic FullDuplex : Automatic PermanentMACAddress : 38:63:bb:2c:bd:b9 MACAddress : 38:63:bb:2c:bd:b9 DNSName : testdns DomainName : abcd.com SpeedAutoselect : Enabled PingGatewayOnStartup : Enabled iLONICAutoDelay : 90 iLONICAutoSelect : Disabled iLONICAutoSNPScan : 0 iLONICFailOver : Disabled iLONICFailOverDelay : 300 WINSServer : {0.0.0.0, 0.0.0.0} VLANEnabled : VLANID : SNPNICSetting : SNPPort : IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.IPv4StaticRoute | fl Destination : 0.0.0.0 Mask : 0.0.0.0 Gateway : 0.0.0.0 Destination : 0.0.0.0 Mask : 0.0.0.0 Gateway : 0.0.0.0 Destination : 0.0.0.0 Mask : 0.0.0.0 Gateway : 0.0.0.0</dev:code> <dev:remarks> <maml:para>This example shows the usage of the cmdlet on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.3 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOIPv4NetworkSetting -InterfaceType Shared PS C:\> $out IPv4Address : 10.20.30.3 IPv4SubnetMask : 255.255.252.0 IPv4Gateway : 10.20.30.1 IPv4AddressOrigin : Static IPv4StaticRoute : {HPE.iLO.Response.Redfish.IPv4StaticRoute, HPE.iLO.Response.Redfish.IPv4StaticRoute, HPE.iLO.Response.Redfish.IPv4StaticRoute} DNSServer : {0.0.0.0, 0.0.0.0, 0.0.0.0} RegisterDDNSServer : Enabled DHCPv4DomainName : Disabled DHCPv4DNSServer : Disabled DHCPv4Enabled : No DHCPv4SNTPSetting : Disabled DHCPv4Gateway : Disabled DHCPStaticRoute : Disabled DHCPv4WINSServer : Disabled RegisterWINSServer : Enabled InterfaceType : Shared NICEnabled : Yes LinkSpeedMbps : 1000 LinkStatus : FullDuplex : Enabled FQDN : testdns. PermanentMACAddress : FC:15:B4:97:2D:89 MACAddress : FC:15:B4:97:2D:89 DNSName : testdns DomainName : abcd.com SpeedAutoselect : PingGatewayOnStartup : Enabled WINSServer : {0.0.0.0, 0.0.0.0} VLANEnabled : Yes VLANID : 1 SettingResult : SNPNICSetting : LOM SupportsFlexibleLOM : Yes SupportsLOM : Yes SNPPort : 1 UEFIDevicePath : IP : 10.20.30.3 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $out.IPv4StaticRoute | fl Destination : 0.0.0.0 SubnetMask : 0.0.0.0 Gateway : 0.0.0.0 Destination : 0.0.0.0 SubnetMask : 0.0.0.0 Gateway : 0.0.0.0 Destination : 0.0.0.0 SubnetMask : 0.0.0.0 Gateway : 0.0.0.0</dev:code> <dev:remarks> <maml:para>This example shows the usage of cmdlet on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEiLOIPv4NetworkSetting -Connection $connection IPv4Address : 10.20.30.2 IPv4SubnetMask : 255.255.0.0 IPv4Gateway : 0.0.0.0 IPv4StaticRoute : {HPE.iLO.Response.RIBCL.IPv4StaticRoute, HPE.iLO.Response.RIBCL.IPv4StaticRoute, HPE.iLO.Response.RIBCL.IPv4StaticRoute} DNSServer : {1.1.1.1, 0.0.0.0, 0.0.0.0} RegisterDDNSServer : Enabled DHCPv4DomainName : Enabled DHCPv4DNSServer : Enabled DHCPv4Enabled : Yes DHCPv4SNTPSetting : Enabled DHCPv4Gateway : Enabled DHCPStaticRoute : Enabled DHCPv4WINSServer : Enabled RegisterWINSServer : Enabled InterfaceType : Dedicated NICEnabled : Yes LinkSpeedMbps : Automatic FullDuplex : Automatic PermanentMACAddress : 38:63:bb:2c:bd:b9 MACAddress : 38:63:bb:2c:bd:b9 DNSName : testdns DomainName : abcd.com SpeedAutoselect : Enabled PingGatewayOnStartup : Enabled iLONICAutoDelay : 90 iLONICAutoSelect : Disabled iLONICAutoSNPScan : 0 iLONICFailOver : Disabled iLONICFailOverDelay : 300 WINSServer : {0.0.0.0, 0.0.0.0} VLANEnabled : VLANID : SNPNICSetting : SNPPort : IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo : IPv4Address : 10.20.30.3 IPv4SubnetMask : 255.255.252.0 IPv4Gateway : 10.20.30.1 IPv4AddressOrigin : Static IPv4StaticRoute : {HPE.iLO.Response.Redfish.IPv4StaticRoute, HPE.iLO.Response.Redfish.IPv4StaticRoute, HPE.iLO.Response.Redfish.IPv4StaticRoute} DNSServer : {0.0.0.0, 0.0.0.0, 0.0.0.0} RegisterDDNSServer : Enabled DHCPv4DomainName : Disabled DHCPv4DNSServer : Disabled DHCPv4Enabled : No DHCPv4SNTPSetting : Disabled DHCPv4Gateway : Disabled DHCPStaticRoute : Disabled DHCPv4WINSServer : Disabled RegisterWINSServer : Enabled InterfaceType : Shared NICEnabled : Yes LinkSpeedMbps : 1000 LinkStatus : FullDuplex : Enabled FQDN : testdns. PermanentMACAddress : FC:15:B4:97:2D:89 MACAddress : FC:15:B4:97:2D:89 DNSName : testdns DomainName : abcd.com SpeedAutoselect : PingGatewayOnStartup : Enabled WINSServer : {0.0.0.0, 0.0.0.0} VLANEnabled : Yes VLANID : 1 SettingResult : SNPNICSetting : LOM SupportsFlexibleLOM : Yes SupportsLOM : Yes SNPPort : 1 UEFIDevicePath : IP : 10.20.30.3 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOIPv4NetworkSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOIPv6NetworkSetting</command:name> <maml:description> <maml:para>Gets the current iLO IPv6 network settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOIPv6NetworkSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOIPv6NetworkSetting cmdlet gets the current iLO IPv6 network settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOIPv6NetworkSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>InterfaceType specifies the type of network connection present in the manager. The possible values are Dedicated and Shared. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dedicated</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shared</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>InterfaceType specifies the type of network connection present in the manager. The possible values are Dedicated and Shared. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dedicated</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shared</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]System.String</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>HPE.iLO.Response.RIBCL.IPv6NetworkSetting[] or HPE.iLO.Response.Redfish.IPv6NetworkSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>In case of iLO 5 servers, when the InterfaceType parameter is not provided, the cmdlet retrieves the data of the port in which NIC is enabled.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\>$out = ,$connection | Get-HPEiLOIPv6NetworkSetting IPv6Address : {HPE.iLO.Response.RIBCL.Address, HPE.iLO.Response.RIBCL.Address} IPv6StaticAddress : {HPE.iLO.Response.RIBCL.Address} IPv6StaticRoute : {HPE.iLO.Response.RIBCL.StaticRoute, HPE.iLO.Response.RIBCL.StaticRoute, HPE.iLO.Response.RIBCL.StaticRoute} DNSServer : {::, ::, ::} IPv6DefaultGateway : :: PreferredProtocol : Disabled StatelessAddressAutoConfiguration : Disabled RegisterDDNSServer : Enabled DHCPv6DomainName : Disabled DHCPv6DNSServer : Disabled DHCPv6RapidCommit : Disabled DHCPv6SNTPSetting : Disabled DHCPv6StatefulMode : Disabled DHCPv6StatelessMode : Enabled InterfaceType : Dedicated NICEnabled : Yes LinkSpeedMbps : Automatic FullDuplex : Automatic PermanentMACAddress : 38:63:bb:2c:bd:b9 MACAddress : 38:63:bb:2c:bd:b9 DNSName : DomainName : abcd SpeedAutoselect : Enabled MaxIPv6StaticAddress : 4 VLANEnabled : VLANID : SNPNICSetting : SNPPort : IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $out.IPv6Address | fl Value : fe80::aaaa:2aff:fe19:e15c Prefixlength : 64 AddressSource : SLAAC AddressStatus : ACTIVE PS C:\> $out.IPv6StaticRoute | fl Destination : :: PrefixLength : 0 Gateway : :: AddressStatus : INACTIVE Destination : :: PrefixLength : 0 Gateway : :: AddressStatus : INACTIVE Destination : :: PrefixLength : 0 Gateway : :: AddressStatus : INACTIVE</dev:code> <dev:remarks> <maml:para>This example shows the usage of the cmdlet on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.3 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOIPv6NetworkSetting -InterfaceType Dedicated IPv6Address : {HPE.iLO.Response.Redfish.Address} IPv6StaticRoute : {HPE.iLO.Response.Redfish.StaticRoute, HPE.iLO.Response.Redfish.StaticRoute, HPE.iLO.Response.Redfish.StaticRoute} IPv6StaticAddress : {HPE.iLO.Response.Redfish.StaticAddress, HPE.iLO.Response.Redfish.StaticAddress, HPE.iLO.Response.Redfish.StaticAddress, HPE.iLO.Response.Redfish.StaticAddress} DNSServer : {::, ::, ::} IPv6DefaultGateway : :: FullDuplex : Enabled MACAddress : FC:15:B4:97:2D:88 MaxIPv6StaticAddress : 4 DNSName : ILO123 DomainName : InterfaceType : Dedicated NICEnabled : Yes NICSupportsIPv6 : Yes PermanentMACAddress : FC:15:B4:97:2D:88 LinkSpeedMbps : 1000 LinkStatus : SpeedAutoSelect : Enabled StatelessAddressAutoConfiguration : Enabled RegisterDDNSServer : Enabled DHCPv6StatelessMode : Enabled DHCPv6StatefulMode : Enabled DHCPv6RapidCommit : Disabled DHCPv6DomainName : Enabled DHCPv6SNTPSetting : Enabled DHCPv6DNSServer : Enabled IPv6AddressPolicyTable : {HPE.iLO.Response.Redfish.AddressPolicyTable} VLANEnabled : VLANID : SettingResult : SNPNICSetting : SupportsFlexibleLOM : SupportsLOM : SNPPort : UEFIDevicePath : IP : 10.20.30.3 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $out.IPv6Address | fl Value : FE80::FE15:B4FF:FE97:2D88 AddressOrigin : SLAAC AddressState : Preferred PrefixLength : 64 Value : CE80::3EA8:2AFF:FE19:E15D AddressOrigin : Static AddressState : Preferred PrefixLength : 64 Value : CC80::3EA8:2AFF:FE19:E15D AddressOrigin : Static AddressState : Preferred PrefixLength : 64 Value : BE80::9657:A5FF:FE6A:D7EA AddressOrigin : Static AddressState : Preferred PrefixLength : 64 Value : DE80::3EA8:2AFF:FE19:E15D AddressOrigin : Static AddressState : Preferred PrefixLength : 44 PS C:\> $out.IPv6StaticAddress | fl Address : CE80::3EA8:2AFF:FE19:E15D PrefixLength : 64 Address : CC80::3EA8:2AFF:FE19:E15D PrefixLength : 64 Address : BE80::9657:A5FF:FE6A:D7EA PrefixLength : 64 PS C:\> $out.IPv6StaticRoute | fl Destination : :: Gateway : :: PrefixLength : Status : Unknown Destination : AE80::3EA8:2AFF:FE19:E15D Gateway : AB80::3EA8:2AFF:FE19:E15D PrefixLength : 64 Status : Active Destination : BB80::3EA8:2AFF:FE19:E15D Gateway : BA80::3EA8:2AFF:FE19:E15D PrefixLength : 64 Status : Failed PS C:\> $out.IPv6AddressPolicyTable | fl Label : Precedence : 35 Prefix : ::ffff:0:0/96 Address : DE80::3EA8:2AFF:FE19:E15D PrefixLength : 44</dev:code> <dev:remarks> <maml:para>This example shows the usage of the cmdlet on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEiLOIPv6NetworkSetting -Connection $connection IPv6Address : {HPE.iLO.Response.RIBCL.Address, HPE.iLO.Response.RIBCL.Address} IPv6StaticAddress : {HPE.iLO.Response.RIBCL.Address} IPv6StaticRoute : {HPE.iLO.Response.RIBCL.StaticRoute, HPE.iLO.Response.RIBCL.StaticRoute, HPE.iLO.Response.RIBCL.StaticRoute} DNSServer : {::, ::, ::} IPv6DefaultGateway : :: PreferredProtocol : Disabled StatelessAddressAutoConfiguration : Disabled RegisterDDNSServer : Enabled DHCPv6DomainName : Disabled DHCPv6DNSServer : Disabled DHCPv6RapidCommit : Disabled DHCPv6SNTPSetting : Disabled DHCPv6StatefulMode : Disabled DHCPv6StatelessMode : Enabled InterfaceType : Dedicated NICEnabled : Yes LinkSpeedMbps : Automatic LinkStatus : FullDuplex : Automatic PermanentMACAddress : 38:63:bb:2c:bd:b9 MACAddress : 38:63:bb:2c:bd:b9 DNSName : DomainName : abcd SpeedAutoselect : Enabled MaxIPv6StaticAddress : 4 VLANEnabled : VLANID : SettingResult : SNPNICSetting : SNPPort : UEFIDevicePath : IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : IPv6Address : {HPE.iLO.Response.Redfish.Address} IPv6StaticRoute : {HPE.iLO.Response.Redfish.StaticRoute, HPE.iLO.Response.Redfish.StaticRoute, HPE.iLO.Response.Redfish.StaticRoute} IPv6StaticAddress : {HPE.iLO.Response.Redfish.StaticAddress, HPE.iLO.Response.Redfish.StaticAddress, HPE.iLO.Response.Redfish.StaticAddress, HPE.iLO.Response.Redfish.StaticAddress} DNSServer : {::, ::, ::} IPv6DefaultGateway : :: FullDuplex : Enabled MACAddress : FC:15:B4:97:2D:88 MaxIPv6StaticAddress : 4 DNSName : ILO123 DomainName : InterfaceType : Dedicated NICEnabled : Yes NICSupportsIPv6 : Yes PermanentMACAddress : FC:15:B4:97:2D:88 LinkSpeedMbps : 1000 LinkStatus : SpeedAutoSelect : Enabled StatelessAddressAutoConfiguration : Enabled RegisterDDNSServer : Enabled DHCPv6StatelessMode : Enabled DHCPv6StatefulMode : Enabled DHCPv6RapidCommit : Disabled DHCPv6DomainName : Enabled DHCPv6SNTPSetting : Enabled DHCPv6DNSServer : Enabled IPv6AddressPolicyTable : {HPE.iLO.Response.Redfish.AddressPolicyTable} VLANEnabled : VLANID : SettingResult : SNPNICSetting : SupportsFlexibleLOM : SupportsLOM : SNPPort : UEFIDevicePath : IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOIPv6NetworkSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOKerberosConfig</command:name> <maml:description> <maml:para>Gets the Kerberos config detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOKerberosConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOKerberosConfig cmdlet gets the directory setting details related to the kerberos configuration in iLO.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOKerberosConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.KerberosConfig[] or HPE.iLO.Response.Redfish.KerberosConfig[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOKerberosConfig KerberosEnabled : Yes Realm : abcd KDCAddress : 2.2.2.2 KDCPort : 65 IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the usage of cmdlet on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOKerberosConfig KerberosEnabled : Yes Realm : abcd KDCAddress : 2.2.2.2 KDCPort : 65 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the usage of cmdlet on iLO 5 with connection objects passed as pipeline object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection= Connect-HPEiLO 10.20.30.1,10.20.30.2 admin admin123 -Disablecertificateauthentication PS C:\> Get-HPEiLOKerberosConfig -Connection $connection KerberosEnabled : Yes Realm : abcd KDCAddress : 2.2.2.2 KDCPort : 65 IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : KerberosEnabled : Yes Realm : abcd KDCAddress : 2.2.2.2 KDCPort : 65 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the usage of cmdlet on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOKerberosConfig</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-HPEiLOLanguage</command:name> <maml:description> <maml:para>Gets all languages on the iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOLanguage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOLanguage cmdlet gets the list of languages on the iLO and the default language of the iLO.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOLanguage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]System.String</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>HPE.iLO.Response.RIBCL.LanguageInfo[] or HPE.iLO.Response.Redfish.LanguageInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOLanguage PS C:\> $obj | fl DefaultLanguage : en Languages : {HPE.iLO.Response.RIBCL.Language} IP : 10.20.30.1 Hostname : bl465cgen8-01.powershvpn.com Status : OK StatusInfo : PS C:\> $obj.Languages | fl LanguageID : en TranslationName : English</dev:code> <dev:remarks> <maml:para>This example shows the usage of cmdlet on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOLanguage PS C:\> $obj | fl DefaultLanguage : en Languages : {HPE.iLO.Response.RIBCL.Language} IP : 10.20.30.1 Hostname : bl465cgen8-01.powershvpn.com Status : OK StatusInfo : PS C:\> $obj.Languages | fl LanguageID : ja TranslationName : 日本語</dev:code> <dev:remarks> <maml:para>This example shows the usage of cmdlet on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection= Connect-HPEiLO 10.20.30.1,10.20.30.2 admin admin123 -Disablecertificateauthentication PS C:\> Get-HPEiLOLanguage -Connection $connection | fl DefaultLanguage : en Languages : {HPE.iLO.Response.RIBCL.Language} IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : DefaultLanguage : en Languages : {HPE.iLO.Response.Redfish.Language} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the usage of cmdlet on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOLanguage</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-HPEiLOLDAPCACertificate</command:name> <maml:description> <maml:para>Gets LDAP CA certificate.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOLDAPCACertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets LDAP CA certificate from iLO server. Supported only on iLO5.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOLDAPCACertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.LDAPCACertificate[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 192.168.10.31 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $ldapca = $con | Get-HPEiLOLDAPCACertificate PS C:\> $ldapca Issuer : /DC=com/DC=powershvpn/CN=RootCApowershvpn-POWERSHELLVPN-CA SerialNumber : 77EDB29C82115E8349824B98AC3F9C2E Subject : /DC=com/DC=powershvpn/CN=RootCApowershvpn-POWERSHELLVPN-CA ValidNotAfter : 2019-01-03T06:50:13Z ValidNotBefore : 2017-01-03T06:40:13Z IP : 192.168.10.31 Hostname : bl460cgen10-03.powershvpn.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>Gets LDAP CA certificate from iLO5.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</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-HPEiLOLicense</command:name> <maml:description> <maml:para>Gets the license information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOLicense</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOLicense cmdlet gets the license information.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOLicense</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.LicenseInfo[] or HPE.iLO.Response.Redfish.LicenseInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOLicense License : iLO Advanced Key : 323JN-YRWP2-TJQWY-6VM9Q-N7V3R LicenseInstallDate : Sun Aug 19 19:15:09 2018 LicenseClass : FQL IP : 192.168.10.5 Hostname : ml350gen9-01.powershvpn.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $output = ,$connection | Get-HPEiLOLicense PS C:\> $output ConfirmationRequest : HPE.iLO.Response.Redfish.ConfirmationRequest Confirmation : HPE.iLO.Response.Redfish.Confirmation License : iLO Advanced LicenseExpire : LicenseError : LicenseClass : FQL LicenseFeatures : HPE.iLO.Response.Redfish.LicenseFeatures LicenseInstallDate : 8 Aug 2017 Key : 32Q6Y-PQWTX-H7XYL-3996Z-RR53R LicenseType : Perpetual LicenseTier : ADV IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $output.ConfirmationRequest | fl EON : HPE.iLO.Response.Redfish.EON Signer : iLO 5 System : HPE.iLO.Response.Redfish.System PS C:\Windows\system32> $output.ConfirmationRequest.EON | fl License : iLO Advanced Premium Security Edition Key : 32PWK-M3X2Y-BGP5M-4STNZ-V727N Quantity : 1 State : unconfirmed PS C:\> $output.ConfirmationRequest.System | fl ChipID : A212ED090016CB92 Product : ProLiant DL380 Gen10 SerialNumber : 123 PS C:\> $output.Confirmation | fl Code : Message : Status : false Service : reserved for liconf URI PS C:\> $output.LicenseFeatures | fl RemoteConsole : Yes VirtualMedia : Yes VirtualMediaScript : Yes DirectoryAuth : Yes DowngradePolicy : Yes PowerRegulator : Yes SmartCard : Yes KernelDebugging : Yes VideoCapture : Yes MultiUserRemoteConsole : Yes TextConsole : Yes RemoteSyslog : Yes EmailAlert : Yes VSPLogging : Yes KeyMgr : Yes Federation : Yes FWScan : Yes SuiteB : Yes SecureErase : Yes Jitter : Yes Recovery : Yes</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOLicense -Connection $connection License : iLO Advanced Key : 323JN-YRWP2-TJQWY-6VM9Q-N7V3R LicenseInstallDate : Sun Aug 19 19:15:09 2018 LicenseClass : FQL IP : 192.168.10.5 Hostname : ml350gen9-01.powershvpn.com Status : OK StatusInfo : ConfirmationRequest : HPE.iLO.Response.Redfish.ConfirmationRequest Confirmation : HPE.iLO.Response.Redfish.Confirmation License : iLO Advanced LicenseExpire : LicenseError : LicenseClass : FQL LicenseFeatures : HPE.iLO.Response.Redfish.LicenseFeatures LicenseInstallDate : 8 Aug 2017 Key : 32Q6Y-PQWTX-H7XYL-3996Z-RR53R LicenseType : Perpetual LicenseTier : ADV IP : 10.20.30.41 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOLicense</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-HPEiLOLogConfig</command:name> <maml:description> <maml:para>Get-HPEiLOLogConfig [<CommonParameters>]</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOLogConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOLogConfig</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> </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-HPEiLOLoginSecurityBanner</command:name> <maml:description> <maml:para>Gets the security message for the iLO login screen.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOLoginSecurityBanner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSecurityMessage cmdlet gets the security message to be displayed on the iLO login screen.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOLoginSecurityBanner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.LoginSecurityBanner[] or HPE.iLO.Response.Redfish.LoginSecurityBanner[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOLoginSecurityBanner SecurityMessageEnabled : Yes SecurityMessageText : securitymessage IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusMessage :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> $obj = Get-HPEiLOLoginSecutityBanner -Connection $connection SecurityMessageEnabled : Yes SecurityMessageText : This iLO is reserved for iLO testing IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : SecurityMessageEnabled : Yes SecurityMessageText : securitymessage IP : 10.20.30.41 Hostname : qwerty.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEiLOLoginSecurityBanner</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-HPEiLOMaintenanceWindow</command:name> <maml:description> <maml:para>Gets the maintenance window information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOMaintenanceWindow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOMaintenanceWindow cmdlet gets the maintenance window information. A maintenance window is a configured time period that applies to an installation task. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOMaintenanceWindow</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.MaintenanceWindow[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOMaintenanceWindow PS C:\> $out MaintenanceWindowInfo : {HPE.iLO.Response.Redfish.MaintenanceWindowInfo, HPE.iLO.Response.Redfish.MaintenanceWindowInfo} IP : 10.20.30.2 Hostname : abc.com Status : OK StatusInfo : PS C:\> $out.MaintenanceWindowInfo Id : a10a33e5 Name : TestMaint Created : 2018-09-24T04:26:05Z Description : This is a test maintenance window StartAfter : 9/28/2018 3:15:00 AM Expire : 9/29/2018 3:15:00 AM Modified : 9/24/2018 4:26:05 AM Id : 44134038 Name : Maint Created : 2018-09-24T04:33:33Z Description : This is a test maintenance window StartAfter : 9/24/2018 10:02:50 AM Expire : 9/26/2018 10:03:06 AM Modified : 9/24/2018 4:33:33 AM</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2,10.20.30.1 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOMaintenanceWindow PS C:\> $out MaintenanceWindowInfo : {HPE.iLO.Response.Redfish.MaintenanceWindowInfo, HPE.iLO.Response.Redfish.MaintenanceWindowInfo} IP : 10.20.30.2 Hostname : abc.com Status : OK StatusInfo : MaintenanceWindowInfo : {HPE.iLO.Response.Redfish.MaintenanceWindowInfo, HPE.iLO.Response.Redfish.MaintenanceWindowInfo} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with an array of connection objects passed as pipeline parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOMaintenanceWindow</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-HPEiLOMaxThreadLimit</command:name> <maml:description> <maml:para>Gets the maximum number of threads that can be spawned by the cmdlets of the HPEiLOCmdlets module.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOMaxThreadLimit</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOMaxThreadLimit cmdlet returns the maximum number of parallel threads that will be created by the cmdlet of this module. Parallel threads are created when a cmdlet intents to fetch information from multiple targets.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOMaxThreadLimit</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Get-HPEiLOMaxThreadLimit 256</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOMaxThreadLimit</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-HPEiLOMemoryInfo</command:name> <maml:description> <maml:para>Gets the memory details for the host server where the iLO is located.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOMemoryInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOMemoryInfo cmdlet gets the memory details for the host server where the iLO is located. This includes AdvancedMemoryProtection, MemoryDetailsSummary, and MemoryDetails for each CPU.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOMemoryInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.MemoryInfo[] or HPE.iLO.Response.Redfish.MemoryInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = connect-hpeilo 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> $obj = ,$connection | Get-HPEiLOMemoryInfo PS C:\> $obj AdvancedMemoryProtection : HPE.iLO.Response.RIBCL.AdvancedMemoryProtection MemoryDetailsSummary : {HPE.iLO.Response.RIBCL.MemoryDetailsSummary, HPE.iLO.Response.RIBCL.MemoryDetailsSummary} MemoryDetails : {HPE.iLO.Response.RIBCL.MemoryDetails, HPE.iLO.Response.RIBCL.MemoryDetails} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $obj.AdvancedMemoryProtection | fl AmpModeActive : Advanced ECC AmpModeStatus : Advanced ECC AmpModeSupported : {Advanced ECC, Online Spare (Rank Sparing), Intrasocket Mirroring} PS C:\> $obj.MemoryDetailsSummary CPUNumber : 1 NumberOfSockets : 12 TotalMemorySizeGB : 16 OperatingFrequencyMHz : 2133 OperatingVoltage : 1.20 CPUNumber : 2 NumberOfSockets : 12 TotalMemorySizeGB : 16 OperatingFrequencyMHz : 2133 OperatingVoltage : 1.20 PS C:\> $obj.MemoryDetails | fl CPUNumber : 1 MemoryData : {HPE.iLO.Response.RIBCL.MemoryData, HPE.iLO.Response.RIBCL.MemoryData, HPE.iLO.Response.RIBCL.MemoryData, HPE.iLO.Response.RIBCL.MemoryData...} CPUNumber : 2 MemoryData : {HPE.iLO.Response.RIBCL.MemoryData, HPE.iLO.Response.RIBCL.MemoryData, HPE.iLO.Response.RIBCL.MemoryData, HPE.iLO.Response.RIBCL.MemoryData...} PS C:\> $obj.MemoryDetails[0].MemoryData BaseModuleType : N/A CapacityMiB : HPSmartMemory : N/A MemoryDeviceType : N/A MemoryLocation : HPE.iLO.Response.RIBCL.MemoryLocation DIMMStatus : NotPresent MinimumVoltageVolts : OperatingSpeedMHz : PartNumber : N/A RankCount : N/A BaseModuleType : N/A CapacityMiB : HPSmartMemory : N/A MemoryDeviceType : N/A MemoryLocation : HPE.iLO.Response.RIBCL.MemoryLocation DIMMStatus : NotPresent MinimumVoltageVolts : OperatingSpeedMHz : PartNumber : N/A RankCount : N/A BaseModuleType : N/A CapacityMiB : HPSmartMemory : N/A MemoryDeviceType : N/A MemoryLocation : HPE.iLO.Response.RIBCL.MemoryLocation DIMMStatus : NotPresent MinimumVoltageVolts : OperatingSpeedMHz : PartNumber : N/A RankCount : N/A BaseModuleType : N/A CapacityMiB : HPSmartMemory : N/A MemoryDeviceType : N/A MemoryLocation : HPE.iLO.Response.RIBCL.MemoryLocation DIMMStatus : NotPresent MinimumVoltageVolts : OperatingSpeedMHz : PartNumber : N/A RankCount : N/A BaseModuleType : N/A CapacityMiB : HPSmartMemory : N/A MemoryDeviceType : N/A MemoryLocation : HPE.iLO.Response.RIBCL.MemoryLocation DIMMStatus : NotPresent MinimumVoltageVolts : OperatingSpeedMHz : PartNumber : N/A RankCount : N/A BaseModuleType : N/A CapacityMiB : HPSmartMemory : N/A MemoryDeviceType : N/A MemoryLocation : HPE.iLO.Response.RIBCL.MemoryLocation DIMMStatus : NotPresent MinimumVoltageVolts : OperatingSpeedMHz : PartNumber : N/A RankCount : N/A BaseModuleType : N/A CapacityMiB : HPSmartMemory : N/A MemoryDeviceType : N/A MemoryLocation : HPE.iLO.Response.RIBCL.MemoryLocation DIMMStatus : NotPresent MinimumVoltageVolts : OperatingSpeedMHz : PartNumber : N/A RankCount : N/A BaseModuleType : N/A CapacityMiB : HPSmartMemory : N/A MemoryDeviceType : N/A MemoryLocation : HPE.iLO.Response.RIBCL.MemoryLocation DIMMStatus : NotPresent MinimumVoltageVolts : OperatingSpeedMHz : PartNumber : N/A RankCount : N/A BaseModuleType : N/A CapacityMiB : HPSmartMemory : N/A MemoryDeviceType : N/A MemoryLocation : HPE.iLO.Response.RIBCL.MemoryLocation DIMMStatus : NotPresent MinimumVoltageVolts : OperatingSpeedMHz : PartNumber : N/A RankCount : N/A BaseModuleType : N/A CapacityMiB : HPSmartMemory : N/A MemoryDeviceType : N/A MemoryLocation : HPE.iLO.Response.RIBCL.MemoryLocation DIMMStatus : NotPresent MinimumVoltageVolts : OperatingSpeedMHz : PartNumber : N/A RankCount : N/A BaseModuleType : N/A CapacityMiB : HPSmartMemory : N/A MemoryDeviceType : N/A MemoryLocation : HPE.iLO.Response.RIBCL.MemoryLocation DIMMStatus : NotPresent MinimumVoltageVolts : OperatingSpeedMHz : PartNumber : N/A RankCount : N/A BaseModuleType : RDIMM CapacityMiB : 16384 HPSmartMemory : Yes MemoryDeviceType : DIMM DDR4 MemoryLocation : HPE.iLO.Response.RIBCL.MemoryLocation DIMMStatus : GoodInUse MinimumVoltageVolts : 1.20 OperatingSpeedMHz : 2133 PartNumber : 752369-081 RankCount : 2</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = Get-HPEiLOMemoryInfo -Connection $connection PS C:\> $obj AdvancedMemoryProtection : HPE.iLO.Response.Redfish.AdvancedMemoryProtection MemoryDetailsSummary : {HPE.iLO.Response.Redfish.MemoryDetailsSummary, HPE.iLO.Response.Redfish.MemoryDetailsSummary} MemoryDetails : {HPE.iLO.Response.Redfish.MemoryDetails, HPE.iLO.Response.Redfish.MemoryDetails} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $obj.AdvancedMemoryProtection | fl AmpModeActive : AdvancedECC AmpModeStatus : AdvancedECC AmpModeSupported : {AdvancedECC, OnlineSpareRank, IntrasocketMirroring, A3DC} PS C:\> $obj.MemoryDetailsSummary CPUNumber : 1 NumberOfSockets : 12 TotalMemorySizeGB : 8192 OperatingFrequencyMHz : 2400 OperatingVoltage : 1200 CPUNumber : 2 NumberOfSockets : 12 TotalMemorySizeGB : 0 OperatingFrequencyMHz : 2400 OperatingVoltage : 1200 PS C:\> $obj.MemoryDetails | fl CPUNumber : 1 MemoryData : {HPE.iLO.Response.Redfish.MemoryData, HPE.iLO.Response.Redfish.MemoryData, HPE.iLO.Response.Redfish.MemoryData, HPE.iLO.Response.Redfish.MemoryData...} CPUNumber : 2 MemoryData : {HPE.iLO.Response.Redfish.MemoryData, HPE.iLO.Response.Redfish.MemoryData, HPE.iLO.Response.Redfish.MemoryData, HPE.iLO.Response.Redfish.MemoryData...} PS C:\> $obj.MemoryDetails[0].MemoryData[0] BaseModuleType : RDIMM BusWidthBits : 72 CapacityMiB : 8192 DataWidthBits : 64 DeviceLocator : PROC 1 DIMM 1 DeviceID : ErrorCorrection : MultiBitECC FirmwareRevision : Manufacturer : MemoryDeviceType : DDR4 MemoryLocation : HPE.iLO.Response.Redfish.MemoryLocation MemoryMedia : {DRAM} MemoryType : DRAM Name : proc1dimm1 Armed : Attributes : DIMMStatus : GoodInUse MaxOperatingSpeedMTs: 1266 MinimumVoltageVolts : 12 PredictedMediaLifeLeftPercent : ProductName : SPDBytes : RelatedPhysicalDIMMs : RelatedBackupStores : RelatedPowerBackupUnitBays : OperatingMemoryModes : OperatingSpeedMHz : 2400 PartNumber : PersistentRegionSizeLimitMiB : RankCount : 1 SerialNumber : Status : OK SubsystemDeviceID : SubsystemVendorID : VendorName: Samsung VendorID : 44288 VolatileRegionSizeLimitMiB :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = connect-hpeilo 10.20.30.40 admin admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOMemoryInfo PS C:\> $out MemoryComponent : {HPE.iLO.Response.RIBCL.MemoryComponent, HPE.iLO.Response.RIBCL.MemoryComponent, HPE.iLO.Response.RIBCL.MemoryComponent, HPE.iLO.Response.RIBCL.MemoryComponent...} IP : 10.20.30.40 Hostname : bl460cgen7-01.powershvpn.com Status : OK StatusInfo : PS C:\> $out.MemoryComponent | fl MemoryLocation : PROC 1 DIMM 1D MemorySizeMB : Not Installed MemorySpeedMHz : 0 MemoryLocation : PROC 1 DIMM 2A MemorySizeMB : 8192 MemorySpeedMHz : 1333 MemoryLocation : PROC 1 DIMM 3E MemorySizeMB : Not Installed MemorySpeedMHz : 0 MemoryLocation : PROC 1 DIMM 4B MemorySizeMB : 8192 MemorySpeedMHz : 1333 MemoryLocation : PROC 1 DIMM 5F MemorySizeMB : Not Installed MemorySpeedMHz : 0 MemoryLocation : PROC 1 DIMM 6C MemorySizeMB : 8192 MemorySpeedMHz : 1333 MemoryLocation : PROC 2 DIMM 1D MemorySizeMB : Not Installed MemorySpeedMHz : 0 MemoryLocation : PROC 2 DIMM 2A MemorySizeMB : 8192 MemorySpeedMHz : 1333 MemoryLocation : PROC 2 DIMM 3E MemorySizeMB : Not Installed MemorySpeedMHz : 0 MemoryLocation : PROC 2 DIMM 4B MemorySizeMB : 8192 MemorySpeedMHz : 1333 MemoryLocation : PROC 2 DIMM 5F MemorySizeMB : Not Installed MemorySpeedMHz : 0 MemoryLocation : PROC 2 DIMM 6C MemorySizeMB : 8192 MemorySpeedMHz : 1333</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Get-HPEiLOMemoryInfo -Connection $connection | fl AdvancedMemoryProtection : HPE.iLO.Response.RIBCL.AdvancedMemoryProtection MemoryDetailsSummary : {HPE.iLO.Response.RIBCL.MemoryDetailsSummary, HPE.iLO.Response.RIBCL.MemoryDetailsSummary} MemoryDetails : {HPE.iLO.Response.RIBCL.MemoryDetails, HPE.iLO.Response.RIBCL.MemoryDetails} IP : 10.20.30.40 Hostname : abc.com Status : OK StatusInfo : AdvancedMemoryProtection : HPE.iLO.Response.RIBCL.AdvancedMemoryProtection MemoryDetailsSummary : {HPE.iLO.Response.RIBCL.MemoryDetailsSummary, HPE.iLO.Response.RIBCL.MemoryDetailsSummary} MemoryDetails : {HPE.iLO.Response.RIBCL.MemoryDetails, HPE.iLO.Response.RIBCL.MemoryDetails} IP : 10.20.30.41 Hostname : abcd.com Status : OK StatusInfo : AdvancedMemoryProtection : HPE.iLO.Response.Redfish.AdvancedMemoryProtection MemoryDetailsSummary : {HPE.iLO.Response.Redfish.MemoryDetailsSummary, HPE.iLO.Response.Redfish.MemoryDetailsSummary} MemoryDetails : {HPE.iLO.Response.Redfish.MemoryDetails, HPE.iLO.Response.Redfish.MemoryDetails} IP : 10.20.30.42 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 5</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $con = Connect-HPEiLO 192.168.10.42 admin admin123 -DisableCertificateAuthentication PS C:\> $s = $con | Get-HPEiLOMemoryInfo PS C:\> $s.MemoryInfo.MemoryDetails[0].MemoryData[0] BaseModuleType : BusWidthBits : 72 CapacityMiB : 0 DataWidthBits : 64 DeviceLocator : PROC 1 DIMM 1 DeviceID : ErrorCorrection : MultiBitECC FirmwareRevision : Manufacturer : MemoryDeviceType : DDR4 MemoryLocation : HPE.iLO.Response.Redfish.MemoryLocation MemoryMedia : {DRAM} MemoryType : DRAM Name : proc1dimm1 Armed : Attributes : DIMMStatus : NotPresent MaxOperatingSpeedMTs: MinimumVoltageVolts : 0 PredictedMediaLifeLeftPercent : ProductName : SPDBytes : RelatedPhysicalDIMMs : RelatedBackupStores : RelatedPowerBackupUnitBays : OperatingMemoryModes : OperatingSpeedMHz : PartNumber : PersistentRegionSizeLimitMiB : 0 RankCount : SerialNumber : Socket : 1 Slot : 1 Status : HPE.iLO.Response.Redfish.Status SubsystemDeviceID : SubsystemVendorID : VendorID : 0 VendorName: FirmwareApiVersion : SecurityStates : VolatileRegionSizeLimitMiB : 0 VolatileRegionNumberLimit : VolatileRegionSizeMaxMiB : VolatileSizeMiB : 0 AllocationIncrementMiB : AllocationAlignmentMiB : CacheSizeMiB : 0 LogicalSizeMiB : 0 NonVolatileSizeMiB : 0 PersistentRegionNumberLimit : PersistentRegionSizeMaxMiB : MemoryChunkSizePercentage : Regions : SecurityCapabilities : HPE.iLO.Response.Redfish.SecurityCapabilities</dev:code> <dev:remarks> <maml:para>Gets new memory details added in iLO5.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOModuleVersion</command:name> <maml:description> <maml:para>Gets the module details of the installed HPEiLOCmdlets module.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOModuleVersion</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOModuleVersion cmdlet gets the module details of the installed HPEiLOCmdlets 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:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOModuleVersion</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>ModuleInformation[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>C:\PS> Get-HPEiLOModuleVersion Name : HPEiLOCmdlets Path : C:\Program Files\Hewlett Packard Enterprise\PowerShell\Modules\HPEiLOCmdlets\HPEiLOCmdlets.dll Description : Scripting Tools for Windows PowerShell : iLO Cmdlets use the RIBCL and Redfish interface to communicate to iLO. These cmdlets can be used to configure and manage iLO on HPE ProLiant Gen8, Gen9 or Gen10 servers. GUID : 4d93d4cf-72b1-4d1a-a247-bef198bebf96 CurrentUICultureName : en-US CurrentUICultureVersion : Version : 2.0.0.0 DotNetVersion : 4.6.1 PSVersion : @{PSVersion=5.0.10586.117; PSCompatibleVersions=System.Version[]; BuildVersion=10.0.10586.117; CLRVersion=4.0.30319.42000; WSManStackVersion=3.0; PSRemotingProtocolVersion=2.3; SerializationVersion=1.1.0.1} OSVersion : @{Caption=Microsoft Windows 8.1 Enterprise; CSDVersion=; Version=6.3.9600; BuildNumber=9600} CCGVersion : 1.2.0.6 AvailableUICulture : {}</dev:code> <dev:remarks> <maml:para>This example shows the output of the Get-HPEiLOModuleVersion cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-HPEiLOModuleVersion</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-HPEiLONICInfo</command:name> <maml:description> <maml:para>Gets the NIC details for the system NIC and the iLO NIC.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLONICInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLONICInfo cmdlet gets the NIC details of the system NIC and the iLO NIC. These details include IP address, MAC Address, network port, and port description for both the system NICs and the iLO NICs.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLONICInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.NICInfo[] or HPE.iLO.Response.Redfish.NICInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLONICInfo EthernetInterface : {HPE.iLO.Response.RIBCL.EthernetInterface, HPE.iLO.Response.RIBCL.EthernetInterface} NetworkAdapter : {HPE.iLO.Response.RIBCL.NetworkAdapter, HPE.iLO.Response.RIBCL.NetworkAdapter, HPE.iLO.Response.RIBCL.NetworkAdapter} IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.EthernetInterface NetworkPort : Port 1 PortDescription : iLO 4 Location : Embedded IPAddress : 10.20.30.2 MACAddress : 3c:a8:2a:19:e1:5c Status : OK NetworkPort : Port 2 PortDescription : iLO 4 Location : Embedded IPAddress : Unknown MACAddress : 3c:a8:2a:19:e1:5d Status : Disabled PS C:\> $out.NetworkAdapter | fl Name : Broadcom NetXtreme Gigabit Ethernet Ports : {HPE.iLO.Response.RIBCL.Ports, HPE.iLO.Response.RIBCL.Ports, HPE.iLO.Response.RIBCL.Ports, HPE.iLO.Response.RIBCL.Ports} Name : HPE FlexFabric 10Gb 2-port 533FLR-T Adapter Ports : {HPE.iLO.Response.RIBCL.Ports, HPE.iLO.Response.RIBCL.Ports} Name : Intel(R) I350 Gigabit Network Connection Ports : {HPE.iLO.Response.RIBCL.Ports, HPE.iLO.Response.RIBCL.Ports} PS C:\> $out.NetworkAdapter[0].Ports NetworkPort : Port 1 Location : Embedded IPAddress : N/A MACAddress : 3c:a8:2a:0a:af:3c Status : Unknown NetworkPort : Port 2 Location : Embedded IPAddress : N/A MACAddress : 3c:a8:2a:0a:af:3d Status : Unknown NetworkPort : Port 3 Location : Embedded IPAddress : N/A MACAddress : 3c:a8:2a:0a:af:3e Status : Unknown NetworkPort : Port 4 Location : Embedded IPAddress : 169.254.168.129 MACAddress : 3c:a8:2a:0a:af:3f Status : OK</dev:code> <dev:remarks> <maml:para>This example shows the usage of the cmdlet on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLONICInfo EthernetInterface : {HPE.iLO.Response.Redfish.EthernetInterface, HPE.iLO.Response.Redfish.EthernetInterface} NetworkAdapter : {HPE.iLO.Response.Redfish.NetworkAdapter} IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.EthernetInterface Name : Manager Dedicated Network Interface InterfaceType : Dedicated IPv4Address : 10.20.30.2 IPv6Address : FE80::FE15:B4FF:FE97:2D88 MACAddress : FC:15:B4:97:2D:88 NICEnabled : Yes NICSupportsIPv6 : No Status : HPE.iLO.Response.Redfish.Status Name : Manager Shared Network Interface InterfaceType : Shared IPv4Address : 10.20.30.2 IPv6Address : MACAddress : FC:15:B4:97:2D:89 NICEnabled : No NICSupportsIPv6 : Yes Status : HPE.iLO.Response.Redfish.Status PS C:\> $out.NetworkAdapter Name : HPE Ethernet 1Gb 4-port 331i Adapter - NIC Id : 1 PartNumber : SerialNumber : Firmware : 20.6.315 StructuredName : NIC.LOM.1.1 UEFIDevicePath : PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0) Ports : {, , , } FcPorts : Status : HPE.iLO.Response.Redfish.Status</dev:code> <dev:remarks> <maml:para>This example shows the usage of cmdlet on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEiLONICInfo -Connection $connection EthernetInterface : {HPE.iLO.Response.RIBCL.EthernetInterface, HPE.iLO.Response.RIBCL.EthernetInterface} NetworkAdapter : {HPE.iLO.Response.RIBCL.NetworkAdapter, HPE.iLO.Response.RIBCL.NetworkAdapter, HPE.iLO.Response.RIBCL.NetworkAdapter} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : EthernetInterface : {HPE.iLO.Response.Redfish.EthernetInterface, HPE.iLO.Response.Redfish.EthernetInterface} NetworkAdapter : {HPE.iLO.Response.Redfish.NetworkAdapter} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOOAInfo</command:name> <maml:description> <maml:para>Gets the Onboard Administrator information from the enclosure where iLO is located.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOOAInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOOAInfo cmdlet gets Onboard Administrator information from the enclosure where iLO is located. This cmdlet block is only valid on ProLiant BL c-Class blade servers. This cmdlet is supported only on iLO 4 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOOAInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.OAInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOOAInfo OAIPv4Address : 192.168.10.202 OAIPv6Address : {fe54::4fe2:4aab:34ac:feff:dedf, 2001:1000:0:1::100, fe80::3a63:bbff:fe31:66af} MACAddress : 38:63:bb:31:66:af Rack : Poseidon_C7K_Test Enclosure : Poseidon_C7000 Location : 4 SystemHealth : 1 UIDStatus : Off IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the usage of the cmdlet on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1-2 -Username admin -Password admin123 PS C:\> Get-HPEiLOOAInfo -Connection $connection OAIPv4Address : 192.168.10.202 OAIPv6Address : {fe54::4fe2:4aab:34ac:feff:dedf, 2001:1000:0:1::100, fe80::3a63:bbff:fe31:66af} MACAddress : 38:63:bb:31:66:af Rack : Poseidon_C7K_Test Enclosure : Poseidon_C7000 Location : 4 SystemHealth : 1 UIDStatus : Off IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : OAIPv4Address : 192.168.10.202 OAIPv6Address : {fe54::4fe2:4aab:34ac:feff:dedf, 2001:1000:0:1::100, fe80::3a63:bbff:fe31:66af} MACAddress : 38:63:bb:31:66:af Rack : Poseidon_C7K_Test Enclosure : Poseidon_C7000 Location : 4 SystemHealth : 1 IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOOneTimeBootOption</command:name> <maml:description> <maml:para>Gets the current state of the one-time boot.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOOneTimeBootOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOOneTimeBootOption cmdlet gets the current state of the one-time boot. The returned data values include: . PXE . CD · None · Floppy · HDD · USB · Diags . Emb-Menu . Emb-ACU . Emb-HPSUM-Auto . BIOSSetup . UEFIShell . UEFITarget . UEFIHTTP . IntelligentProvisioning</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOOneTimeBootOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.OneTimeBootOption[] or HPE.iLO.Response.Redfish.OneTimeBootOption[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOOneTimeBootOption BootSourceOverrideTarget : CD IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOOneTimeBootOption BootSourceOverrideEnable : Once BootSourceOverrideMode : UEFI BootSourceOverrideTarget : CD BootSourceOverrideTargetSupportedValues : {None, CD, HDD, USB...} UEFITargetBootSourceOverride : None UEFITargetBootSourceOverrideSupportedValues : {HD(1,GPT,CCCBCA79-1F28-457B-9946-4CCCF81FB3B6,0x800,0x32000)/ \EFI\Microsoft\Boot\bootmgfw.efi, UsbClass(0xFFFF,0xFFFF,0xFF,0xFF,0xFF), PciRoot(0x0)/Pci(0x1C, 0x0)/Pci(0x0,0x0)/MAC(FC15B4972EAA,0x0)/IPv4(0.0.0.0)/Uri(), P ciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(FC15B4972EAA,0x0)/I Pv4(0.0.0.0)...} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOOneTimeBootOption -Connection $connection BootSourceOverrideTarget : CD IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : BootSourceOverrideEnable : Once BootSourceOverrideMode : UEFI BootSourceOverrideTarget : CD BootSourceOverrideTargetSupportedValues : {None, CD, HDD, USB...} UEFITargetBootSourceOverride : None UEFITargetBootSourceOverrideSupportedValues : {HD(1,GPT,CCCBCA79-1F28-457B-9946-4CCCF81FB3B6,0x800,0x32000)/ \EFI\Microsoft\Boot\bootmgfw.efi, UsbClass(0xFFFF,0xFFFF,0xFF,0xFF,0xFF), PciRoot(0x0)/Pci(0x1C, 0x0)/Pci(0x0,0x0)/MAC(FC15B4972EAA,0x0)/IPv4(0.0.0.0)/Uri(), P ciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0)/MAC(FC15B4972EAA,0x0)/I Pv4(0.0.0.0)...} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOOneTimeBootOption</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-HPEiLOPCIDeviceInventory</command:name> <maml:description> <maml:para>Gets the PCI device Inventory information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPCIDeviceInventory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOPCIDeviceInventory cmdlet gets the PCI Device Inventory information. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPCIDeviceInventory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.PCIDeviceInventory[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOPCIDeviceInventory PS C:\> $out PCIDevice : {HPE.iLO.Response.Redfish.PCIDevice, HPE.iLO.Response.Redfish.PCIDevice, HPE.iLO.Response.Redfish.PCIDevice, HPE.iLO.Response.Redfish.PCIDevice...} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.PCIDevice BayNumber : BusNumber : ClassCode : 2 DeviceID : 5719 DeviceInstance : 1 DeviceLocation : DeviceNumber : DeviceSubInstance : 1 DeviceType : Embedded LOM EnclosureNumber : FunctionNumber : Id : 1 LocationString : Embedded LOM 1 Name : HPE Ethernet 1Gb 4-port 331i Adapter - NIC SegmentNumber : StructuredName : NIC.LOM.1.1 SubclassCode : 0 SubsystemDeviceID : 8894 SubsystemVendorID : 4156 UEFIDevicePath : PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x0) VendorID : 5348 BayNumber : BusNumber : ClassCode : 2 DeviceID : 5719 DeviceInstance : 1 DeviceLocation : DeviceNumber : DeviceSubInstance : 2 DeviceType : Embedded LOM EnclosureNumber : FunctionNumber : Id : 2 LocationString : Embedded LOM 1 Name : HPE Ethernet 1Gb 4-port 331i Adapter - NIC SegmentNumber : StructuredName : NIC.LOM.1.2 SubclassCode : 0 SubsystemDeviceID : 8894 SubsystemVendorID : 4156 UEFIDevicePath : PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x1) VendorID : 5348 BayNumber : BusNumber : ClassCode : 2 DeviceID : 5719 DeviceInstance : 1 DeviceLocation : DeviceNumber : DeviceSubInstance : 3 DeviceType : Embedded LOM EnclosureNumber : FunctionNumber : Id : 3 LocationString : Embedded LOM 1 Name : HPE Ethernet 1Gb 4-port 331i Adapter - NIC SegmentNumber : StructuredName : NIC.LOM.1.3 SubclassCode : 0 SubsystemDeviceID : 8894 SubsystemVendorID : 4156 UEFIDevicePath : PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x2) VendorID : 5348 BayNumber : BusNumber : ClassCode : 2 DeviceID : 5719 DeviceInstance : 1 DeviceLocation : DeviceNumber : DeviceSubInstance : 4 DeviceType : Embedded LOM EnclosureNumber : FunctionNumber : Id : 4 LocationString : Embedded LOM 1 Name : HPE Ethernet 1Gb 4-port 331i Adapter - NIC SegmentNumber : StructuredName : NIC.LOM.1.4 SubclassCode : 0 SubsystemDeviceID : 8894 SubsystemVendorID : 4156 UEFIDevicePath : PciRoot(0x0)/Pci(0x1C,0x0)/Pci(0x0,0x3) VendorID : 5348 BayNumber : BusNumber : ClassCode : 1 DeviceID : 41478 DeviceInstance : 1 DeviceLocation : DeviceNumber : DeviceSubInstance : 1 DeviceType : Storage Controller EnclosureNumber : FunctionNumber : Id : 5 LocationString : Embedded SATA Controller #1 Name : Embedded SATA Controller #1 SegmentNumber : StructuredName : SATA.Emb.1.1 SubclassCode : 4 SubsystemDeviceID : 229 SubsystemVendorID : 5520 UEFIDevicePath : PciRoot(0x0)/Pci(0x17,0x0) VendorID : 32902 BayNumber : BusNumber : ClassCode : 1 DeviceID : 41558 DeviceInstance : 2 DeviceLocation : DeviceNumber : DeviceSubInstance : 1 DeviceType : Storage Controller EnclosureNumber : FunctionNumber : Id : 6 LocationString : Embedded SATA Controller #2 Name : Embedded SATA Controller #2 SegmentNumber : StructuredName : SATA.Emb.2.1 SubclassCode : 4 SubsystemDeviceID : 230 SubsystemVendorID : 5520 UEFIDevicePath : PciRoot(0x0)/Pci(0x11,0x5) VendorID : 32902 BayNumber : BusNumber : ClassCode : 1 DeviceID : 6463 DeviceInstance : 1 DeviceLocation : DeviceNumber : DeviceSubInstance : 1 DeviceType : Dynamic Storage Array Controller EnclosureNumber : FunctionNumber : Id : 7 LocationString : Embedded Storage Name : HPE Smart Array S100i SR Gen10 SegmentNumber : StructuredName : SWRAID.Emb.1.1 SubclassCode : 4 SubsystemDeviceID : 228 SubsystemVendorID : 5520 UEFIDevicePath : PciRoot(0x0)/Pci(0x1C,0x4)/Pci(0x0,0x7) VendorID : 4156 BayNumber : BusNumber : ClassCode : 1 DeviceID : 655 DeviceInstance : 1 DeviceLocation : DeviceNumber : DeviceSubInstance : 1 DeviceType : Storage Array Controller EnclosureNumber : FunctionNumber : Id : 8 LocationString : Embedded RAID 1 Name : HPE Smart Array P816i-a SR Gen10 SegmentNumber : StructuredName : RAID.Emb.1.1 SubclassCode : 7 SubsystemDeviceID : 4352 SubsystemVendorID : 4156 UEFIDevicePath : PciRoot(0x3)/Pci(0x0,0x0)/Pci(0x0,0x0) VendorID : 36869 BayNumber : 0 BusNumber : ClassCode : 3 DeviceID : 1336 DeviceInstance : 0 DeviceLocation : DeviceNumber : DeviceSubInstance : 0 DeviceType : Unknown EnclosureNumber : 0 FunctionNumber : Id : 9 LocationString : Embedded Video Controller Name : Embedded Video Controller SegmentNumber : StructuredName : PCI.Unknown.1.1 SubclassCode : 0 SubsystemDeviceID : 228 SubsystemVendorID : 5520 UEFIDevicePath : PciRoot(0x0)/Pci(0x1C,0x4)/Pci(0x0,0x1) VendorID : 4139 BayNumber : BusNumber : ClassCode : 255 DeviceID : 65535 DeviceInstance : 1 DeviceLocation : DeviceNumber : DeviceSubInstance : 1 DeviceType : Other PCI Device EnclosureNumber : FunctionNumber : Id : 10 LocationString : Slot 1 Name : Empty slot 1 SegmentNumber : StructuredName : PCI.Slot.1.1 SubclassCode : 255 SubsystemDeviceID : 65535 SubsystemVendorID : 65535 UEFIDevicePath : PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0) VendorID : 65535 BayNumber : BusNumber : ClassCode : 255 DeviceID : 65535 DeviceInstance : 1 DeviceLocation : DeviceNumber : DeviceSubInstance : 1 DeviceType : Other PCI Device EnclosureNumber : FunctionNumber : Id : 11 LocationString : Slot 1 Name : Empty slot 3 SegmentNumber : StructuredName : PCI.Slot.1.1 SubclassCode : 255 SubsystemDeviceID : 65535 SubsystemVendorID : 65535 UEFIDevicePath : PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0) VendorID : 65535 BayNumber : BusNumber : ClassCode : 255 DeviceID : 65535 DeviceInstance : 1 DeviceLocation : DeviceNumber : DeviceSubInstance : 1 DeviceType : Other PCI Device EnclosureNumber : FunctionNumber : Id : 12 LocationString : Slot 1 Name : Empty slot 2 SegmentNumber : StructuredName : PCI.Slot.1.1 SubclassCode : 255 SubsystemDeviceID : 65535 SubsystemVendorID : 65535 UEFIDevicePath : PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0) VendorID : 65535 BayNumber : BusNumber : ClassCode : 255 DeviceID : 65535 DeviceInstance : 1 DeviceLocation : DeviceNumber : DeviceSubInstance : 1 DeviceType : Other PCI Device EnclosureNumber : FunctionNumber : Id : 13 LocationString : Slot 1 Name : SegmentNumber : StructuredName : PCI.Slot.1.1 SubclassCode : 255 SubsystemDeviceID : 65535 SubsystemVendorID : 65535 UEFIDevicePath : PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0) VendorID : 65535</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOPCIDeviceInventory -Connection $connection PCIDevice : {HPE.iLO.Response.Redfish.PCIDevice, HPE.iLO.Response.Redfish.PCIDevice, HPE.iLO.Response.Redfish.PCIDevice, HPE.iLO.Response.Redfish.PCIDevice...} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PCIDevice : {HPE.iLO.Response.Redfish.PCIDevice, HPE.iLO.Response.Redfish.PCIDevice, HPE.iLO.Response.Redfish.PCIDevice, HPE.iLO.Response.Redfish.PCIDevice...} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOPCISlot</command:name> <maml:description> <maml:para>Gets the PCI slot information</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPCISlot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOPCISlot cmdlet gets the PCI slot information. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPCISlot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.PCISlot[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOPCISlot PS C:\> $out PCISlotDetail : {PCI-E Slot 1, PCI-E Slot 3, PCI-E Slot 2, PCI-E Slot 7} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.PCISlotDetail Name : PCI-E Slot 1 BusNumber : 17 Characteristics : {Provides3_3Volts, SupportsPowerManagementEventSignal} DeviceNumber : 0 FunctionNumber : 0 Length : Short LinkLanes : x8 Status : HPE.iLO.Response.Redfish.PCISlotStatus SupportsHotPlug : False Technology : PCIExpressGen3 UEFIDevicePath : PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0) Name : PCI-E Slot 3 BusNumber : 18 Characteristics : {Provides3_3Volts, SupportsPowerManagementEventSignal} DeviceNumber : 0 FunctionNumber : 0 Length : Short LinkLanes : x8 Status : HPE.iLO.Response.Redfish.PCISlotStatus SupportsHotPlug : False Technology : PCIExpressGen3 UEFIDevicePath : PciRoot(0x1)/Pci(0x2,0x0)/Pci(0x0,0x0) Name : PCI-E Slot 2 BusNumber : 97 Characteristics : {Provides3_3Volts, SupportsPowerManagementEventSignal} DeviceNumber : 0 FunctionNumber : 0 Length : Long LinkLanes : x16 Status : HPE.iLO.Response.Redfish.PCISlotStatus SupportsHotPlug : False Technology : PCIExpressGen3 UEFIDevicePath : PciRoot(0x2)/Pci(0x0,0x0)/Pci(0x0,0x0) Name : PCI-E Slot 7 BusNumber : 254 Characteristics : {Provides3_3Volts, SupportsPowerManagementEventSignal} DeviceNumber : 0 FunctionNumber : 0 Length : Long LinkLanes : x16 Status : HPE.iLO.Response.Redfish.PCISlotStatus SupportsHotPlug : False Technology : PCIExpressGen3 UEFIDevicePath : PciRoot(0x9)/Pci(0x0,0x0)/Pci(0x0,0x0)</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = Get-HPEiLOPCISlot -Connection $connection PS C:\> $out PCISlotDetail : {PCI-E Slot 1, PCI-E Slot 3, PCI-E Slot 2, PCI-E Slot 7} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PCISlotDetail : {PCI-E Slot 1, PCI-E Slot 3, PCI-E Slot 2, PCI-E Slot 7} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOPerformanceAlertSetting</command:name> <maml:description> <maml:para>Gets the set of thresholds defined for a sensor.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPerformanceAlertSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The cmdlet Get-HPEiLOPerformanceAlertSetting gets the set of thresholds defined for a sensor. This cmdlet is supported on iLO 5 servers only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPerformanceAlertSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.PerformanceAlertSetting</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOPerformanceAlertSetting PS C:\> $out CPUUtilization : HPE.iLO.Response.Redfish.AlertSettingData MemoryBusUtilization : HPE.iLO.Response.Redfish.AlertSettingData IOBusUtilization : HPE.iLO.Response.Redfish.AlertSettingData CPUInterconnectUtilization : HPE.iLO.Response.Redfish.AlertSettingData JitterCount : HPE.iLO.Response.Redfish.AlertSettingData CPUPower : HPE.iLO.Response.Redfish.AlertSettingData IP : 10.20.30.1 Hostname : iloqahost6.in.rdlabs.hpecorp.net Status : OK StatusInfo : PS C:\> $out.CPUUtilization LowerThresholdReading : 12 LowerThresholdDwellTime : 40 LowerThresholdActivation : Decreasing UpperThresholdReading : 1 UpperThresholdDwellTime : 0 UpperThresholdActivation : Increasing</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = Get-HPEiLOPerformanceAlertSetting -Connection $connection PS C:\> $out CPUUtilization : HPE.iLO.Response.Redfish.AlertSettingData MemoryBusUtilization : HPE.iLO.Response.Redfish.AlertSettingData IOBusUtilization : HPE.iLO.Response.Redfish.AlertSettingData CPUInterconnectUtilization : HPE.iLO.Response.Redfish.AlertSettingData JitterCount : HPE.iLO.Response.Redfish.AlertSettingData CPUPower : HPE.iLO.Response.Redfish.AlertSettingData IP : 10.20.30.1 Hostname : iloqahost6.in.rdlabs.hpecorp.net Status : OK StatusInfo : CPUUtilization : HPE.iLO.Response.Redfish.AlertSettingData MemoryBusUtilization : HPE.iLO.Response.Redfish.AlertSettingData IOBusUtilization : HPE.iLO.Response.Redfish.AlertSettingData CPUInterconnectUtilization : HPE.iLO.Response.Redfish.AlertSettingData JitterCount : HPE.iLO.Response.Redfish.AlertSettingData CPUPower : HPE.iLO.Response.Redfish.AlertSettingData IP : 10.20.30.2 Hostname : iloqahost6.in.rdlabs.hpecorp.net Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOPerformanceAlertSetting</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-HPEiLOPerformanceMonitoringData</command:name> <maml:description> <maml:para>Gets performance monitoring data on iLO5.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPerformanceMonitoringData</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlets gets complete performance monitoring data from all sensors from an iLO5 server only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPerformanceMonitoringData</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Communication.Redfish.PerformanceMonitoringData</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $con = Connect-HPEiLO 192.168.10.31 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $pdata = $con | Get-HPEiLOPerformanceMonitoringData PS C:\> $pdata CPUUtilization : HPE.iLO.Response.Redfish.MonitoringData MemoryBusUtilization : HPE.iLO.Response.Redfish.MonitoringData IOBusUtilization : HPE.iLO.Response.Redfish.MonitoringData CPUInterConnectUtilization : HPE.iLO.Response.Redfish.MonitoringData JitterCount : HPE.iLO.Response.Redfish.MonitoringData AvgCPUFreqency : HPE.iLO.Response.Redfish.MonitoringData CPUPower : HPE.iLO.Response.Redfish.MonitoringData IP : 192.168.10.31 Hostname : bl460cgen10-03.powershvpn.com Status : OK StatusInfo : PS C:\> $pdata.AvgCPUFreqency Id : AvgCPU0Freq Calculable : NonSummable CalculationAlgorithm : Average Description : Metric definition for average CPU0 frequency Implementation : PhysicalSensor IsLinear : True MaxReadingRange : 4000 MetricProperties : {/redfish/v1/Systems/1/#SystemUsage/AvgCPU0Freq} MetricDataType : Decimal MetricType : Numeric MinReadingRange : 0 Name : Metric definition for average CPU0 frequency Units : MHz PS C:\>$pdata.CPUInterConnectUtilization Id : CPUICUtil Calculable : NonSummable CalculationAlgorithm : Average Description : Metric definition for CPU interconnect utilization Implementation : PhysicalSensor IsLinear : True MaxReadingRange : 100 MetricProperties : {/redfish/v1/Systems/1/#SystemUsage/CPUICUtil} MetricDataType : Decimal MetricType : Numeric MinReadingRange : 0 Name : Metric definition for CPU interconnect utilization Units : %</dev:code> <dev:remarks> <maml:para>Above examples gets the performance monitoring data for an iLO5 server.</maml:para> </dev:remarks> </command:example> </command:examples> </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-HPEiLOPerformanceTuningSetting</command:name> <maml:description> <maml:para>Gets a list of bios attribute settings with recommended values as part of workload performance advisor.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPerformanceTuningSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The cmdlet Get-HPEiLOPerformanceTuningSetting gets a list of bios attribute settings with recommended values as part of workload performance advisor. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPerformanceTuningSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.PerformanceTuningSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOPerformanceTuningSetting PS C:\> $out PerformanceTuningData : {HPE.iLO.Response.Redfish.PerformanceTuningData, HPE.iLO.Response.Redfish.PerformanceTuningData, HPE.iLO.Response.Redfish.PerformanceTuningData} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.PerformanceTuningData | fl Duration : 10min PerformanceTuningOption : {HPE.iLO.Response.Redfish.PerformanceTuningOption, HPE.iLO.Response.Redfish.PerformanceTuningOption, HPE.iLO.Response.Redfish.PerformanceTuningOption, HPE.iLO.Response.Redfish.PerformanceTuningOption...} Duration : 1hr PerformanceTuningOption : {HPE.iLO.Response.Redfish.PerformanceTuningOption, HPE.iLO.Response.Redfish.PerformanceTuningOption, HPE.iLO.Response.Redfish.PerformanceTuningOption, HPE.iLO.Response.Redfish.PerformanceTuningOption...} Duration : 24hr PerformanceTuningOption : {HPE.iLO.Response.Redfish.PerformanceTuningOption, HPE.iLO.Response.Redfish.PerformanceTuningOption, HPE.iLO.Response.Redfish.PerformanceTuningOption, HPE.iLO.Response.Redfish.PerformanceTuningOption...} PS C:\> $out.PerformanceTuningData[0].PerformanceTuningOption BIOSAttributeName RecommendedValue ----------------- ---------------- SubNumaClustering Enabled NumaGroupSizeOpt Clustered UncoreFreqScaling MemRefreshRate PowerRegulator DynamicPowerSavings MinProcIdlePower EnergyPerfBias</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = Get-HPEiLOPerformanceTuningOption -Connection $connection PS C:\> $out PerformanceTuningData : {HPE.iLO.Response.Redfish.PerformanceTuningData, HPE.iLO.Response.Redfish.PerformanceTuningData, HPE.iLO.Response.Redfish.PerformanceTuningData} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PerformanceTuningData : {HPE.iLO.Response.Redfish.PerformanceTuningData, HPE.iLO.Response.Redfish.PerformanceTuningData, HPE.iLO.Response.Redfish.PerformanceTuningData} IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOPersistentBootOrder</command:name> <maml:description> <maml:para>Gets the current boot order.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPersistentBootOrder</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get-HPEiLOPersistentBootOrder cmdlet gets the current state of boot order.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPersistentBootOrder</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.PersistentBootOrder[] or HPE.iLO.Response.Redfish.PersistentBootOrder[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $obj = ,$connection | Get-HPEiLOPersistentBootOrder PS C:\> $obj | fl BootOrder : {USB, FLOPPY, CDROM, HDD...} IP : 192.168.10.12 Hostname : xl230agen9-01.powershvpn.com Status : OK StatusInfo : PS C:\> $obj.BootOrder USB FLOPPY CDROM HDD</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $obj = ,$connection | Get-HPEiLOPersistentBootOrder PS C:\> $obj | fl BootOrder : {HD.Slot.5.3, Generic.USB.1.1, HD.Slot.5.2, Shell.Emb.1.2...} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $obj.BootOrder HD.Slot.5.3 Generic.USB.1.1 HD.Slot.5.2 Shell.Emb.1.2 NIC.FlexLOM.1.1.Httpv6</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $obj = ,$connection | Get-HPEiLOPersistentBootOrder PS C:\>$obj | fl BootOrder : {USB, FLOPPY, CDROM, HDD...} IP : 192.168.10.12 Hostname : xl230agen9-01.powershvpn.com Status : OK StatusInfo : BootOrder : {HD.Slot.5.3, Generic.USB.1.1, HD.Slot.5.2, Shell.Emb.1.2...} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOPersistentBootOrder</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-HPEiLOPersistentMouseKeyboard</command:name> <maml:description> <maml:para>Gets the current persistent mouse and keyboard status.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPersistentMouseKeyboard</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOPersistentMouseKeyboard cmdlet gets the persistent mouse and keyboard status. The return value is either Enabled or Disabled.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPersistentMouseKeyboard</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.PersistentMouseKeyboard[] or HPE.iLO.Response.Redfish.PersistentMouseKeyboard[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOPersistentMouseKeyboard PersistenceEnabled : Yes IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOPersistentMouseKeyboard -Connection $connection PersistenceEnabled : Yes IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOPersistentMouseKeyboard PersistenceEnabled : Yes IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PersistenceEnabled : Yes IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOPersistentMouseKeyboard</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOPhysicalSecurity</command:name> <maml:description> <maml:para>Gets the Physical security detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPhysicalSecurity</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOPhysicalSecurity gets the physical security detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPhysicalSecurity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.PhysicalSecurity[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOPhysicalSecurity IntrusionSensor : HardwareIntrusion IntrusionSensorReArm : Automatic IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOPhysicalSecurity -Connection $connection IntrusionSensor : HardwareIntrusion IntrusionSensorReArm : Automatic IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : IntrusionSensor : TamperingDetected IntrusionSensorReArm : Manual IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOPostSetting</command:name> <maml:description> <maml:para>Gets the post setting details.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPostSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOPostSetting command gets the post setting detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPostSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.PostSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOPostSetting PostState : FinishedPost PostMode : Normal PostDiscoveryCompleteTimeStamp : 2017-06-05T16:28:12Z EndOfPostDelaySeconds : 10 PostDiscoveryMode : Auto IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOPostSetting -Connection $connection PostState : FinishedPost PostMode : Normal PostDiscoveryCompleteTimeStamp : 2017-06-05T16:28:12Z EndOfPostDelaySeconds : 10 PostDiscoveryMode : Auto IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PostState : InPostDiscoveryComplete PostMode : Normal PostDiscoveryCompleteTimeStamp : 2017-06-05T16:28:12Z EndOfPostDelaySeconds : 10 PostDiscoveryMode : Auto IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOPostSetting</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-HPEiLOPowerCapSetting</command:name> <maml:description> <maml:para>Gets the power capping information of the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPowerCapSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOPowerCap cmdlet gets the power capping informationof the server. You must purchase the iLO Advanced license to enable this feature. A cap value of zero indicates that the power cap value is not currently set on the server.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPowerCapSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.PowerCapInfo[] or HPE.iLO.Response.Redfish.PowerCapInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOPowerCapSetting PowerCap : Off IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOPowerCapSetting -Connection $connection PowerCap : 290 CorrectionInMs : LimitException : MinimumSafelyAchievableCapValid : true MinimumSafelyAchievableCap : 280 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOPowerCapSetting PowerCap : Off IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : PowerCap : 290 CorrectionInMs : LimitException : MinimumSafelyAchievableCapValid : true MinimumSafelyAchievableCap : 280 IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOPowerCapSetting</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-HPEiLOPowerMeter</command:name> <maml:description> <maml:para>Gets Power Meter details of the target iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPowerMeter</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets both PowerMeter and Fast PowerMeter sample details with count. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPowerMeter</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.PowerMeterEx[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$con = Connect-HPEiLO 192.168.10.31 admin admin123 -DisableCertificateAuthentication -Verbose PS C:\> $p = $con | get-hpeilopowermeter PS C:\> $p IP : 192.168.10.28 Hostname : xl170r-01gen10.powershvpn.com Status : OK StatusInfo : PowerMeterInfo : HPE.iLO.Response.Redfish.PowerMeter FastPowerMeterInfo : HPE.iLO.Response.Redfish.PowerMeter PS C:\> $p.PowerMeterInfo Average : 28 Samples : 287 Maximum : 38 Minimum : 28 PowerDetails : {HPE.iLO.Response.Redfish.PowerDetail, HPE.iLO.Response.Redfish.PowerDetail, HPE.iLO.Response.Redfish.PowerDetail, HPE.iLO.Response.Redfish.PowerDetail...} PS C:\Windows\system32> $p.PowerMeterInfo.PowerDetails | ft AmbTemp Average Cap CpuAvgFreq CpuCapLim CpuMax CpuPwrSavLim CpuUtil CpuWatts DimmWatts ------- ------- --- ---------- --------- ------ ------------ ------- -------- --------- 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 20 53 22 28 0 0 100 0 100 0 19 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 * * (data truncated for help purpose) * 22 28 0 0 100 0 100 0 18 53 PS C:\Windows\system32> $p.FastPowerMeterInfo Average : 28 Samples : 120 Maximum : 37 Minimum : 28 PowerDetails : {HPE.iLO.Response.Redfish.PowerDetail, HPE.iLO.Response.Redfish.PowerDetail, HPE.iLO.Response.Redfish.PowerDetail, HPE.iLO.Response.Redfish.PowerDetail...} PS C:\Windows\system32> $p.FastPowerMeterInfo.PowerDetails PS C:\Windows\system32> $p.FastPowerMeterInfo.PowerDetails | ft AmbTemp Average Cap CpuAvgFreq CpuCapLim CpuMax CpuPwrSavLim CpuUtil CpuWatts DimmWatts ------- ------- --- ---------- --------- ------ ------------ ------- -------- --------- 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 52 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 20 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 20 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 23 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 20 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 19 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 20 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 52 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 54 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 18 53 22 28 0 0 100 0 100 0 20 54 22 28 0 0 100 0 100 0 18 53 * * (data truncated for help purpose) * 22 28 0 0 100 0 100 0 18 53</dev:code> <dev:remarks> <maml:para>Gets power meter details of an iLO 5 server.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOPowerReading</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOPowerRegulatorSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOPowerCapSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOPowerOnTime</command:name> <maml:description> <maml:para>Gets the virtual clock value, in minutes, since the server was last powered on.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPowerOnTime</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOPowerOnTime cmdlet gets the virtual clock value, in minutes, since the server was last powered on.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPowerOnTime</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.PowerOnTime[] or HPE.iLO.Response.Redfish.PowerOnTime[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOPowerOnTime PowerOnMinutes : 18555 IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusMessage : StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOPowerOnTime PowerOnMinutes : 261514 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusMessage : StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOPowerOnTime PowerOnMinutes : 18555 IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusMessage : StatusInfo : PowerOnMinutes : 261514 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusMessage : StatusInfo : PowerOnMinutes : 185556 IP : 10.20.30.3 Hostname : xyz.example.com Status : OK StatusMessage : StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOPowerReading</command:name> <maml:description> <maml:para>Gets the power readings from the server power supply.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPowerReading</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOPowerReading cmdlet gets the power readings from the server power supply. Two types of responses are available from the Get-HPEiLOpowerReading command, depending on whether or not an advanced license is applied. If an advanced license is not applied, a typical response includes present power reading. If an advanced license is applied, a typical response includes the present, average, maximum, and minimum power readings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPowerReading</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.PowerReading[] or HPE.iLO.Response.Redfish.PowerReading[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOPowerReading PresentPower : 54 Watts AveragePower : 52 Watts MaximumPower : 66 Watts MinimumPower : 52 Watts IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOPowerReading -Connection $connection PresentPower : 54 Watts AveragePower : 52 Watts MaximumPower : 66 Watts MinimumPower : 52 Watts IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PresentPower : 54 Watts AveragePower : 52 Watts MaximumPower : 66 Watts MinimumPower : 52 Watts IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOPowerRegulatorSetting</command:name> <maml:description> <maml:para>Gets the state of the processor power regulator feature of the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPowerRegulatorSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get-HPEiLOPowerRegulatorSetting cmdlet gets the state of the processor power regulator feature of the server. The possible values are Dynamic, Max, Min, OSControl.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPowerRegulatorSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.PowerRegulatorSetting[] or HPE.iLO.Response.Redfish.PowerRegulatorSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOPowerRegulatorSetting Mode : Max IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOPowerRegulatorSetting Mode : Dynamic IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOPowerRegulatorSetting Mode : Dynamic IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : Mode : Max IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOPowerRegulatorSetting</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-HPEiLOPowerSupply</command:name> <maml:description> <maml:para>Gets the power supply details for the host server where the iLO is located.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOPowerSupply</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOPowerSupply cmdlet gets the power supply details of the host server where the iLO is located. These details include high efficiency mode, redundancy status, power management controller firmware version, present power, GPU, CPU, and DIMM reading in power supply summary and capacity, firmware version, hot-plug capability, model details, and status for each power supply.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOPowerSupply</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.PowerSupplyInfo[] or HPE.iLO.Response.Redfish.PowerSupplyInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOPowerSupply PS C:\> $out PowerSupplySummary : HPE.iLO.Response.RIBCL.PowerSupplySummary PowerSupplies : {HPE.iLO.Response.RIBCL.Supply, HPE.iLO.Response.RIBCL.Supply} PowerDiscoveryServicesiPDUSummary : {} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.PowerSupplySummary HighEfficiencyMode : Balanced HPPowerDiscoveryServicesRedundancyStatus : N/A PowerManagementControllerFirmwareVersion : 1.0.9 PowerSystemRedundancy : Redundant PresentPowerReading : 86 Watts PS C:\> $out.PowerSupplies Label : Power Supply 1 Present : Yes Status : Good, In Use PDS : No HotPlugCapable : Yes Model : 720479-B21 Spare : 754381-001 SerialNumber : 5DLVD0CLL9M1JT Capacity : 800 Watts FirmwareVersion : 1.00 Label : Power Supply 2 Present : Yes Status : Good, In Use PDS : No HotPlugCapable : Yes Model : 720479-B21 Spare : 754381-001 SerialNumber : 5DLVD0CLL9M1GD Capacity : 800 Watts FirmwareVersion : 1.00</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOPowerSupply PS C:\> $out PowerSupplySummary : HPE.iLO.Response.Redfish.PowerSupplySummary PowerSupplies : {HpeServerPowerSupply, HpeServerPowerSupply} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.PowerSupplySummary | fl HighEfficiencyMode : Balanced PowerManagementControllerFirmwareVersion : 1.0.0 PowerSystemRedundancy : Redundant PresentPowerReading : 0 PS C:\> $out.PowerSupplies Name : HpeServerPowerSupply Model : SerialNumber : Spare : PartNumber : PowerSupplyType : AC Capacity : 0 FirmwareVersion : 0.00 AveragePower : 0 LineInputVoltage : 0 LineInputVoltageType : Unknown BayNumber : 1 Mismatched : No HotPlugCapable : Yes MaxPowerOutputWatts : 0 Status : HPE.iLO.Response.Redfish.Status PowerSupplyStatus : Unknown iPDUCapable : No iPDU : Name : HpeServerPowerSupply Model : SerialNumber : Spare : PartNumber : PowerSupplyType : AC Capacity : 0 FirmwareVersion : 0.00 AveragePower : 0 LineInputVoltage : 0 LineInputVoltageType : Unknown BayNumber : 2 Mismatched : No HotPlugCapable : Yes MaxPowerOutputWatts : 0 Status : HPE.iLO.Response.Redfish.Status PowerSupplyStatus : Unknown iPDUCapable : Yes iPDU :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOPowerRegulatorSetting -Connection $connection PowerSupplySummary : HPE.iLO.Response.RIBCL.PowerSupplySummary PowerSupplies : {HPE.iLO.Response.RIBCL.Supply, HPE.iLO.Response.RIBCL.Supply} PowerDiscoveryServicesiPDUSummary : {} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PowerSupplySummary : HPE.iLO.Response.Redfish.PowerSupplySummary PowerSupplies : {HpeServerPowerSupply, HpeServerPowerSupply} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\>$con = Connect-HPEiLO 192.168.10.42 admin admin123 -DisableCertificateAuthentication PS C:\>$p1 = $con | Get-HPEiLOPowerSupply PS C:\>$p1.powersupplysummary HasPowerMetering : True HasGpuPowerMetering : False HasCpuPowerMetering : True HasDimmPowerMetering : True HighEfficiencyMode : Balanced PowerManagementControllerFirmwareVersion : 1.0.4 PowerSystemRedundancy : NonRedundant PresentPowerReading : 106</dev:code> <dev:remarks> <maml:para>Power Supply output from an iLO5 server which supports new metering attributes.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOProcessor</command:name> <maml:description> <maml:para>Gets the processor details for the host server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOProcessor</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOProcessor cmdlet gets the processor health details of the host server where the iLO is located. These details include execution technology, cache details, label, memory technology, name, CPU details, and status of the processor.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOProcessor</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.ProcessorInfo[] or HPE.iLO.Response.Redfish.ProcessorInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOProcessor PS C:\> $obj | fl Processor : {HPE.iLO.Response.RIBCL.Processor, HPE.iLO.Response.RIBCL.Processor} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $obj.Processor ID : 1 ManufacturerName : Intel(R) Model : Intel(R) Xeon(R) CPU E5-2650 v3 @ 2.30GHz ProcessorType : CPU ProcessorStatus : OK CoresEnabled : 10 RatedSpeedMHz : 2300 Socket : Proc 1 TotalCores : 10 TotalThreads : 20 Characteristics : {64-bit} Cache : {HPE.iLO.Response.RIBCL.Cache, HPE.iLO.Response.RIBCL.Cache, HPE.iLO.Response.RIBCL.Cache} ID : 2 ManufacturerName : Intel(R) Model : Intel(R) Xeon(R) CPU E5-2650 v3 @ 2.30GHz ProcessorType : CPU ProcessorStatus : OK CoresEnabled : 10 RatedSpeedMHz : 2300 Socket : Proc 2 TotalCores : 10 TotalThreads : 20 Characteristics : {64-bit} Cache : {HPE.iLO.Response.RIBCL.Cache, HPE.iLO.Response.RIBCL.Cache, HPE.iLO.Response.RIBCL.Cache} PS C:\> $obj.Processor[0].Cache | fl Name : L1-Cache Location : Internal InstalledSizeKB : 128 Name : L2-Cache Location : Internal InstalledSizeKB : 1024 Name : L3-Cache Location : Internal InstalledSizeKB : 12288</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOProcessor PS C:\> $obj | fl Processor : {HPE.iLO.Response.Redfish.Processor} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $obj.Processor InstructionSet : x86-64 MaxSpeedMHz : 4000 Name : Processors AssetTag : ConfigStatus : HPE.iLO.Response.Redfish.ConfigStatus ExternalClockMHz : 100 MicrocodePatches : {HPE.iLO.Response.Redfish.MicrocodePatch, HPE.iLO.Response.Redfish.MicrocodePatch, HPE.iLO.Response.Redfish.MicrocodePatch} PartNumber : SerialNumber : VoltageVoltsX10 : 16 ProcessorArchitecture : x86 ProcessorID : HPE.iLO.Response.Redfish.ProcessorID ID : 1 ManufacturerName : Intel(R) Corporation Model : Intel(R) Genuine processor ProcessorType : CPU ProcessorStatus : OK CoresEnabled : 4 RatedSpeedMHz : 2200 Socket : Proc 1 TotalCores : 4 TotalThreads : 8 Characteristics : {64Bit, MultiCore, HwThread, ExecuteProtection...} Cache : {HPE.iLO.Response.Redfish.Cache, HPE.iLO.Response.Redfish.Cache, HPE.iLO.Response.Redfish.Cache} PS C:\> $obj.Processor[0].ConfigStatus | fl IsPopulated : Yes State : Enabled PS C:\> $obj.Processor[0].Cache | fl Name : L1-Cache Location : Internal InstalledSizeKB : 256 Associativity : 8waySetAssociative CacheSpeedns : 0 CurrentSRAMType : {Synchronous} EccType : SingleBitECC MaximumSizeKB : 256 Policy : WriteBack IsSocketed : No SupportedSRAMType : {Synchronous} SystemCacheType : Unified Name : L2-Cache Location : Internal InstalledSizeKB : 4096 Associativity : 16waySetAssociative CacheSpeedns : 0 CurrentSRAMType : {Synchronous} EccType : SingleBitECC MaximumSizeKB : 4096 Policy : Varies IsSocketed : No SupportedSRAMType : {Synchronous} SystemCacheType : Unified Name : L3-Cache Location : Internal InstalledSizeKB : 8448 Associativity : FullyAssociative CacheSpeedns : 0 CurrentSRAMType : {Synchronous} EccType : SingleBitECC MaximumSizeKB : 8448 Policy : Varies IsSocketed : No SupportedSRAMType : {Synchronous} SystemCacheType : Unified PS C:\> $obj.Processor[0].MicrocodePatches | fl 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 : 4/28/2017 12:00:00 AM PatchID : 0x0200001C</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Get-HPEiLOProcessor -Connection $connection | fl Processor : {HPE.iLO.Response.RIBCL.Processor, HPE.iLO.Response.RIBCL.Processor} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : Processor : {HPE.iLO.Response.RIBCL.Processor, HPE.iLO.Response.RIBCL.Processor} IP : 10.20.30.41 Hostname : abcd.com Status : OK StatusInfo : Processor : {HPE.iLO.Response.Redfish.Processor} IP : 10.20.30.42 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOProcessorJitterControl</command:name> <maml:description> <maml:para>Gets the Processor Jitter Control detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOProcessorJitterControl</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOProcessorJitterControl cmdlet gets the Processor Jitter Control detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOProcessorJitterControl</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.ProcessorJitterControl[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOProcessorJitterControl PS C:\> $out Mode : Auto FrequencyLimitMHz : 800 ProcessorJitterControlOptimization : ConfiguredFrequencyLimitMHz : 1000 IP : 192.168.10.31 Hostname : bl460cgen10-03.powershvpn.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = Get-HPEiLOProcessorJitterControl -Connection $connection PS C:\> $out Mode : Auto FrequencyLimitMHz : 1200 ProcessorJitterControlOptimization : ConfiguredFrequencyLimitMHz : 800 IP : 192.168.10.31 Hostname : bl460cgen10-03.powershvpn.com Status : OK StatusInfo : Mode : Auto FrequencyLimitMHz : 2200 ProcessorJitterControlOptimization : OptimizedForLatency ConfiguredFrequencyLimitMHz : 3000 IP : 192.168.10.34 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOProfile</command:name> <maml:description> <maml:para>Gets all the Profile Descriptors and the data stored in them in the perm directory of the blob store.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOProfile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOProfile cmdlet gets all the Profile Descriptors and the data stored in them in the perm directory of the blob store. This cmdlet is supported only on iLO 4 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOProfile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.ProfileInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOProfile PS C:\> $obj ProfileDescriptionList : {HPE.iLO.Response.RIBCL.Profile, HPE.iLO.Response.RIBCL.Profile, HPE.iLO.Response.RIBCL.Profile} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $obj.ProfileDescriptionList BLOBName : HP_Windows_settings BLOBNameSpace : Permanent ProfileDescription : template_w2012 ProfileDescriptionName : HP_Windows_settings ProfileName : template_w2012 ProfileSchema : intelligentprovisioning.1.0.0 BLOBName : HP_Linux_settings BLOBNameSpace : Permanent ProfileDescription : template_linux ProfileDescriptionName : HP_Linux_settings ProfileName : template_linux ProfileSchema : intelligentprovisioning.1.0.0 BLOBName : HP_VMware_settings BLOBNameSpace : Permanent ProfileDescription : template_vmware ProfileDescriptionName : HP_VMware_settings ProfileName : template_vmware ProfileSchema : intelligentprovisioning.1.0.0</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\>Get-HPEiLOProfile -Connection $connection ProfileDescriptionList : {HPE.iLO.Response.RIBCL.Profile, HPE.iLO.Response.RIBCL.Profile, HPE.iLO.Response.RIBCL.Profile} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : ProfileDescriptionList : {HPE.iLO.Response.RIBCL.Profile, HPE.iLO.Response.RIBCL.Profile, HPE.iLO.Response.RIBCL.Profile} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOProfileApply</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOProfileDownload</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOProfileApplyResult</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOProfile</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-HPEiLOProfileApplyResult</command:name> <maml:description> <maml:para>Retrieves the result of the Invoke-HPEiLOProfileApply cmdlet.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOProfileApplyResult</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>You can script automated server configuration packages (deployment settings) to install multiple servers through iLO using PROFILE scripts. Use the Invoke-HPEiLOProfileApplycmdlet to apply profile in iLO 4. After applying the profile, the Get-HPEiLOProfileApplyResult cmdlet gets the result of the profile application.This cmdlet is supported only on iLO 4 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOProfileApplyResult</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.ProfileApplyResult[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOProfileApplyResult Result : {HPE.iLO.Response.RIBCL.Item, HPE.iLO.Response.RIBCL.Item, HPE.iLO.Response.RIBCL.Item, HPE.iLO.Response.RIBCL.Item...} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $obj.Result | fl File : rbsu Message : File not found, using default values Return : -1 File : storage Message : File not found, using default values Return : -1 File : ip Message : File not found, using default values Return : -1 File : fw Message : File not found, using default values Return : -1 File : os Message : File not found, using default values Return : -1 File : net Message : File not found, using default values Return : -1 File : ers Message : File not found, using default values Return : -1 File : ermac Message : File not found, using default values Return : -1</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOProfileApplyResult -Connection $connection Result : {HPE.iLO.Response.RIBCL.Item, HPE.iLO.Response.RIBCL.Item, HPE.iLO.Response.RIBCL.Item, HPE.iLO.Response.RIBCL.Item...} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : Result : {HPE.iLO.Response.RIBCL.Item, HPE.iLO.Response.RIBCL.Item, HPE.iLO.Response.RIBCL.Item, HPE.iLO.Response.RIBCL.Item...} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOProfileApply</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOProfileDownload</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOProfile</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-HPEiLORackSetting</command:name> <maml:description> <maml:para>Gets the rack setting information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLORackSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLORackSetting cmdlet gets the rack setting information. This cmdlet is supported only on BL servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLORackSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.RackSetting[] or HPE.iLO.Response.Redfish.RackSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLORackSetting RackName : Poseidon_C7K_Test EnclosureName : Poseidon_C7000 EnclosureSN : USE924MVA1 EnclosureType : BladeSystem c7000 Enclosure EnclosureUUID : 09USE924MVA1 BayNumber : 4 IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLORackSetting RackName : Poseidon_C7K_Test EnclosureName : Poseidon_C7000 BayNumber : Bay 2 IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLORackSetting -Connection $connection RackName : Poseidon_C7K_Test EnclosureName : Poseidon_C7000 EnclosureSN : USE924MVA1 EnclosureType : BladeSystem c7000 Enclosure EnclosureUUID : 09USE924MVA1 BayNumber : 4 IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : RackName : Poseidon_C7K_Test EnclosureName : Poseidon_C7000 BayNumber : Bay 2 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLORedfishMessageInfo</command:name> <maml:description> <maml:para>Gets the Redfish message detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLORedfishMessageInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLORedfishMessageInfo cmdlet gets the Redfish message detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLORedfishMessageInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MessageID</maml:name> <maml:description> <maml:para>The message ID returned from Redfish Uri.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MessageID</maml:name> <maml:description> <maml:para>The message ID returned from Redfish Uri.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>HPE.iLO.Response.Redfish.RedfishMessageInfoDetail[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLORemoteSupportSetting PS C:\> $out AccessDenied : HPE.iLO.Response.Redfish.MessageIDInfo AccountForSessionNoLongerExists : HPE.iLO.Response.Redfish.MessageIDInfo AccountModified : HPE.iLO.Response.Redfish.MessageIDInfo AccountNotModified : HPE.iLO.Response.Redfish.MessageIDInfo AccountRemoved : HPE.iLO.Response.Redfish.MessageIDInfo ActionNotSupported : HPE.iLO.Response.Redfish.MessageIDInfo ActionParameterDuplicate : HPE.iLO.Response.Redfish.MessageIDInfo ActionParameterMissing : HPE.iLO.Response.Redfish.MessageIDInfo IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.AccessDenied Description : While attempting to access, connect to, or transfer to/from another resource, the service was denied access. Message : While attempting to establish a connection to %1, the service was denied access. NumberOfArgs : 1 ParamTypes : {String} Resolution : Verify that the URI is correct and that the service has the appropriate credentials. Severity : Critical Oem :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLORedfishMessageInfo -MessageID AHSDisabled PS C:\> $out MessageInfo : {AHSDisabled} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.MessageInfo MessageID : AHSDisabled Description : Modifying AHS properties is not possible with AHS disabled. Message : Modifying AHS properties is not possible with AHS disabled. NumberOfArgs : 0 ParamTypes : {} Resolution : Enable AHS, and then modify the AHS properties. Severity : Warning Oem :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLORedfishMessageInfo -Connection $connection AccessDenied : HPE.iLO.Response.Redfish.MessageIDInfo AccountForSessionNoLongerExists : HPE.iLO.Response.Redfish.MessageIDInfo AccountModified : HPE.iLO.Response.Redfish.MessageIDInfo AccountNotModified : HPE.iLO.Response.Redfish.MessageIDInfo AccountRemoved : HPE.iLO.Response.Redfish.MessageIDInfo ActionNotSupported : HPE.iLO.Response.Redfish.MessageIDInfo ActionParameterDuplicate : HPE.iLO.Response.Redfish.MessageIDInfo ActionParameterMissing : HPE.iLO.Response.Redfish.MessageIDInfo IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : AccessDenied : HPE.iLO.Response.Redfish.MessageIDInfo AccountForSessionNoLongerExists : HPE.iLO.Response.Redfish.MessageIDInfo AccountModified : HPE.iLO.Response.Redfish.MessageIDInfo AccountNotModified : HPE.iLO.Response.Redfish.MessageIDInfo AccountRemoved : HPE.iLO.Response.Redfish.MessageIDInfo ActionNotSupported : HPE.iLO.Response.Redfish.MessageIDInfo ActionParameterDuplicate : HPE.iLO.Response.Redfish.MessageIDInfo ActionParameterMissing : HPE.iLO.Response.Redfish.MessageIDInfo IP : 10.20.30.2 Hostname : xyz.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLORemoteSupportServiceEventLog</command:name> <maml:description> <maml:para>Gets Service Event logs.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLORemoteSupportServiceEventLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets Service Event logs. This cmdlet gets log entries only if Remote Support is configured on the target server. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLORemoteSupportServiceEventLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.RemoteSupportServiceEventLog[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\Windows\system32> $con = Connect-HPEiLO 192.168.10.34 admin admin123 -DisableCertificateAuthentication PS C:\Windows\system32> $e = $con | Get-HPEiLORemoteSupportServiceEventLog PS C:\Windows\system32> $e IP : 192.168.10.34 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo : ServiceEventlog : {HPE.iLO.Response.Redfish.ServiceEventLog, HPE.iLO.Response.Redfish.ServiceEventLog} PS C:\Windows\system32> $e.ServiceEventlog Id : 1 Created : 03/02/2017 03:15:50 Severity : OK Categories : {HPQTEST0001} Destination : 192.168.1.122:7906 EventNumber : 1 Identifier : c84bdb60-bfe9-e611-827a-e0071b8813aa SubmitStatus : Device is not registered Id : 2 Created : 03/02/2017 03:23:04 Severity : OK Categories : {HPQTEST0001} Destination : 192.168.1.122:7906 EventNumber : 1 Identifier : eaf575b5-c2e9-e611-88ce-e0071b8813aa SubmitStatus : Device is not registered</dev:code> <dev:remarks> <maml:para>Gets Service event log entries from a remote support configured iLO 5 server.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLORemoteSupportServiceEventLog</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-HPEiLORemoteSupportSetting</command:name> <maml:description> <maml:para>Gets the Insight Remote Support setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLORemoteSupportSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLORemoteSupportSetting cmdlet gets the Insight Remote Support setting. This cmdlet is used to get ERS and IRS settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLORemoteSupportSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.RemoteSupportSetting[] or HPE.iLO.Response.Redfish.RemoteSupportSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLORemoteSupportSetting ERSCollectionFrequency : P00D ERSAgent : InterfaceType : CentralConnect HPEPassportUserID : DestinationURL : 1.1.1.1 DestinationPort : 7906 WebProxyServer : WebProxyPort : 0 WebProxyUsername : RemoteSupportEnabled : Yes LastTransmissionDate : 3/3/2017 12:15:58 PM LastTransmissionError : No Error LastTransmissionType : 1 IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLORemoteSupportSetting ERSCollectionFrequencyDays : 30 InterfaceType : DirectConnect HPEPassportUserID : abcd@hpe.com DestinationURL : DestinationPort : MaintenanceModeEnabled : Yes MaintenanceTimeLeftInMinutes: 60 WebProxyServer : 1.2.2.3 WebProxyPort : 8080 WebProxyUsername : RemoteSupportEnabled : Yes LastTransmissionDate : 3/3/2017 12:15:58 PM LastTransmissionError : No Error LastTransmissionType : L2DataCollection IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLORemoteSupportSetting -Connection $connection ERSCollectionFrequency : P00D ERSAgent : InterfaceType : CentralConnect HPEPassportUserID : DestinationURL : 1.1.1.1 DestinationPort : 7906 WebProxyServer : WebProxyPort : 0 WebProxyUsername : RemoteSupportEnabled : Yes LastTransmissionDate : 3/3/2017 12:15:58 PM LastTransmissionError : No Error LastTransmissionType : 1 IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : ERSCollectionFrequencyDays : 30 InterfaceType : DirectConnect HPEPassportUserID : abcd@hpe.com DestinationURL : DestinationPort : MaintenanceModeEnabled : No MaintenanceTimeLeftInMinutes: WebProxyServer : 1.2.2.3 WebProxyPort : 8080 WebProxyUsername : RemoteSupportEnabled : Yes LastTransmissionDate : 3/3/2017 12:15:58 PM LastTransmissionError : No Error LastTransmissionType : L2DataCollection IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLORemoteSupportSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-HPEiLORemoteSupportSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-HPEiLORemoteSupportSetting</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-HPEiLORemoteSyslog</command:name> <maml:description> <maml:para>Gets the iLO Remote Syslog settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLORemoteSyslog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get-HPEiLORemoteSyslog cmdlet gets the iLO Remote Syslog settings. An iLO license that supports this feature is required.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLORemoteSyslog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.iLO4.RemoteSyslog[] or HPE.iLO.Response.Redfish.RemoteSyslog[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLORemoteSyslog RemoteSyslogEnabled : Yes RemoteSyslogServer : 1.1.1.1 RemoteSyslogPort : 123 IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 or iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLORemoteSyslog RemoteSyslogEnabled : Yes RemoteSyslogServer : 1.1.1.1 RemoteSyslogPort : 123 IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : RemoteSyslogEnabled : Yes RemoteSyslogServer : 1.1.1.1 RemoteSyslogPort : 123 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLORemoteSyslog</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-HPEiLORepositoryComponent</command:name> <maml:description> <maml:para>Gets the Repository Component detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLORepositoryComponent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLORepositoryComponent gets the Repository Component detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLORepositoryComponent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.RepositoryComponent[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLORepositoryComponent PS C:\> $out ComponentCount : 6 FreeSizeBytes : 982319104 TotalSizeBytes : 1073168384 RepositoryComponentInformation : {HPE.iLO.Response.Redfish.RepositoryComponentInformation, HPE.iLO.Response.Redfish.RepositoryComponentInformation, HPE.iLO.Response.Redfish.RepositoryComponentInformation, HPE.iLO.Response.Redfish.RepositoryComponentInformation...} IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.RepositoryComponentInformation Id : 47a612b8 Activates : AfterReboot ComponentUri : /fwrepo/SPSGen10_04.00.04.288.signed.bin Configuration : Created : 6/30/2017 6:18:50 PM Criticality : Optional DeviceClass : b34e5677-21dc-45d3-872b-42f76fee9053 ExecutionParameters : Filename : SPSGen10_04.00.04.288.signed.bin Filepath : SPSGen10_04.00.04.288.signed.bin Locked : True Name : Server Platform Services (SPS) Firmware SizeBytes : 8390998 Targets : {a6b1a447-382a-5a4f-3c10-86800a000101} UpdatableBy : {Bmc} Version : 4.0.4.288 Id : 0d51810a Activates : AfterReboot ComponentUri : /fwrepo/IEGen10_0.1.5.2.signed.bin Configuration : Created : 6/30/2017 6:18:50 PM Criticality : Optional DeviceClass : c734e171-8721-48c9-9ed6-d5bc7da5ef8d ExecutionParameters : Filename : IEGen10_0.1.5.2.signed.bin Filepath : IEGen10_0.1.5.2.signed.bin Locked : True Name : Innovation Engine (IE) Universal Image SizeBytes : 8391008 Targets : {a6b1a447-382a-5a4f-3c10-3c100a000303} UpdatableBy : {Bmc} Version : 0.1.5.2 Id : 26b7abcb Activates : AfterHardPowerCycle ComponentUri : /fwrepo/CPLD_DL360_DL380_Gen10_VP1_v2A2A_full_signed.vme Configuration : Created : 6/30/2017 6:18:50 PM Criticality : Optional DeviceClass : b1ad439a-9dd1-41c1-a496-2da9313f1f07 ExecutionParameters : Filename : CPLD_DL360_DL380_Gen10_VP1_v2A2A_full_signed.vme Filepath : CPLD_DL360_DL380_Gen10_VP1_v2A2A_full_signed.vme Locked : True Name : System Programmable Logic Device SizeBytes : 1132559 Targets : {00000000-0000-0000-0000-000000000205, 00000000-0000-0000-0000-000000000204, 00000000-0000-0000-0000-000000000203} UpdatableBy : {Bmc} Version : 2A Id : b9a1ecb4 Activates : AfterReboot ComponentUri : /fwrepo/U30_1.26_11_14_2017.signed.flash Configuration : Created : 6/30/2017 6:18:50 PM Criticality : Optional DeviceClass : aa148d2e-6e09-453e-bc6f-63baa5f5ccc4 ExecutionParameters : Filename : U30_1.26_11_14_2017.signed.flash Filepath : U30_1.26_11_14_2017.signed.flash Locked : True Name : System BIOS - U30 SizeBytes : 33563252 Targets : {00000000-0000-0000-0000-000000000205} UpdatableBy : {Bmc} Version : v1.26 (11/14/2017) Id : b00b43a7 Activates : AfterDeviceReset ComponentUri : /fwrepo/ilo5_115.bin Configuration : Created : 6/30/2017 6:18:50 PM Criticality : Optional DeviceClass : 2f317b9d-c9e3-4d76-bff6-b9d0d085a952 ExecutionParameters : Filename : ilo5_115.bin Filepath : ilo5_115.bin Locked : True Name : iLO 5 SizeBytes : 33556520 Targets : {4764a662-b342-4fc7-9ce9-258c5d99e815} UpdatableBy : {Bmc} Version : 1.15 Id : b3abed50 Activates : Immediately ComponentUri : /fwrepo/cp033330.exe Configuration : Created : 6/30/2017 6:18:50 PM Criticality : Optional DeviceClass : 907bf452-0f78-4311-ab8a-4fc6f1c1688e ExecutionParameters : Filename : cp033330.exe Filepath : cp033330.exe Locked : False Name : HPE D6020 12Gb SAS Disk Enclosure ROM Flash Component for Wi... SizeBytes : 5529480 Targets : {b99dfb74-f0bc-464f-b418-cd18f2a1a8e3} UpdatableBy : {RuntimeAgent} Version : 2.53</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEiLORepositoryComponent -Connection $connection ComponentCount : 6 FreeSizeBytes : 982319104 TotalSizeBytes : 1073168384 RepositoryComponentInformation : {HPE.iLO.Response.Redfish.RepositoryComponentInformation, HPE.iLO.Response.Redfish.RepositoryComponentInformation, HPE.iLO.Response.Redfish.RepositoryComponentInformation, HPE.iLO.Response.Redfish.RepositoryComponentInformation...} IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : ComponentCount : 6 FreeSizeBytes : 982319104 TotalSizeBytes : 1073168384 RepositoryComponentInformation : {HPE.iLO.Response.Redfish.RepositoryComponentInformation, HPE.iLO.Response.Redfish.RepositoryComponentInformation, HPE.iLO.Response.Redfish.RepositoryComponentInformation, HPE.iLO.Response.Redfish.RepositoryComponentInformation...} IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOUnlockedRepositoryComponent</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-HPEiLORestAPIState</command:name> <maml:description> <maml:para>Gets the Rest API State.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLORestAPIState</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLORestAPIState gets the Rest API State. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLORestAPIState</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.RestAPIState[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLORestAPIState ClearRestAPIStatus : DataPresent IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20,30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLORestAPIState -Connection $connection ClearRestAPIStatus : DataPresent IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : ClearRestAPIStatus : DataCleared IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLORestAPIState</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-HPEiLOSecureBoot</command:name> <maml:description> <maml:para>Gets the secure boot detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSecureBoot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSecureBoot cmdlet gets the secure boot detail. This cmdlet is supported only in iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSecureBoot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.SecureBoot[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOSecureBoot Id : SecureBoot Name : SecureBoot SecureBootCurrentBoot : Disabled SecureBootMode : UserMode SecureBootEnable : No IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOSecureBoot -Connection $connection Id : SecureBoot Name : SecureBoot SecureBootCurrentBoot : Disabled SecureBootMode : UserMode SecureBootEnable : No IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : Id : SecureBoot Name : SecureBoot SecureBootCurrentBoot : Disabled SecureBootMode : UserMode SecureBootEnable : No IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSecureBoot</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-HPEiLOSecureSystemEraseStatus</command:name> <maml:description> <maml:para>Gets the overall erase status of System ROM, iLO, and User Data.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSecureSystemEraseStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSecureSystemEraseStatus gets the overall erase status for System ROM, iLO, User Data and their individual components. This cmdlet is supported on iLO 5 servers only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSecureSystemEraseStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.SecureSystemEraseStatus[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOSecureSystemEraseStatus PS C:\> $out EraseStatus : ElapsedEraseTimeInMinutes : 2 EstimatedEraseTimeInMinutes : 3763 SystemROMAndiLOEraseComponentStatus : HPE.iLO.Response.Redfish.SystemROMAndiLOEraseComponent SystemROMAndiLOEraseStatus : InProgress UserDataEraseComponentStatus : HPE.iLO.Response.Redfish.UserDataEraseComponent UserDataEraseStatus : InProgress IP : 10.20.30.1 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo : PS C:\> $out.SystemROMAndiLOEraseComponentStatus | fl BIOSSettingsEraseStatus : CompletedWithSuccess iLOSettingsEraseStatus : Idle PS C:\> $out.UserDataEraseComponentStatus | fl SmartStorageEraseStatus : NVMeDrivesEraseStatus : SATADrivesEraseStatus : NVDIMMEraseStatus : TPMEraseStatus</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEiLOSecureSystemEraseStatus -Connection $connection PS C:\> $out EraseStatus : ElapsedEraseTimeInMinutes : 4 EstimatedEraseTimeInMinutes : 3763 SystemROMAndiLOEraseComponentStatus : HPE.iLO.Response.Redfish.SystemROMAndiLOEraseComponent SystemROMAndiLOEraseStatus : InProgress UserDataEraseComponentStatus : HPE.iLO.Response.Redfish.UserDataEraseComponent UserDataEraseStatus : InProgress IP : 10.20.30.1 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo : ElapsedEraseTimeInMinutes : 0 EstimatedEraseTimeInMinutes : 0 SystemROMAndiLOEraseComponentStatus : HPE.iLO.Response.Redfish.SystemROMAndiLOEraseComponent SystemROMAndiLOEraseStatus : Idle UserDataEraseComponentStatus : HPE.iLO.Response.Redfish.UserDataEraseComponent UserDataEraseStatus : Idle IP : 10.20.40.1 Hostname : abcdef.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOSecureSystemErase</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-HPEiLOSecurityDashboardInfo</command:name> <maml:description> <maml:para>Gets Security dashboard information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSecurityDashboardInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets security dashboard information of an iLO server and works only on iLO5.</maml:para> <maml:para>The Security Dashboard displays the status of important security features, the Overall Security Status for the system, and the current configuration for the Security State and Server Configuration Lock features. Use the dashboard to evaluate your configuration for potential risks. When a risk is detected, you can view details and advice for how to improve system security.</maml:para> <maml:para>Prerequisites Configure iLO Settings privilege for configuring the Ignore option.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSecurityDashboardInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.SecurityDashboardInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $con = Connect-HPEiLO 192.168.10.31 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $sdata = $con | Get-HPEiLOSecurityDashboardInfo PS C:\> $sdata OverallSecurityStatus : Ignored SecurityParameters : {Security Override Switch, IPMI/DCMI Over LAN, Minimum Password Length, Require Login for iLO RBSU...} IP : 192.168.10.31 Hostname : bl460cgen10-03.powershvpn.com Status : OK StatusInfo : PS C:\> $sdata.SecurityParameters | ft Id Description Ignore IgnoredBy IgnoredTime Name SecurityStatus State RecommendedAction -- ----------- ------ --------- ----------- ---- -------------- ----- ----------------- 0 True admin 1/26/2019 4:40:52 PM Security Override Switch Risk On 1 True [NONE] 1/21/2019 8:38:03 PM IPMI/DCMI Over LAN Ok Disabled 2 True [NONE] 1/21/2019 8:38:03 PM Minimum Password Length Ok Ok 3 True [NONE] 1/21/2019 8:38:04 PM Require Login for iLO RBSU Ok Enabled 4 True [NONE] 1/21/2019 8:38:04 PM Authentication Failure Logging Risk Disabled 5 True [NONE] 1/21/2019 7:51:49 PM Secure Boot Risk Disabled 6 True [NONE] 1/21/2019 8:37:58 PM Password Complexity Risk Disabled 7 True admin 1/21/2019 8:27:43 PM Last Firmware Scan Result Ok Ok 8 True [NONE] 1/21/2019 8:38:05 PM Require Host Authentication Ok Disabled</dev:code> <dev:remarks> <maml:para>Gets security dashboard information for iLO5 server.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEiLOSecurityDashboardSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEiLOSecurityDashboardSetting</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-HPEiLOSecurityLog</command:name> <maml:description> <maml:para>Gets Security Log information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSecurityLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSecurityLog cmdlet gets the status of important security features, the Security Status for the system, and the current configuration for the Security State. Use the log data to evaluate your configuration for potential risks. When a risk is detected, you can view details and advice to improve system security. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSecurityLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.SecurityLogInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $output = Get-HPEiLOSecurityLog -Connection $connection PS C:\> $output Description : Security Logs view Name : Security Logs SecurityLog : {HPE.iLO.Response.Redfish.LogEntry, HPE.iLO.Response.Redfish.LogEntry, HPE.iLO.Response.Redfish.LogEntry} IP : 10.20.30.1 Hostname : Status : OK StatusInfo : PS C:\> $output.SecurityParameters Id : 0 Description : The Require Login for iLO RBSU setting is disabled. This configuration allows unauthenticated iLO access through the UEFI System Utilities. Ignore : False IgnoredBy : IgnoredTime : 1/1/0001 12:00:00 AM Name : Require Login for iLO RBSU SecurityStatus : Risk State : Disabled RecommendedAction : Enable the Require Login for iLO RBSU setting. Id : 1 Description : iLO is not configured to log authentication failures in the event log. Ignore : False IgnoredBy : IgnoredTime : 1/1/0001 12:00:00 AM Name : Authentication Failure Logging SecurityStatus : Risk State : Insufficient RecommendedAction : Enable the "Authentication Failure Logging" setting. Id : 2 Description : The UEFI Secure Boot setting is disabled. In this configuration, the UEFI system firmware does not validate the boot loader, Option ROM firmware, and other system software executables for trusted signatures. This configuration breaks the chain of trust established by iLO from power-on Ignore : False IgnoredBy : IgnoredTime : 1/1/0001 12:00:00 AM Name : Secure Boot SecurityStatus : Risk State : Disabled RecommendedAction : Enable the Secure Boot setting in the UEFI System Utilities.</dev:code> <dev:remarks> <maml:para>This example shows the usage of the cmdlet on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $output = ,$connection | Get-HPEiLOSecurityLog PS C:\> $output Description : Security Logs view Name : Security Logs SecurityLog : {HPE.iLO.Response.Redfish.LogEntry, HPE.iLO.Response.Redfish.LogEntry, HPE.iLO.Response.Redfish.LogEntry} IP : 10.20.30.1 Hostname : Status : OK StatusInfo : Description : Security Logs view Name : Security Logs SecurityLog : {HPE.iLO.Response.Redfish.LogEntry, HPE.iLO.Response.Redfish.LogEntry, HPE.iLO.Response.Redfish.LogEntry} IP : 10.20.30.2 Hostname : Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the usage of the cmdlet on iLO 5 with array of connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOSecurityLog</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-HPEiLOSelfTestResult</command:name> <maml:description> <maml:para>Gets the Selt Test Result detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSelfTestResult</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSelfTestResult cmdlet gets the Selt Test Result detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSelfTestResult</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.PCISlot[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOSelfTestResult PS C:\> $out iLOSelfTestResult : {HPE.iLO.Response.Redfish.iLOSelfTestDetail, HPE.iLO.Response.Redfish.iLOSelfTestDetail, HPE.iLO.Response.Redfish.iLOSelfTestDetail, HPE.iLO.Response.Redfish.iLOSelfTestDetail...} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.iLOSelfTestResult | fl SelfTestName : NVRAMData Status : OK Notes : SelfTestName : EmbeddedFlash Status : OK Notes : Controller firmware revision 2.10.00 SelfTestName : EEPROM Status : OK Notes : SelfTestName : HostRom Status : OK Notes : SelfTestName : SupportedHost Status : OK Notes : SelfTestName : PowerManagementController Status : Informational Notes : Version 1.0.0 SelfTestName : CPLDPAL0 Status : Informational Notes : ProLiant DL380 Gen10 System Programmable Logic Device 0x2A SelfTestName : ASICFuses Status : Degraded Notes : Programming error</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = Get-HPEiLOSelfTestResult -Connection $connection PS C:\> $out iLOSelfTestResult : {HPE.iLO.Response.Redfish.iLOSelfTestDetail, HPE.iLO.Response.Redfish.iLOSelfTestDetail, HPE.iLO.Response.Redfish.iLOSelfTestDetail, HPE.iLO.Response.Redfish.iLOSelfTestDetail...} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : iLOSelfTestResult : {HPE.iLO.Response.Redfish.iLOSelfTestDetail, HPE.iLO.Response.Redfish.iLOSelfTestDetail, HPE.iLO.Response.Redfish.iLOSelfTestDetail, HPE.iLO.Response.Redfish.iLOSelfTestDetail...} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOServerInfo</command:name> <maml:description> <maml:para>Gets the server information detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOServerInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOServerInfo cmdlet gets the server information detail.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOServerInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.ServerInfo[] or HPE.iLO.Response.Redfish.ServerInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOServerInfo PS C:\> $out FanInfo : {HPE.iLO.Response.RIBCL.Fan, HPE.iLO.Response.RIBCL.Fan, HPE.iLO.Response.RIBCL.Fan, HPE.iLO.Response.RIBCL.Fan...} FirmwareInfo : {HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation...} TemperatureInfo : {HPE.iLO.Response.RIBCL.Temperature, HPE.iLO.Response.RIBCL.Temperature, HPE.iLO.Response.RIBCL.Temperature, HPE.iLO.Response.RIBCL.Temperature...} PowerSupplyInfo : HPE.iLO.Response.RIBCL.iLO4.PowerSupply MemoryInfo : HPE.iLO.Response.RIBCL.iLO4.MemoryInfo NICInfo : HPE.iLO.Response.RIBCL.iLO4.NICInfo ProcessorInfo : {HPE.iLO.Response.RIBCL.Processor, HPE.iLO.Response.RIBCL.Processor} HealthSummaryInfo : HPE.iLO.Response.RIBCL.iLO4.HealthSummaryInfo ServerName : Poseidon Server HostOS : HPE.iLO.Response.RIBCL.iLO4.HostOS IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the usage of the cmdlet on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOServerInfo PS C:\> $out FanInfo : {HPE.iLO.Response.Redfish.Fan, HPE.iLO.Response.Redfish.Fan, HPE.iLO.Response.Redfish.Fan, HPE.iLO.Response.Redfish.Fan...} FirmwareInfo : {HPE.iLO.Response.Redfish.FirmwareInformation, HPE.iLO.Response.Redfish.FirmwareInformation, HPE.iLO.Response.Redfish.FirmwareInformation, HPE.iLO.Response.Redfish.FirmwareInformation...} TemperatureInfo : {HPE.iLO.Response.Redfish.Temperature, HPE.iLO.Response.Redfish.Temperature, HPE.iLO.Response.Redfish.Temperature, HPE.iLO.Response.Redfish.Temperature...} MemoryInfo : HPE.iLO.Response.Redfish.MemoryInfoDetail NICInfo : HPE.iLO.Response.Redfish.NICInfoDetail PowerSupplyInfo : HPE.iLO.Response.Redfish.PowerSupply ProcessorInfo : {HPE.iLO.Response.Redfish.Processor} HealthSummaryInfo : HPE.iLO.Response.Redfish.HealthSummaryInfo ServerName : Poseidon Server HostOS : HPE.iLO.Response.Redfish.HostOS IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the usage of the cmdlet on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = Get-HPEiLOServerInfo -Connection $connection PS C:\> $out FanInfo : {HPE.iLO.Response.RIBCL.Fan, HPE.iLO.Response.RIBCL.Fan, HPE.iLO.Response.RIBCL.Fan, HPE.iLO.Response.RIBCL.Fan...} FirmwareInfo : {HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation, HPE.iLO.Response.RIBCL.FirmwareInformation...} TemperatureInfo : {HPE.iLO.Response.RIBCL.Temperature, HPE.iLO.Response.RIBCL.Temperature, HPE.iLO.Response.RIBCL.Temperature, HPE.iLO.Response.RIBCL.Temperature...} PowerSupplyInfo : HPE.iLO.Response.RIBCL.iLO4.PowerSupply MemoryInfo : HPE.iLO.Response.RIBCL.iLO4.MemoryInfo NICInfo : HPE.iLO.Response.RIBCL.iLO4.NICInfo ProcessorInfo : {HPE.iLO.Response.RIBCL.Processor, HPE.iLO.Response.RIBCL.Processor} HealthSummaryInfo : HPE.iLO.Response.RIBCL.iLO4.HealthSummaryInfo ServerName : Poseidon Server HostOS : HPE.iLO.Response.RIBCL.iLO4.HostOS IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : FanInfo : {HPE.iLO.Response.Redfish.Fan, HPE.iLO.Response.Redfish.Fan, HPE.iLO.Response.Redfish.Fan, HPE.iLO.Response.Redfish.Fan...} FirmwareInfo : {HPE.iLO.Response.Redfish.FirmwareInformation, HPE.iLO.Response.Redfish.FirmwareInformation, HPE.iLO.Response.Redfish.FirmwareInformation, HPE.iLO.Response.Redfish.FirmwareInformation...} TemperatureInfo : {HPE.iLO.Response.Redfish.Temperature, HPE.iLO.Response.Redfish.Temperature, HPE.iLO.Response.Redfish.Temperature, HPE.iLO.Response.Redfish.Temperature...} MemoryInfo : HPE.iLO.Response.Redfish.MemoryInfoDetail NICInfo : HPE.iLO.Response.Redfish.NICInfoDetail PowerSupplyInfo : HPE.iLO.Response.Redfish.PowerSupply ProcessorInfo : {HPE.iLO.Response.Redfish.Processor} HealthSummaryInfo : HPE.iLO.Response.Redfish.HealthSummaryInfo ServerName : Poseidon Server HostOS : HPE.iLO.Response.Redfish.HostOS IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $con = Connect-HPEiLO 192.168.10.42 admin admin123 -DisableCertificateAuthentication PS C:\> $s = $con[0] | Get-HPEiLOServerInfo PS C:\> $s.MemoryInfo.MemoryDetails[0].MemoryData[0] BaseModuleType : BusWidthBits : 72 CapacityMiB : 0 DataWidthBits : 64 DeviceLocator : PROC 1 DIMM 1 DeviceID : ErrorCorrection : MultiBitECC FirmwareRevision : Manufacturer : MemoryDeviceType : DDR4 MemoryLocation : HPE.iLO.Response.Redfish.MemoryLocation MemoryMedia : {DRAM} MemoryType : DRAM Name : proc1dimm1 Armed : Attributes : DIMMStatus : NotPresent MaxOperatingSpeedMTs: 1266 MinimumVoltageVolts : 0 PredictedMediaLifeLeftPercent : ProductName : SPDBytes : RelatedPhysicalDIMMs : RelatedBackupStores : RelatedPowerBackupUnitBays : OperatingMemoryModes : OperatingSpeedMHz : PartNumber : PersistentRegionSizeLimitMiB : 0 RankCount : SerialNumber : Socket : 1 Slot : 1 Status : HPE.iLO.Response.Redfish.Status SubsystemDeviceID : SubsystemVendorID : VendorID : 0 VendorName: Samsung FirmwareApiVersion : SecurityStates : VolatileRegionSizeLimitMiB : 0 VolatileRegionNumberLimit : VolatileRegionSizeMaxMiB : VolatileSizeMiB : 0 AllocationIncrementMiB : AllocationAlignmentMiB : CacheSizeMiB : 0 LogicalSizeMiB : 0 NonVolatileSizeMiB : 0 PersistentRegionNumberLimit : PersistentRegionSizeMaxMiB : MemoryChunkSizePercentage : Regions : SecurityCapabilities : HPE.iLO.Response.Redfish.SecurityCapabilities</dev:code> <dev:remarks> <maml:para>Gets new memory information added in iLO5.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOServerPower</command:name> <maml:description> <maml:para>Gets the power state of the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOServerPower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOServerPower cmdlet gets the current power state of the server in which the iLO is operating.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOServerPower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.ServerPowerInfo[] or HPE.iLO.Response.Redfish.ServerPowerInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOServerPower ServerPower : Off IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOServerPower -Connection $connection ServerPower : On IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOServerPower ServerPower : Off IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : ServerPower : On IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOServerPowerRestoreSetting</command:name> <maml:description> <maml:para>Gets the current Automatic Power On and Power On Delay settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOServerPowerRestoreSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOServerPowerRestoreSetting cmdlet gets the current Automatic Power On and Power On Delay settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOServerPowerRestoreSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.ServerPowerRestoreSetting[] or HPE.iLO.Response.Redfish.ServerPowerRestoreSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOServerPowerRestoreSetting AutoPower : On PowerOnDelay : 15Sec IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 or iLO 5 server with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOServerPowerRestoreSetting -Connection $connection PowerAutoOn : On PowerOnDelay : 15Sec IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PowerAutoOn : Restore PowerOnDelay : Minimum IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOServerPowerRestoreSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOServerSoftwareInventory</command:name> <maml:description> <maml:para>Gets the server HPE software inventory detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOServerSoftwareInventory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOServerSoftwareInventory cmdlet gets the server HPE software inventory detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOServerSoftwareInventory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.ServerSoftwareInventory[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOServerSoftwareInventory PS C:\> $out ServerSoftwareInfo : {HPE.iLO.Response.Redfish.ServerSoftwareInfo, HPE.iLO.Response.Redfish.ServerSoftwareInfo, HPE.iLO.Response.Redfish.ServerSoftwareInfo, HPE.iLO.Response.Redfish.ServerSoftwareInfo} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.ServerSoftwareInfo Index : 1 Description : agentless management service Name : ams.exe Version : 1.1.0.0 DeviceContext : DeviceClass : e7a8b7dd-a6c0-4056-b14a-97bc423ddc7b DeviceInstance : Targets : {20a6e8e4-bf33-4c71-a6bf-d9ec8b303467} Index : 2 Description : qlogic gigabit ethernet vbd Name : BXVBDA.SYS Version : 7.12.31.105 DeviceContext : DeviceClass : e7a8b7dd-a6c0-4056-b14a-97bc423ddc7b DeviceInstance : Targets : {20a6e8e4-bf33-4c71-a6bf-d9ecd765f4f8} Index : 3 Description : qlogic 10 gige vbd Name : evbda.sys Version : 7.13.65.105 DeviceContext : DeviceClass : e7a8b7dd-a6c0-4056-b14a-97bc423ddc7b DeviceInstance : Targets : {20a6e8e4-bf33-4c71-a6bf-d9ec9bc6b74c} Index : 4 Description : smartraid, smarthba pqi storport driver Name : smartpqi.sys Version : 63.32.0.64 DeviceContext : DeviceClass : e7a8b7dd-a6c0-4056-b14a-97bc423ddc7b DeviceInstance : Targets : {20a6e8e4-bf33-4c71-a6bf-d9ec040331c1}</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = Get-HPEiLOServerSoftwareInventory -Connection $connection PS C:\> $out ServerSoftwareInfo : {HPE.iLO.Response.Redfish.ServerSoftwareInfo, HPE.iLO.Response.Redfish.ServerSoftwareInfo, HPE.iLO.Response.Redfish.ServerSoftwareInfo, HPE.iLO.Response.Redfish.ServerSoftwareInfo} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : ServerSoftwareInfo : {HPE.iLO.Response.Redfish.ServerSoftwareInfo, HPE.iLO.Response.Redfish.ServerSoftwareInfo, HPE.iLO.Response.Redfish.ServerSoftwareInfo, HPE.iLO.Response.Redfish.ServerSoftwareInfo} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOServerWorkloadInfo</command:name> <maml:description> <maml:para>Gets the list of workload characteristics for metrics.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOServerWorkloadInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The cmdlet Get-HPEiLOServerWorkloadInfo gets the list of workload characteristics for metrics. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOServerWorkloadInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.ServerWorkloadInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOServerWorkloadInfo PS C:\> $out ServerWorkloadData : {HPE.iLO.Response.Redfish.ServerWorkloadData, HPE.iLO.Response.Redfish.ServerWorkloadData, HPE.iLO.Response.Redfish.ServerWorkloadData} IP : 10.20.30.1 Hostname : xl170rgen10-02.powershvpn.com Status : OK StatusInfo : PS C:\> $out.ServerWorkloadData | fl Duration : 10min WorkloadCharacteristics : {HPE.iLO.Response.Redfish.WorkloadCharacteristics, HPE.iLO.Response.Redfish.WorkloadCharacteristics, HPE.iLO.Response.Redfish.WorkloadCharacteristics, HPE.iLO.Response.Redfish.WorkloadCharacteristics} Duration : 60min WorkloadCharacteristics : {HPE.iLO.Response.Redfish.WorkloadCharacteristics, HPE.iLO.Response.Redfish.WorkloadCharacteristics, HPE.iLO.Response.Redfish.WorkloadCharacteristics, HPE.iLO.Response.Redfish.WorkloadCharacteristics} Duration : 24hr WorkloadCharacteristics : {HPE.iLO.Response.Redfish.WorkloadCharacteristics, HPE.iLO.Response.Redfish.WorkloadCharacteristics, HPE.iLO.Response.Redfish.WorkloadCharacteristics, HPE.iLO.Response.Redfish.WorkloadCharacteristics} PS C:\> $out.ServerWorkloadData[0].WorkloadCharacteristics MetricId MetricValue -------- ----------- CPUUtil Low MemoryBusUtil Low IOBusUtil Low CPUICUtil High</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = Get-HPEiLOServerWorkloadInfo -Connection $connection PS C:\> $out ServerWorkloadData : {HPE.iLO.Response.Redfish.ServerWorkloadData, HPE.iLO.Response.Redfish.ServerWorkloadData, HPE.iLO.Response.Redfish.ServerWorkloadData} IP : 10.20.30.1 Hostname : abc.com Status : OK StatusInfo : ServerWorkloadData : {HPE.iLO.Response.Redfish.ServerWorkloadData, HPE.iLO.Response.Redfish.ServerWorkloadData, HPE.iLO.Response.Redfish.ServerWorkloadData} IP : 10.20.30.2 Hostname : pqrs.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOServicePort</command:name> <maml:description> <maml:para>Gets the service port detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOServicePort</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOServicePort cmdlet gets the service port detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOServicePort</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.ServicePort[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOServicePort MassStorageAuthenticationRequired : Yes USBEthernetAdaptersEnabled : No USBFlashDriveEnabled : Yes iLOServicePortEnabled : No IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOServicePort -Connection $connection MassStorageAuthenticationRequired : Yes USBEthernetAdaptersEnabled : No USBFlashDriveEnabled : Yes iLOServicePortEnabled : No IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : MassStorageAuthenticationRequired : Yes USBEthernetAdaptersEnabled : No USBFlashDriveEnabled : Yes iLOServicePortEnabled : No IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 servers with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOServicePort</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-HPEiLOSessionInfo</command:name> <maml:description> <maml:para>Gets the Session detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSessionInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSessionInfo cmdlet gets the Session detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSessionInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.SessionInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOSessionInfo PS C:\> $out Session : {HPE.iLO.Response.Redfish.Session, HPE.iLO.Response.Redfish.Session, HPE.iLO.Response.Redfish.Session, HPE.iLO.Response.Redfish.Session} IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.Session UserName : admin Id : admin000000005a5ed5ea7e76c868 AccessTime : 2018-01-17T06:10:40Z LoginTime : 2018-01-17T04:49:46Z UserExpires : 2018-01-17T06:40:40Z UserIP : 1.1.1.1 UserTag : Web UI UserType : Local UserPrivileges : MySession : False UserName : admin Id : admin000000005a5ee48c4e5603cd AccessTime : 2018-01-17T06:11:44Z LoginTime : 2018-01-17T05:52:12Z UserExpires : 2018-01-17T06:41:44Z UserIP : 1.1.1.1 UserTag : REST UserType : Local UserPrivileges : HPE.iLO.Response.Redfish.Privileges MySession : True UserName : admin Id : admin000000005a5ee1575126e92d AccessTime : 2018-01-17T05:54:04Z LoginTime : 2018-01-17T05:38:31Z UserExpires : 2018-01-17T06:24:04Z UserIP : 1.2.3.3 UserTag : REST UserType : Local UserPrivileges : MySession : False UserName : admin Id : admin000000005a5ee50c8c8b434a AccessTime : 2018-01-17T05:55:05Z LoginTime : 2018-01-17T05:54:20Z UserExpires : 2018-01-17T06:25:05Z UserIP : 1.2.2.2 UserTag : REST UserType : Local UserPrivileges : MySession : False PS C:\> $out.Session[1].UserPrivileges HostBIOSConfigPriv : True HostNICConfigPriv : True HostStorageConfigPriv : True LoginPriv : True RemoteConsolePriv : True SystemRecoveryConfigPriv : False UserConfigPriv : True VirtualMediaPriv : True VirtualPowerAndResetPriv : True iLOConfigPriv : True</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEiLOSessionInfo -Connection $connection Session : {HPE.iLO.Response.Redfish.Session, HPE.iLO.Response.Redfish.Session, HPE.iLO.Response.Redfish.Session, HPE.iLO.Response.Redfish.Session} IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : Session : {HPE.iLO.Response.Redfish.Session, HPE.iLO.Response.Redfish.Session, HPE.iLO.Response.Redfish.Session, HPE.iLO.Response.Redfish.Session} IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOSmartArrayStorageController</command:name> <maml:description> <maml:para>Gets the Smart Array Storage Controller detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSmartArrayStorageController</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSmartArrayStorageController cmdlet gets the Smart Array Storage Controller detail.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSmartArrayStorageController</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Drive</maml:name> <maml:description> <maml:para>Specifying this parameter will obtain the data of the mentioned drive. Possible values are 'PhysicalDrives', 'LogicalDrive', 'StorageEnclosures' and 'UnconfiguredDrives'. When this parameter is not given, data of all the drives will be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PhysicalDrives</command:parameterValue> <command:parameterValue required="false" variableLength="false">LogicalDrives</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnConfiguredDrives</command:parameterValue> <command:parameterValue required="false" variableLength="false">StorageEnclosure</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Drive</maml:name> <maml:description> <maml:para>Specifying this parameter will obtain the data of the mentioned drive. Possible values are 'PhysicalDrives', 'LogicalDrive', 'StorageEnclosures' and 'UnconfiguredDrives'. When this parameter is not given, data of all the drives will be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PhysicalDrives</command:parameterValue> <command:parameterValue required="false" variableLength="false">LogicalDrives</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnConfiguredDrives</command:parameterValue> <command:parameterValue required="false" variableLength="false">StorageEnclosure</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.SmartArrayStorageController[] or HPE.iLO.Response.REST.SmartArrayStorageController[] or HPE.iLO.Response.Redfish.SmartArrayStorageController[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>WARNING - After updating the iLO firmware, Do a server reboot, as the server will not reboot automatically. Server reboot is required to fetch the smart array controller details after iLO firmware update. In case of iLO 4 firmware version 2.40 or above, the cmdlet returns a detailed information from REST interface.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOSmartArrayStorageController PS C:\> $out Controllers : {HPE.iLO.Response.RIBCL.Controller} SmartArrayDiscoveryStatus : Discovery Complete IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.Controllers CacheMemorySizeMiB : 2000 CacheModuleSerialNumber : PDNLH0BRH9FBDI CacheModuleStatus : HPE.iLO.Response.Redfish.Status ControllerBoardStatus : OK Description : Controller on System Board EncryptionEnabled : False EncryptionStandaloneModeEnabled : False EncryptionSelfTestPassed : True EncryptionCSPTestPassed : True FirmwareVersion : 3.00 Model : Smart Array P440ar Controller SerialNumber : PDNLH0BRH9FBDI State : OK LogicalDrives : {HPE.iLO.Response.RIBCL.LogicalDrive} StorageEnclosures : {HPE.iLO.Response.RIBCL.StorageEnclosure, HPE.iLO.Response.RIBCL.StorageEnclosure} PS C:\> $out.Controllers[0].LogicalDrives Id : 01 CapacityMiB : 1143808 Raid : 1 LogicalDriveEncryption : False LogicalDriveType : Data LUN DataDrives : {HPE.iLO.Response.RIBCL.DiskDrive, HPE.iLO.Response.RIBCL.DiskDrive} State : OK PS C:\> $out.Controllers[0].LogicalDrives[0].DataDrives CapacityMiB : 1143808 DiskDriveUse : Data EncryptedDrive : False FirmwareVersion : HPD6 Location : Port 2I Box 3 Bay 7 CapacityGB : 1200 MediaType : HDD Model : EG1200FDNJT SerialNumber : L0HX90TK State : OK PS C:\> $out.Controllers[0].StorageEnclosures | fl DriveBayCount : 2 Location : Port 1I Box 1 State : OK</dev:code> <dev:remarks> <maml:para>This cmdlet shows the usage of cmdlet on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOSmartArrayStorageController PS C:\> $out Id : 0 AdapterType : SmartArray ArrayCount : BackupPowerSourceStatus : Present BootVolumePrimary : BootVolumeSecondary : CacheArrayCount : CacheLogicalDriveCount : CacheMemorySizeMiB : 2048 CacheModuleStatus : HPE.iLO.Response.Redfish.Status CachePhysicalDriveCount : CurrentOperatingMode : RAID CurrentParallelSurfaceScanCount : DataLogicalDriveCount : DataPhysicalDriveCount : DegradedPerformanceOptimization : Description : HP Smart Storage Array Controller View DriveWriteCache : ElevatorSort : EncryptionBootPasswordSet : EncryptionCryptoOfficerPasswordSet : False EncryptionEnabled : False EncryptionFwLocked : False EncryptionHasLockedVolumes : EncryptionHasLockedVolumesMissingBootPassword : False EncryptionHasSuspendedVolumes : EncryptionKeySet : EncryptionLocalKeyCacheEnabled : EncryptionMixedVolumesEnabled : False EncryptionPhysicalDriveCount : EncryptionRecoveryParamsSet : EncryptionStandaloneModeEnabled : False EncryptionUserPasswordSet : ExpandPriority : ExternalPortCount : 0 FirmwareVersion : 3.00 FlexibleLatencySchedulerSetting : HardwareRevision : B InconsistencyRepairPolicy : internalPortCount : 2 IsBootController : Location : Slot 0 LocationFormat : PCISlot LogicalDriveCount : Manufacturer : MaxParallelSurfaceScanCount : Model : Smart Array P440ar Controller Name : HpSmartStorageArrayController OperatingModeAfterReboot : ParallelSurfaceScanSupported : PhysicalDriveCount : PowerModeAfterReboot : PowerModeConfigured : PowerModeWarningChangedDrive : PowerModeWarningChangedMode : PowerModeWarningReboot : PowerModeWarningTemperature : PredictiveSpareRebuild : QueueDepth : RebuildPriority : SerialNumber : PDNLH0BRH9M63Y SoftwareRaidHbaFirmwareRev : SoftwareRaidHbaModeOptionRomRev : SparePhysicalDriveCount : SupportedOperatingModes : SupportedPowerModes : SupportedRaidLevels : SurfaceScanAnalysisPriority : UnassignedPhysicalDriveCount : LogicalDrives : {HPE.iLO.Response.REST.LogicalD rive} StorageEnclosures : {HpSmartStorageEnclosure, HpSmartStorageEnclosure} PhysicalDrives : {HPE.iLO.Response.REST.DiskDriv e, HPE.iLO.Response.REST.DiskDr ive} UnconfiguredDrives : State : OK Status : HPE.iLO.Response.REST.Status PS C:\> $out.Controllers[0].StorageEnclosures Id : 0 Description : HP Smart Storage Enclosure View DoorLockLED : DriveBayCount : 4 EnclosureLogicalID : FaultLED : FirmwareVersion : IndictorLED : Location : 1I:0 LocationFormat : Controller:Box Manufacturer : Model : Name : HpSmartStorageEnclosure PartNumber : SerialNumber : SKU : SubEnclosureLocation : State : OK Status : HPE.iLO.Response.REST.Status Id : 1 Description : HP Smart Storage Enclosure View DoorLockLED : DriveBayCount : 4 EnclosureLogicalID : FaultLED : FirmwareVersion : IndictorLED : Location : 2I:3 LocationFormat : Controller:Box Manufacturer : Model : Name : HpSmartStorageEnclosure PartNumber : SerialNumber : SKU : SubEnclosureLocation : State : OK Status : HPE.iLO.Response.REST.Status PS C:\> $out.Controllers[0].LogicalDrives Id : 1 BlockSizeBytes : CapacityMib : 1144609 Description : HP Smart Storage Logical Drive View DriveAccessName : DriveGeometryCylinders : DriveGeometryHeads : DriveGeometrySectors : LegacyBootPriority : LogicalDriveEncryption : False LogicalDriveEncryptionDataKeysVolatile : LogicalDriveEncryptionDataKeysVolatileBackup : LogicalDriveEncryptionDataKeysVolatileStatus : LogicalDriveName : 004C5287PDNLH0BRH9M63YB739 LogicalDriveNumber : 1 LogicalDriveType : Data Name : HpSmartStorageLogicalDrive ParityInitializationCompletionPercentage : ParityInitializationType : PartitionInformation : Raid : 1 RebuildCompletionPercentage : SmartCacheState : StripSizeBytes : StripeSizeBytes : 262144 TransformationCompletionPercentage : VolumeUniqueIdentifier : 600508B1001C2C31E7BDC641BCB8BBAA DataDrives : {HPE.iLO.Response.REST.DiskDrive , HPE.iLO.Response.REST.DiskDrive} TransientDataDrives : ActiveSpareDrives : StandbySpareDrives : State : OK Status : HPE.iLO.Response.REST.Status</dev:code> <dev:remarks> <maml:para>This cmdlet shows the usage of cmdlet on iLO 4 on a Gen 9 server with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOSmartArrayStorageController PS C:\> $out Controllers : {HPE.iLO.Response.Redfish.SmartArrayController} SmartArrayDiscoveryStatus : Complete IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $out.Controllers Id : 0 AdapterType : SmartArray ArrayCount : BackupPowerSourceStatus : Present BootVolumePrimary : BootVolumeSecondary : CacheArrayCount : CacheLogicalDriveCount : CacheMemorySizeMiB : 1024 CacheModuleSerialNumber : CacheModuleStatus : HPE.iLO.Response.Redfish.Status ControllerBoardStatus : OK CachePhysicalDriveCount : ControllerPartNumber : 836263-001 ControllerBoard : HPE.iLO.Response.Redfish.ControllerBoard CurrentOperatingMode : Mixed CurrentParallelSurfaceScanCount : DataLogicalDriveCount : DataPhysicalDriveCount : DegradedPerformanceOptimization : Description : HPE Smart Storage Array Controller View DriveWriteCache : Disabled ElevatorSort : EncryptionBootPasswordSet : EncryptionCryptoOfficerPasswordSet : False EncryptionCSPTestPassed : True EncryptionEnabled : False EncryptionFwLocked : False EncryptionHasLockedVolumes : EncryptionHasLockedVolumesMissingBootPassword : False EncryptionHasSuspendedVolumes : EncryptionKeySet : EncryptionLocalKeyCacheEnabled : EncryptionMixedVolumesEnabled : False EncryptionPhysicalDriveCount : EncryptionRecoveryParamsSet : EncryptionStandaloneModeEnabled : False EncryptionSelfTestPassed : True EncryptionUserPasswordSet : ExpandPriority : ExternalPortCount : 0 FirmwareVersion : 1.00 FlexibleLatencySchedulerSetting : HardwareRevision : B InconsistencyRepairPolicy : internalPortCount : 1 IsBootController : Location : Slot 0 LocationFormat : PCISlot LogicalDriveCount : Manufacturer : MaxParallelSurfaceScanCount : Model : HPE Smart Array P204i-b SR Gen10 Name : HpeSmartStorageArrayController WriteCacheWithoutBackupPowerEnabled : False OperatingModeAfterReboot : ParallelSurfaceScanSupported : PhysicalDriveCount : PowerModeAfterReboot : PowerModeConfigured : PowerModeWarningChangedDrive : PowerModeWarningChangedMode : PowerModeWarningReboot : PowerModeWarningTemperature : PredictiveSpareRebuild : QueueDepth : ReadCachePercent : 10 RebuildPriority : SerialNumber : PEYHFX5LM6002W SoftwareRaidHbaFirmwareRev : SoftwareRaidHbaModeOptionRomRev : SparePhysicalDriveCount : SupportedOperatingModes : SupportedPowerModes : SupportedRaidLevels : SurfaceScanAnalysisPriority : UnassignedPhysicalDriveCount : WriteCacheBypassThresholdKB : 1040 LogicalDrives : {HPE.iLO.Response.Redfish.LogicalDrive} StorageEnclosures : {HpSmartStorageEnclosure} PhysicalDrives : {HPE.iLO.Response.Redfish.DiskDrive, HPE.iLO.Response.Redfish.DiskDrive} UnconfiguredDrives : {HPE.iLO.Response.Redfish.DiskDrive} State : OK Status : HPE.iLO.Response.Redfish.Status PS C:\> $out.Controllers[0].ControllerBoard.Status | fl Health : OK State : HealthRollUp : PS C:\> $out.Controllers[0].StorageEnclosures Id : 0 Description : HPE Smart Storage Enclosure View DoorLockLED : DriveBayCount : 4 EnclosureLogicalID : FaultLED : FirmwareVersion : IndictorLED : Location : 1I:1 LocationFormat : Controller:Box Model : Name : HpSmartStorageEnclosure SerialNumber : SubEnclosureLocation : State : OK Status : HPE.iLO.Response.Redfish.Status PS C:\> $out.Controllers[0].PhysicalDrives Id : 0 BlockSizeBytes : 512 CapacityGB : 1000 CapacityLogicalBlocks : 1953525168 CapacityMiB : 953869 CarrierApplicationVersion : 11 CarrierAuthenticationStatus : OK CurrentTemperatureCelsius : 20 Description : HPE Smart Storage Disk Drive View DiskDriveStatusReasons : {None} DiskDriveUse : Data DriveConfiguration : HPG5 EncryptedDrive : False EraseCompletionPercentage : ErasePattern : FirmwareVersion : HPG5 IndicatorLED : InterfaceSpeedMbps : 6000 InterfaceType : SATA LegacyBootPriority : Primary Location : P1:1:1 LocationFormat : ControllerPort:Box:Bay Manufacturer : MaximumTemperatureCelsius : 25 MediaType : HDD MinimumGoodFirmwareVersion : Model : MM1000GEFQV Name : HpeSmartStorageDiskDrive NativeBlockSizeBytes : PhyCount : PortCount : PowerOnHours : RotationalSpeedRpm : 7200 SSDEnduranceUtilizationPercentage : SerialNumber : W470SRXX SpareRebuildMode : TransferSpeedMbps : WWID : State : OK Status : HPE.iLO.Response.Redfish.Status PS C:\> $out.Controllers[0].UnconfiguredDrives Id : 2 BlockSizeBytes : 512 CapacityGB : 1200 CapacityLogicalBlocks : 2344225968 CapacityMiB : 1144641 CarrierApplicationVersion : 11 CarrierAuthenticationStatus : OK CurrentTemperatureCelsius : 24 Description : HPE Smart Storage Disk Drive View DiskDriveStatusReasons : {None} DiskDriveUse : Raw DriveConfiguration : HPD6 EncryptedDrive : False EraseCompletionPercentage : ErasePattern : FirmwareVersion : HPD6 IndicatorLED : InterfaceSpeedMbps : 6000 InterfaceType : SAS LegacyBootPriority : Primary Location : P1:1:2 LocationFormat : ControllerPort:Box:Bay Manufacturer : MaximumTemperatureCelsius : 43 MediaType : HDD MinimumGoodFirmwareVersion : Model : EG1200FDNJT Name : HpeSmartStorageDiskDrive NativeBlockSizeBytes : PhyCount : PortCount : PowerOnHours : RotationalSpeedRpm : 10000 SSDEnduranceUtilizationPercentage : SerialNumber : L0HWMGXK SpareRebuildMode : TransferSpeedMbps : WWID : State : OK Status : HPE.iLO.Response.Redfish.Status</dev:code> <dev:remarks> <maml:para>This cmdlet shows the usage of the cmdlet on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOSmartArrayStorageController -Connection $connection Controllers : {HPE.iLO.Response.RIBCL.Controller} SmartArrayDiscoveryStatus : Discovery Complete IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : Controllers : {HPE.iLO.Response.Redfish.SmartArrayController} SmartArrayDiscoveryStatus : Complete IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 5</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOSmartArrayStorageController -Drive PhysicalDrives PS C:\> $out Controllers : {HPE.iLO.Response.Redfish.SmartArrayController} SmartArrayDiscoveryStatus : Complete IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $out.Controllers Id : 0 AdapterType : SmartArray ArrayCount : BackupPowerSourceStatus : Present BootVolumePrimary : BootVolumeSecondary : CacheArrayCount : CacheLogicalDriveCount : CacheMemorySizeMiB : 1024 CacheModuleSerialNumber : CacheModuleStatus : HPE.iLO.Response.Redfish.Status ControllerBoardStatus : OK CachePhysicalDriveCount : ControllerPartNumber : 836263-001 ControllerBoard : HPE.iLO.Response.Redfish.ControllerBoard CurrentOperatingMode : Mixed CurrentParallelSurfaceScanCount : DataLogicalDriveCount : DataPhysicalDriveCount : DegradedPerformanceOptimization : Description : HPE Smart Storage Array Controller View DriveWriteCache : Disabled ElevatorSort : EncryptionBootPasswordSet : EncryptionCryptoOfficerPasswordSet : False EncryptionCSPTestPassed : True EncryptionEnabled : False EncryptionFwLocked : False EncryptionHasLockedVolumes : EncryptionHasLockedVolumesMissingBootPassword : False EncryptionHasSuspendedVolumes : EncryptionKeySet : EncryptionLocalKeyCacheEnabled : EncryptionMixedVolumesEnabled : False EncryptionPhysicalDriveCount : EncryptionRecoveryParamsSet : EncryptionStandaloneModeEnabled : False EncryptionSelfTestPassed : True EncryptionUserPasswordSet : ExpandPriority : ExternalPortCount : 0 FirmwareVersion : 1.00 FlexibleLatencySchedulerSetting : HardwareRevision : B InconsistencyRepairPolicy : internalPortCount : 1 IsBootController : Location : Slot 0 LocationFormat : PCISlot LogicalDriveCount : Manufacturer : MaxParallelSurfaceScanCount : Model : HPE Smart Array P204i-b SR Gen10 Name : HpeSmartStorageArrayController WriteCacheWithoutBackupPowerEnabled : False OperatingModeAfterReboot : ParallelSurfaceScanSupported : PhysicalDriveCount : PowerModeAfterReboot : PowerModeConfigured : PowerModeWarningChangedDrive : PowerModeWarningChangedMode : PowerModeWarningReboot : PowerModeWarningTemperature : PredictiveSpareRebuild : QueueDepth : ReadCachePercent : 10 RebuildPriority : SerialNumber : PEYHFX5LM6002W SoftwareRaidHbaFirmwareRev : SoftwareRaidHbaModeOptionRomRev : SparePhysicalDriveCount : SupportedOperatingModes : SupportedPowerModes : SupportedRaidLevels : SurfaceScanAnalysisPriority : UnassignedPhysicalDriveCount : WriteCacheBypassThresholdKB : 1040 LogicalDrives : StorageEnclosures : PhysicalDrives : {HPE.iLO.Response.Redfish.DiskDrive, HPE.iLO.Response.Redfish.DiskDrive} UnconfiguredDrives : State : OK Status : HPE.iLO.Response.Redfish.Status PS C:\> $out.Controllers[0].PhysicalDrives Id : 0 BlockSizeBytes : 512 CapacityGB : 1000 CapacityLogicalBlocks : 1953525168 CapacityMiB : 953869 CarrierApplicationVersion : 11 CarrierAuthenticationStatus : OK CurrentTemperatureCelsius : 20 Description : HPE Smart Storage Disk Drive View DiskDriveStatusReasons : {None} DiskDriveUse : Data DriveConfiguration : HPG5 EncryptedDrive : False EraseCompletionPercentage : ErasePattern : FirmwareVersion : HPG5 IndicatorLED : InterfaceSpeedMbps : 6000 InterfaceType : SATA LegacyBootPriority : Primary Location : P1:1:1 LocationFormat : ControllerPort:Box:Bay Manufacturer : MaximumTemperatureCelsius : 25 MediaType : HDD MinimumGoodFirmwareVersion : Model : MM1000GEFQV Name : HpeSmartStorageDiskDrive NativeBlockSizeBytes : PhyCount : PortCount : PowerOnHours : RotationalSpeedRpm : 7200 SSDEnduranceUtilizationPercentage : SerialNumber : W470SRXX SpareRebuildMode : TransferSpeedMbps : WWID : State : OK Status : HPE.iLO.Response.Redfish.Status </dev:code> <dev:remarks> <maml:para>This cmdlet shows the usage of the cmdlet on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOSmartStorageBattery</command:name> <maml:description> <maml:para>Gets the smart storage battery detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSmartStorageBattery</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSmartStorageBattery gets the smart storage battery detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSmartStorageBattery</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.SmartStorageBatteryInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOSmartStorageBattery SmartStorageBattery : { HPE.iLO.Response.Redfish.SmartStorageBattery } IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.SmartStorageBattery Label : 1 Model : 727258-B21 SparePartNumber : 871264-001 SerialNumber : 6WEJD0JB2887BD ProductName : HPE Smart Storage Battery Capacity : 96 Watts FirmwareVersion : 2.1 BatteryWearLevelPercent : ChargeLevelPercent : 98 ErrorCode : FailurePredicted : RemainingChargeTimeSeconds : 0 Status : HPE.iLO.Response.Redfish.Status</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOSmartStorageBattery -Connection $connection SmartStorageBattery : { HPE.iLO.Response.Redfish.SmartStorageBattery } IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : SmartStorageBattery : { HPE.iLO.Response.Redfish.SmartStorageBattery } IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 servers with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOSMHFQDN</command:name> <maml:description> <maml:para>Retrieves the System Management Homepage (SMH) fully qualified domain name.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSMHFQDN</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSMHFQDN cmdlet retrieves the System Management Homepage (SMH) fully qualified domain name. This cmdlet is supported only on iLO 4 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSMHFQDN</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.SMHFQDN[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOSMHFQDN SMHFQDN : testFQDN IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOSMHFQDN -Connection $connection SMHFQDN : testFQDN IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : SMHFQDN : testFQDN1 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 servers with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSMHFQDN</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-HPEiLOSNMPAlertDestination</command:name> <maml:description> <maml:para>Gets the SNMP alert destination.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSNMPAlertDestination</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSNMPAlertDestination gets the SNMP alert destination details.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSNMPAlertDestination</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.iLO4.SNMPAlertDestinationInfo[] or HPE.iLO.Response.Redfish.SNMPAlertDestinationInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOSNMPAlertDestination PS C:\> $out SNMPAlertDestination : {HPE.iLO.Response.RIBCL.iLO4.SNMPv3Alert, HPE.iLO.Response.RIBCL.iLO4.SNMPv3Alert, HPE.iLO.Response.RIBCL.iLO4.SNMPv3Alert} IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $out.SNMPv3AlertDestination | fl ID : 1 AlertDestination : 2.2.2.2 TrapCommunity : 2.2.2.2 TrapCommunityVersion : v2c ID : 2 AlertDestination : 8.8.8.8 TrapCommunity : 5.5.5.5 TrapCommunityVersion : ID : 3 AlertDestination : TrapCommunity : TrapCommunityVersion :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOSNMPAlertDestination PS C:\> $out SNMPAlertDestination : {HPE.iLO.Response.Redfish.SNMPv3Alert, HPE.iLO.Response.Redfish.SNMPv3Alert, HPE.iLO.Response.Redfish.SNMPv3Alert, HPE.iLO.Response.Redfish.SNMPv3Alert...} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.SNMPAlertDestination ID : 1 SNMPv3User : amdin123223 AlertDestination : 2.2.2.2 AlertProtocol : SNMPv3Trap TrapCommunity : 1.1.1.1 ID : 2 SNMPv3User : amdin123223 AlertDestination : 3.3.3.3 AlertProtocol : SNMPv3Inform TrapCommunity : 5.5.5.5 ID : 3 SNMPv3User : amdin123223 AlertDestination : 3.3.3.3 AlertProtocol : SNMPv3Trap TrapCommunity : 5.5.5.5 ID : 4 SNMPv3User : AlertDestination : 5 AlertProtocol : SNMPv1Trap TrapCommunity : ID : 5 SNMPv3User : amdin123223 AlertDestination : 4.4.4.4 AlertProtocol : SNMPv3Trap TrapCommunity : 1.1.1.1</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOSNMPAlertDestination -Connection $connection SNMPAlertDestination : {HPE.iLO.Response.RIBCL.iLO4.SNMPv3Alert, HPE.iLO.Response.RIBCL.iLO4.SNMPv3Alert, HPE.iLO.Response.RIBCL.iLO4.SNMPv3Alert} IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : SNMPAlertDestination : {HPE.iLO.Response.Redfish.SNMPv3Alert, HPE.iLO.Response.Redfish.SNMPv3Alert, HPE.iLO.Response.Redfish.SNMPv3Alert, HPE.iLO.Response.Redfish.SNMPv3Alert...} IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSNMPAlertDestination</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOSNMPAlertDestination</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOSNMPAlertDestination</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-HPEiLOSNMPAlertSetting</command:name> <maml:description> <maml:para>Gets the SNMP Alert setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSNMPAlertSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSNMPAlertSetting cmdlet gets the SNMP Alert setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSNMPAlertSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.iLO4.SNMPAlertSetting[] or HPE.iLO.Response.Redfish.SNMPAlertSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOSNMPAlertSetting TrapSourceIdentifier : iLOHostname AlertEnabled : Yes ColdStartTrapBroadcast : Enabled SNMPv1Trap : Enabled WebAgentIPAddress : WIN-GV6EVFE891C CIMSecurityMask : Enabled OSTrap : Enabled IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOSNMPAlertSetting TrapSourceIdentifier : OSHostname AlertEnabled : Yes ColdStartTrapBroadcast : Enabled PeriodicHSATrapConfiguration : Disabled SNMPv1Trap : Enabled IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOSNMPAlertSetting -Connection $connection TrapSourceIdentifier : iLOHostname AlertEnabled : Yes ColdStartTrapBroadcast : Enabled SNMPv1Trap : Enabled WebAgentIPAddress : WIN-GV6EVFE891C CIMSecurityMask : Enabled OSTrap : Enabled IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo : TrapSourceIdentifier : OSHostname AlertEnabled : Yes ColdStartTrapBroadcast : Enabled PeriodicHSATrapConfiguration : Disabled SNMPv1Trap : IP : 10.20.30.2 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSNMPAlertSetting</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-HPEiLOSNMPPowerAlertThreshold</command:name> <maml:description> <maml:para>Gets the power alert threshold for the iLO devices.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSNMPPowerAlertThreshold</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOPowerAlertThreshold cmdlet gets the power alert threshold for the iLO devices. You must purchase the iLO Advanced license to enable this feature. The details returned include:</maml:para> <maml:para>· PowerAlertType - Valid values are: -Disabled - No power alerts are set. -Peak - Represents the half-second average power reading during the sample. -Average - Represents the mean power reading during the sample.</maml:para> <maml:para>· PowerAlertThreshold - Sets the alert threshold in Watts.</maml:para> <maml:para>· PowerAlertDuration - Sets the length of the sample time, in minutes, starting at 5. Duration will always be in 5 minute intervals up to 240 minutes maximum. Any positive integer can be used, but it will be rounded off to the nearest 5 minutes.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSNMPPowerAlertThreshold</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.SNMPPowerAlertThreshold[] or HPE.iLO.Response.Redfish.SNMPPowerAlertThreshold[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOSNMPPowerAlertThreshold PowerAlertType : Peak PowerAlertThreshold : 340 PowerAlertDuration : 5 IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOSNMPPowerAlertThreshold -Connection $connection PowerAlertType : Average PowerAlertThreshold : 340 PowerAlertDuration : 5 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusMessage : StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOSNMPPowerAlertThreshold PowerAlertType : Peak PowerAlertThreshold : 300 PowerAlertDuration : 20 IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusMessage : StatusInfo : PowerAlertType : Average PowerAlertThreshold : 340 PowerAlertDuration : 5 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusMessage : StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSNMPPowerAlertThreshold</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-HPEiLOSNMPSetting</command:name> <maml:description> <maml:para>Gets the SNMP setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSNMPSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSNMPSetting cmdlet gets the SNMP setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSNMPSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.iLO4.SNMPSetting[] or HPE.iLO.Response.Redfish.SNMPSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOSNMPSetting SystemLocation : 2.2.2.2 SystemContact : 12345 SystemRole : admin123 SystemRoleDetail : detailexplaination ReadCommunity1 : 2.2.2.2 ReadCommunity2 : 2.2.2.2 ReadCommunity3 : SNMPEnabled : Yes SNMPPort : 161 SNMPTrapPort : 162 SNMPConnectedVia : AgentlessManagement IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOSNMPSetting SystemLocation : 2.2.2.2 SystemContact : 112345 SystemRole : admin123 SystemRoleDetail : detailexplaination ReadCommunity1 : abcd ReadCommunity2 : 2.2.2.2 ReadCommunity3 : SNMPEnabled : Yes SNMPPort : 161 IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOSNMPSetting -Connection $connection SystemLocation : 2.2.2.2 SystemContact : 1123456 SystemRole : admin123 SystemRoleDetail : detailexplaination ReadCommunity1 : 2.2.2.2 ReadCommunity2 : 2.2.2.2 ReadCommunity3 : SNMPEnabled : Yes SNMPPort : 161 SNMPTrapPort : 162 SNMPConnectedVia : AgentlessManagement IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : SystemLocation : 2.2.2.2 SystemContact : 123456 SystemRole : admin123 SystemRoleDetail : detailexplaination ReadCommunity1 : abcd ReadCommunity2 : 2.2.2.2 ReadCommunity3 : SNMPEnabled : Yes SNMPPort : 161 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSNMPSetting</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-HPEiLOSNMPv3Setting</command:name> <maml:description> <maml:para>Gets the SNMPv3 setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSNMPv3Setting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSNMPv3Setting cmdlet gets the SNMPv3 setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSNMPv3Setting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.iLO4.SNMPv3Setting[] or HPE.iLO.Response.Redfish.SNMPv3Setting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOSNMPv3Setting SNMPv3EngineID : 0x0102abdc IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Get-HPEiLOSNMPv3Setting SNMPv3EngineID : 0x0102abdc SNMPv3InformRetryAttempt : 5 SNMPv3InformRetryIntervalSeconds : 20 IP : 10.20.30.1 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOSNMPv3Setting -Connection $connection SNMPv3EngineID : 0x0102abdc IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : SNMPv3EngineID : 0x0102abdc SNMPv3InformRetryAttempt : 5 SNMPv3InformRetryIntervalSeconds : 20 IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSNMPv3Setting</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-HPEiLOSNMPv3User</command:name> <maml:description> <maml:para>Gets the SNMPv3User detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSNMPv3User</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSNMPv3User cmdlet gets the SNMPv3User detail.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSNMPv3User</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.iLO4.SNMPv3User[] or HPE.iLO.Response.Redfish.SNMPv3User[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOSNMPv3User PS C:\> $out SNMPv3User : {HPE.iLO.Response.RIBCL.iLO4.SNMPv3User} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.SNMPv3User | fl ID : 1 SecurityName : newuser AuthenticationProtocol : SHA PrivacyProtocol : AES</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOSNMPv3User PS C:\> $out SNMPv3User : {HPE.iLO.Response.Redfish.SNMPv3User, HPE.iLO.Response.Redfish.SNMPv3User, HPE.iLO.Response.Redfish.SNMPv3User, HPE.iLO.Response.Redfish.SNMPv3User...} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.SNMPv3User ID : 1 SecurityName : testsnmp AuthenticationProtocol : MD5 PrivacyProtocol : DES UserEngineID : ID : 3 SecurityName : admin123 AuthenticationProtocol : SHA PrivacyProtocol : DES UserEngineID : ID : 4 SecurityName : newuser12356 AuthenticationProtocol : SHA PrivacyProtocol : DES UserEngineID : ID : 5 SecurityName : test123 AuthenticationProtocol : MD5 PrivacyProtocol : AES UserEngineID : ID : 6 SecurityName : test13 AuthenticationProtocol : MD5 PrivacyProtocol : AES UserEngineID : ID : 7 SecurityName : test1 AuthenticationProtocol : MD5 PrivacyProtocol : AES UserEngineID :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Get-HPEiLOSNMPv3User -Connection $connection SNMPv3User : {HPE.iLO.Response.RIBCL.iLO4.SNMPv3User} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : SNMPv3User : {HPE.iLO.Response.Redfish.SNMPv3User, HPE.iLO.Response.Redfish.SNMPv3User, HPE.iLO.Response.Redfish.SNMPv3User, HPE.iLO.Response.Redfish.SNMPv3User...} IP : 10.20.30.2 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSNMPv3User</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOSNMPv3User</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOSNMPv3User</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-HPEiLOSNTPSetting</command:name> <maml:description> <maml:para>Gets the SNTP settings of the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSNTPSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSNTPSetting cmdlet retrieves the SNTP setting details of the server.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSNTPSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>InterfaceType specifies the type of network connection present in the manager. The possible values are Dedicated and Shared. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dedicated</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shared</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>InterfaceType specifies the type of network connection present in the manager. The possible values are Dedicated and Shared. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dedicated</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shared</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.SNTPSetting[] or HPE.iLO.Response.Redfish.SNTPSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>. In case of iLO 5, when InterfaceType is not provided, default setting will be retrieved.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOSNTPSetting PropagateTimetoHost : Disabled SNTPServer : {, } TimeZone : Atlantic/Reykjavik DHCPv4NTPServer : Disabled DHCPv6NTPServer : Enabled IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet gets the SNTP setting of the iLO target for iLO 4 server and the connection is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $out = Get-HPEiLOSNTPSetting -Connection $connection -InterfaceType Shared PS C:\> $out PropagateTimetoHost : Disabled SNTPServer : {, } TimeZone : DHCPv4NTPServer : Disabled DHCPv6NTPServer : Enabled SupportedTimeZone : {HPE.iLO.Response.Redfish.TimeZoneList, HPE.iLO.Response.Redfish.TimeZoneList, HPE.iLO.Response.Redfish.TimeZoneList, HPE.iLO.Response.Redfish.TimeZoneList...} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet gets the SNTP setting info of the iLO target for iLO 5 server and the connection is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOSNTPSetting -Connection $connection PropagateTimetoHost : Disabled SNTPServer : {, } TimeZone : Atlantic/Reykjavik DHCPv4NTPServer : Disabled DHCPv6NTPServer : Enabled IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PropagateTimetoHost : Disabled SNTPServer : {, } TimeZone : DHCPv4NTPServer : Disabled DHCPv6NTPServer : Enabled SupportedTimeZone : {HPE.iLO.Response.Redfish.TimeZoneList, HPE.iLO.Response.Redfish.TimeZoneList, HPE.iLO.Response.Redfish.TimeZoneList, HPE.iLO.Response.Redfish.TimeZoneList...} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSNTPSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOSpatial</command:name> <maml:description> <maml:para>Gets the location information and system data with Asset Manager to obtain more precise and complete asset data.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSpatial</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSpatial cmdlet gets the location information and system data with Asset Manager to obtain more precise and complete asset data. This cmdlet is supported only on iLO 4 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSpatial</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.iLO4.Spatial[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOSpatial Platform : BLADE DiscoveryRack : Not Supported DiscoveryData : Server does not support Location Discovery Services TagVersion : 0 RackID : 0 RackIDPN : 0 RackCUUID : RackDescription : 0 RackUHeight : 0 UPosition : 0 ULocation : 0 CUUID : 00000000-0000-4E43-3736-313330393837 UHeight : 10.00 UOffset : 2 Bay : 4 DeviceUPosition : 0 EnclosureCUUID : 53553930-3945-3432-4D56-4131 0 0 0 0 1 2 030 EnclosureSN : USE924MVA1 IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet gets the Spatial information of the iLO target for iLO 4 server and the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOSpatial -Connection $connection Platform : BLADE DiscoveryRack : Not Supported DiscoveryData : Server does not support Location Discovery Services TagVersion : 0 RackID : 0 RackIDPN : 0 RackCUUID : RackDescription : 0 RackUHeight : 0 UPosition : 0 ULocation : 0 CUUID : 00000000-0000-4E43-3736-313330393837 UHeight : 10.00 UOffset : 2 Bay : 4 DeviceUPosition : 0 EnclosureCUUID : 53553930-3945-3432-4D56-4131 0 0 0 0 1 2 030 EnclosureSN : USE924MVA1 IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : Platform : DL/ML DiscoveryRack : Not Supported DiscoveryData : Server does not detect Location Discovery Services TagVersion : 0 RackID : 0 RackIDPN : 0 RackCUUID : RackDescription : 0 RackUHeight : 0 UPosition : 0 ULocation : 0 CUUID : 38334C44-0030-584D-5135-34353043424A UHeight : 2.00 UOffset : 0 Bay : DeviceUPosition : 0 EnclosureCUUID : EnclosureSN : IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOSSLCertificateInfo</command:name> <maml:description> <maml:para>Gets the SSL certificate information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSSLCertificateInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSSLCertificateInfo cmdlet gets the SSL certificate information.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSSLCertificateInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.SSLCertificateInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOSSLCertificateInfo PS C:\> $out Issuer : DC = com, DC = powershvpn, CN = RootCApowershvpn-POWERSHELLVPN-CA SerialNumber : 5b:00:00:00:74:5e:78:23:12346:1a:12:3d:00:02:00:00:00:74 Subject : C = US, ST = Texas, L = Houston, O = Hewlett-Packard Company, OU = ISS, CN = ILO ValidNotAfter : 2019-01-03T06:50:13Z ValidNotBefore : 2018-02-08T07:53:37Z IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet gets the SSl certificate information of the iLO target with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOSSLCertificateInfo -Connection $connection Issuer : DC = com, DC = powershvpn, CN = RootCApowershvpn-POWERSHELLVPN-CA SerialNumber : 5b:00:00:00:74:5e:78:23:12346:1a:12:3d:00:02:00:00:00:74 Subject : C = US, ST = Texas, L = Houston, O = Hewlett-Packard Company, OU = ISS, CN = ILO ValidNotAfter : 2019-01-03T06:50:13Z ValidNotBefore : 2018-02-08T07:53:37Z IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : Issuer : DC = com, DC = powershvpn, CN = RootCApowershvpn-POWERSHELLVPN-CA SerialNumber : 5b:00:00:00:74:5e:78:23:12346:1a:12:3d:00:02:00:00:00:74 Subject : C = US, ST = Texas, L = Houston, O = Hewlett-Packard Company, OU = ISS, CN = ILO ValidNotAfter : 2019-01-03T06:50:13Z ValidNotBefore : 2018-02-08T07:53:37Z IP : 10.20.30.41 Hostname : xyz.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-HPEiLOCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPEiLOCertificateSigningRequest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOCertificateSigningRequest</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-HPEiLOSSOSetting</command:name> <maml:description> <maml:para>Gets the SSO Setting for the iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSSOSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSSOSetting cmdlet gets SSO settings for iLO. There are three roles - UserRole, OperatorRole and AdministratorRole. This cmdlet gets the all privileges for these roles.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSSOSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.SSOSetting[] or HPE.iLO.Response.Redfish.SSOSetting[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOSSOSetting PS C:\> $obj | fl TrustMode : CERTIFICATE AdministratorRole : HPE.iLO.Response.RIBCL.Privilege OperatorRole : HPE.iLO.Response.RIBCL.Privilege UserRole : HPE.iLO.Response.RIBCL.Privilege SSOServer : {HPE.iLO.Response.RIBCL.SSOServer} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $obj.AdministratorRole LoginPrivilege : Yes RemoteConsolePrivilege : Yes UserConfigPrivilege : Yes VirtualMediaPrivilege : Yes VirtualPowerAndResetPrivilege : Yes iLOConfigPrivilege : Yes PS C:\> $obj.SSOServer Index : 1 IssuedTo : IssuedBy : ValidFrom : ValidUntil : Value : -----BEGIN CERTIFICATE----- 12345 -----END CERTIFICATE-----</dev:code> <dev:remarks> <maml:para>This cmdlet gets the SSO setting of the iLO target for iLO 4 server. $connection is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOSSOSetting PS C:\> $obj | fl TrustMode : TrustbyCertificate AdministratorRole : HPE.iLO.Response.Redfish.Privilege OperatorRole : HPE.iLO.Response.Redfish.Privilege UserRole : HPE.iLO.Response.Redfish.Privilege SSOServer : {VM-Win12-02.powershvpn.com, w11ebsew11rv1er141.powershvpn12.com, w11ebsew11rv1er141.powershvpn21.com} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $obj.AdministratorRole HostBIOSConfigPrivilege : Yes HostNICConfigPrivilege : No HostStorageConfigPrivilege : No LoginPrivilege : Yes RemoteConsolePrivilege : Yes SystemRecoveryConfigPrivilege : Yes UserConfigPrivilege : Yes VirtualMediaPrivilege : Yes VirtualPowerAndResetPrivilege : Yes iLOConfigPrivilege : Yes PS C:\> $obj.SSOServer RecordType : Certificate ServerName : VM-Win12-02.powershvpn.com Status : OK Index : 1 IssuedTo : VM-Win12-02.powershvpn.com IssuedBy : RootCApowershvpn-POWERSHELLVPN-CA ValidFrom : 12/16/2016 7:19:16 AM ValidUntil : 12/16/2017 7:19:16 AM Certificate : -----BEGIN CERTIFICATE----- MIIFkTCCBHmgAwIBAgITWwAAAA0VJD4n0CgiCgABAAAADTANBgkqhkiG9w0BAQsF ADBdMRMwEQYKCZImiZPyLGQBGRYDY29tMRowGAYKCZImiZPyLGQBGRYKcG93ZXJz aHZwbjEqMCgGA1UEAxMhUm9vdENBcG93ZXJzaHZwbi1QT1dFUlNIRUxMVlBOLUNB MB4XDTE2MTIxNjA3MTkxNloXDTE3MTIxNjA3MTkxNlowJTEjMCEGA1UEAxMaVk0t V2luMTItMDIucG93ZXJzaHZwbi5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw -----END CERTIFICATE----- RecordType : DNSName ServerName : w11ebsabcd1rv1er141.powershvpn12.com Status : Degraded Index : 2 IssuedTo : IssuedBy : ValidFrom : 1/1/0001 12:00:00 AM ValidUntil : 1/1/0001 12:00:00 AM Certificate : RecordType : DNSName ServerName : wdefs41.powershvpn21.com Status : Degraded Index : 3 IssuedTo : IssuedBy : ValidFrom : 1/1/0001 12:00:00 AM ValidUntil : 1/1/0001 12:00:00 AM Certificate :</dev:code> <dev:remarks> <maml:para>This cmdlet gets the SSO setting of the iLO target for iLO 5 connection object. $connection is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOSSOSetting -Connection $connection TrustMode : CERTIFICATE AdministratorRole : HPE.iLO.Response.RIBCL.Privilege OperatorRole : HPE.iLO.Response.RIBCL.Privilege UserRole : HPE.iLO.Response.RIBCL.Privilege IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : TrustMode : TrustbyCertificate AdministratorRole : HPE.iLO.Response.Redfish.Privilege OperatorRole : HPE.iLO.Response.Redfish.Privilege UserRole : HPE.iLO.Response.Redfish.Privilege SSOServer : {SSOServer} IP : 10.20.30.41 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSSOSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOSSORecord</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOSSORecord</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-HPEiLOSystemDiagnosticsModeSetting</command:name> <maml:description> <maml:para>Gets the system diagnostics mode setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSystemDiagnosticsModeSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSystemDiagnosticsModeSetting cmdlet defines whether the Intelligent Diagnostics and System Safe Mode is Enabled or Disabled. This cmdlet is supported only on iLO 5 Gen10 Plus systems.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSystemDiagnosticsModeSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLOResponse.Redfish.SystemDiagnosticsModeSetting</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOSystemDiagnosticsModeSetting PS C:\> $out SystemIntelligentDiagnosticsModeEnabled : False SystemSafeModeEnabled : False IP : 10.20.30.40 Hostname : Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet gets the diagnostics mode settings of the iLO target with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOSSLCertificateInfo -Connection $connection PS C:\> $out SystemIntelligentDiagnosticsModeEnabled : False SystemSafeModeEnabled : False IP : 10.20.30.40 Hostname : Status : OK StatusInfo : SystemIntelligentDiagnosticsModeEnabled : True SystemSafeModeEnabled : False IP : 10.20.30.41 Hostname : Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEiLOSystemIntelligentDiagnosticsMode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEiLOSystemSafeMode</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-HPEiLOSystemInfo</command:name> <maml:description> <maml:para>Gets the system information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSystemInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets the comprehensive target system information. This cmdlet is supported only on iLO 5.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSystemInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.SystemInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$connection is passed via commandline. PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = Get-HPEiLOSystemInfo -Connection $connection PS C:\> $obj | fl AssetTag : a 234567890123456789012345678901 BiosVersion : I41 v1.30 (12/14/2017) Boot : HPE.iLO.Response.Redfish.ComputerSystemBoot Description : DNSHostName : Id : 1 IndicatorLED : Off Manufacturer : HPE MemorySummary : HPE.iLO.Response.Redfish.Memorysummary Model : ProLiant BL460c Gen10 Name : Computer System PartNumber : PowerState : Off ProcessorSummary : HPE.iLO.Response.Redfish.Processorsummary SKU : BL460cGen10 SerialNumber : 2M270801TB SystemType : Physical TrustedModules : {HPE.iLO.Response.Redfish.Trustedmodule} AggregateHealthStatus : HPE.iLO.Response.Redfish.AggregateHealthStatus Bios : HPE.iLO.Response.Redfish.HpeComputerSystemExtBios CurrentPowerOnTimeSeconds : DeviceDiscoveryComplete : HPE.iLO.Response.Redfish.DeviceDiscoverycomplete EndOfPostDelaySeconds : 90 HostOS : IsColdBooting : IntelligentProvisioningAlwaysOn : IntelligentProvisioningLocation : IntelligentProvisioningVersion : ProcessorJitterControl : PCAPartNumber : 847012-001 PCASerialNumber : PVZBFX4LM6100A PowerOnMinutes : 180361 PostDiscoveryCompleteTimeStamp : PostDiscoveryMode : Auto PostMode : PostToReboot PostState : PowerOff PowerAllocationLimit : 500 PowerAutoOn : PowerOn PowerOnDelay : Minimum PowerRegulatorMode : Dynamic PowerRegulatorModesSupported : {OSControl, Dynamic, Max, Min} ServerFQDN : ServerSignature : ServerSignatureStatus : VirtualProfile : Inactive VirtualUUID : SystemStatus : HPE.iLO.Response.Redfish.Status IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $obj.SystemStatus Health State HealthRollUp ------ ----- ------------ OK Disabled</dev:code> <dev:remarks> <maml:para>This cmdlet gets system information for the iLO 5 server with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$connection is passed via pipeline. PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.50 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOSystemInfo PS C:\> $obj | fl AssetTag : a 234567890123456789012345678901 BiosVersion : I41 v1.30 (12/14/2017) Boot : HPE.iLO.Response.Redfish.ComputerSystemBoot Description : DNSHostName : Id : 1 IndicatorLED : Off Manufacturer : HPE MemorySummary : HPE.iLO.Response.Redfish.Memorysummary Model : ProLiant BL460c Gen10 Name : Computer System PartNumber : PowerState : Off ProcessorSummary : HPE.iLO.Response.Redfish.Processorsummary SKU : BL460cGen10 SerialNumber : 2M270801TB SystemType : Physical TrustedModules : {HPE.iLO.Response.Redfish.Trustedmodule} AggregateHealthStatus : HPE.iLO.Response.Redfish.AggregateHealthStatus Bios : HPE.iLO.Response.Redfish.HpeComputerSystemExtBios CurrentPowerOnTimeSeconds : DeviceDiscoveryComplete : HPE.iLO.Response.Redfish.DeviceDiscoverycomplete EndOfPostDelaySeconds : 90 HostOS : IsColdBooting : IntelligentProvisioningAlwaysOn : IntelligentProvisioningLocation : IntelligentProvisioningVersion : ProcessorJitterControl : PCAPartNumber : 847012-001 PCASerialNumber : PVZBFX4LM6100A PowerOnMinutes : 180361 PostDiscoveryCompleteTimeStamp : PostDiscoveryMode : Auto PostMode : PostToReboot PostState : PowerOff PowerAllocationLimit : 500 PowerAutoOn : PowerOn PowerOnDelay : Minimum PowerRegulatorMode : Dynamic PowerRegulatorModesSupported : {OSControl, Dynamic, Max, Min} ServerFQDN : ServerSignature : ServerSignatureStatus : VirtualProfile : Inactive VirtualUUID : SystemStatus : HPE.iLO.Response.Redfish.Status IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $obj | fl AssetTag : a 234567890123456789012345678901 BiosVersion : I41 v1.30 (12/14/2017) Boot : HPE.iLO.Response.Redfish.ComputerSystemBoot Description : DNSHostName : Id : 1 IndicatorLED : Off Manufacturer : HPE MemorySummary : HPE.iLO.Response.Redfish.Memorysummary Model : ProLiant BL460c Gen10 Name : Computer System PartNumber : PowerState : Off ProcessorSummary : HPE.iLO.Response.Redfish.Processorsummary SKU : BL460cGen10 SerialNumber : 2M270801TB SystemType : Physical TrustedModules : {HPE.iLO.Response.Redfish.Trustedmodule} AggregateHealthStatus : HPE.iLO.Response.Redfish.AggregateHealthStatus Bios : HPE.iLO.Response.Redfish.HpeComputerSystemExtBios CurrentPowerOnTimeSeconds : DeviceDiscoveryComplete : HPE.iLO.Response.Redfish.DeviceDiscoverycomplete EndOfPostDelaySeconds : 90 HostOS : IsColdBooting : IntelligentProvisioningAlwaysOn : IntelligentProvisioningLocation : IntelligentProvisioningVersion : ProcessorJitterControl : PCAPartNumber : 847012-001 PCASerialNumber : PVZBFX4LM6100A PowerOnMinutes : 180361 PostDiscoveryCompleteTimeStamp : PostDiscoveryMode : Auto PostMode : PostToReboot PostState : PowerOff PowerAllocationLimit : 500 PowerAutoOn : PowerOn PowerOnDelay : Minimum PowerRegulatorMode : Dynamic PowerRegulatorModesSupported : {OSControl, Dynamic, Max, Min} ServerFQDN : ServerSignature : ServerSignatureStatus : VirtualProfile : Inactive VirtualUUID : SystemStatus : HPE.iLO.Response.Redfish.Status IP : 10.20.30.50 Hostname : abc.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO 5 connection objects passed as pipeline parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOSystemMaintenanceSwitch</command:name> <maml:description> <maml:para>Gets the system maintenance switch information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOSystemMaintenanceSwitch</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOSystemMaintenanceSwitch gets the system maintenance switch information. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOSystemMaintenanceSwitch</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.SystemMaintenanceSwitch[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOSystemMaintenanceSwitch OverrideiLOSecuritySwitch : On Switch2 : Off Switch3 : Off Switch4 : Off BIOSPasswordDisableSwitch : On Switch6 : Off Switch7 : Off Switch8 : Off Switch9 : Off Switch10 : Off Switch11 : Off Switch12 : Off IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOSystemMaintenanceSwitch -Connection $connection OverrideiLOSecuritySwitch : Off Switch2 : Off Switch3 : Off Switch4 : Off BIOSPasswordDisableSwitch : Off Switch6 : Off Switch7 : Off Switch8 : Off Switch9 : Off Switch10 : Off Switch11 : Off Switch12 : Off IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : OverrideiLOSecuritySwitch : On Switch2 : Off Switch3 : Off Switch4 : Off BIOSPasswordDisableSwitch : On Switch6 : Off Switch7 : Off Switch8 : Off Switch9 : Off Switch10 : Off Switch11 : Off Switch12 : Off IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO 5 connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOTemperature</command:name> <maml:description> <maml:para>Gets the temperature health details of the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOTemperature</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOTemperature cmdlet gets the temperature health details of the server. These details include label, location, status, current reading, caution, and critical temperatures. The details are returned for the list of temperature gauges.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOTemperature</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.RIBCL.TemperatureInfo[] or HPE.iLO.Response.Redfish.TemperatureInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOTemperature PS C:\> $obj | fl Temperature : {Temperature, Temperature, Temperature, Temperature...} IP : 10.20.30.40 Hostname : xyz.example.com Status : OK PS C:\> $obj.Temperature Name : 01-Inlet Ambient Location : Ambient Status : OK CurrentReadingCelsius : 17 SensorNumber : 1 UpperThresholdCritical : 42 UpperThresholdFatal : 46 UpperThresholdNonCritical : LowerThresholdCritical : LowerThresholdFatal : LowerThresholdNonCritical : MaximumValue : MinimumValue : LocationXmm : LocationYmm : LocationZmm : Name : 02-CPU 1 Location : CPU Status : OK CurrentReadingCelsius : 40 SensorNumber : 2 UpperThresholdCritical : 82 UpperThresholdFatal : 83 UpperThresholdNonCritical : LowerThresholdCritical : LowerThresholdFatal : LowerThresholdNonCritical : MaximumValue : MinimumValue : LocationXmm : LocationYmm : LocationZmm :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Get-HPEiLOTemperature -Connection $connection Temperature : {Temperature, Temperature, Temperature, Temperature...} IP : 10.20.30.40 Hostname : xyz.example.com Status : OK Temperature : {Temperature, Temperature, Temperature, Temperature...} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK Temperature : {Temperature, Temperature, Temperature, Temperature...} IP : 10.20.30.42 Hostname : xyz.example.com Status : OK</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOTPMStatus</command:name> <maml:description> <maml:para>Gets the HPE Trusted Platform Module Information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOTPMStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOTPMStatus cmdlet retrieves the HPE Trusted Platform Module Information. The response includes whether a TPM is supported, if a TPM is present, and whether the TPM is enabled, TPM module type, and TPM module version. TPM module type and module version are displayed only if TPM is enabled.This cmdlet can be run against the servers whether or not the TPM is installed.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOTPMStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.TPMStatus[] or HPE.iLO.Response.Redfish.TPMStatus[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOTPMStatus TPMSupported : Yes TPMPresent : No TPMState : Absent TrustedModuleType : TPM 2.0 TrustedModuleVersion : 5.23 IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.41 -Username admin -Password admin123 PS C:\> $o = ,$connection | Get-HPEiLOTPMStatus PS C:\> $o TPMPresent : No TPMState : Absent TrustedModuleType : TPM 2.0 TrustedModuleVersion : 5.23 TPMHealth : IP : 10.20.30.41 Hostname : Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOTPMStatus -Connection $connection TPMSupported : Yes TPMPresent : No TPMState : Absent TrustedModuleType : TPM 2.0 TrustedModuleVersion : 5.23 IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo : TPMPresent : No TPMState : Absent TrustedModuleType : TPM 2.0 TrustedModuleVersion : 5.23 TPMHealth : IP : 10.20.30.41 Hostname : Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOUIDStatus</command:name> <maml:description> <maml:para>Gets the UID Status of the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOUIDStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOUIDStatus cmdlet gets the state of the server UID for the server in which the iLO is operating.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOUIDStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String</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>HPE.iLO.Response.RIBCL.UIDStatus[] or HPE.iLO.Response.Redfish.UIDStatus[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOUIDStatus IndicatorLED : Off IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Get-HPEiLOUIDStatus -Connection $connection IndicatorLED : Off IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo : IndicatorLED : Off IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo : IndicatorLED : Off IP : 10.20.30.42 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with array of connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOUSBDevice</command:name> <maml:description> <maml:para>Gets the USB device detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOUSBDevice</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOUSBDevice cmdlet gets the USB device detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOUSBDevice</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.USBDevice[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $out = ,$connection | Get-HPEiLOUSBDevice PS C:\> $out USBDeviceDetail : {HPE.iLO.Response.Redfish.USBDeviceDetail, HPE.iLO.Response.Redfish.USBDeviceDetail, HPE.iLO.Response.Redfish.USBDeviceDetail} IP : 10.20.30.1 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.USBDeviceDetail Name : USB Device DeviceClass : 9 DeviceCapacityMB : 0 DeviceSubClass : 0 DeviceName : Avocent General Purpose USB Hub DeviceProtocol : 1 Location : Rear USB 1 ProductID : 528 StructuredName : Unknown.Unknown.1.2 UEFIDevicePath : PciRoot(0x0)/Pci(0x14,0x0)/USB(0xD,0x0) VendorID : 8855 Name : USB Device DeviceClass : 3 DeviceCapacityMB : 0 DeviceSubClass : 1 DeviceName : AVOCENT HP AF628A USBFS (PACER-I DeviceProtocol : 1 Location : Rear USB 1 ProductID : 2326 StructuredName : Unknown.Unknown.1.3 UEFIDevicePath : PciRoot(0x0)/Pci(0x14,0x0)/USB(0xD,0x0)/USB(0x0,0x0) VendorID : 1572 Name : USB Device DeviceClass : 3 DeviceCapacityMB : 0 DeviceSubClass : 1 DeviceName : AVOCENT HP AF628A USBFS (PACER-I DeviceProtocol : 2 Location : Rear USB 1 ProductID : 2326 StructuredName : Unknown.Unknown.1.4 UEFIDevicePath : PciRoot(0x0)/Pci(0x14,0x0)/USB(0xD,0x0)/USB(0x0,0x1) VendorID : 1572</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOUSBDevice -Connection $connection USBDeviceDetail : {HPE.iLO.Response.Redfish.USBDeviceDetail, HPE.iLO.Response.Redfish.USBDeviceDetail, HPE.iLO.Response.Redfish.USBDeviceDetail} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : USBDeviceDetail : {HPE.iLO.Response.Redfish.USBDeviceDetail, HPE.iLO.Response.Redfish.USBDeviceDetail, HPE.iLO.Response.Redfish.USBDeviceDetail} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOUser</command:name> <maml:description> <maml:para>Gets the information of all local iLO users.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOUser cmdlet gets the information for all local users, excluding the password. The LoginName parameter can be used to retrieve the information of the corresponding user. In case of iLO 4 servers, you must have the Administator User Accounts privilege to get other user account details. If not, you can only view their individual account information.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="GetUserLogin"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>LoginName is the login name of the user account for which the details have to be retrieved. This parameter is case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="GetUserLogin"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>LoginName is the login name of the user account for which the details have to be retrieved. This parameter is case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>HPE.iLO.Response.RIBCL.User[] or HPE.iLO.Response.Redfish.User[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Get-HPEiLOUser PS C:\> $obj | fl UserInformation : {HPE.iLO.Response.RIBCL.UserDetail, HPE.iLO.Response.RIBCL.UserDetail} IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo : PS C:\> $obj.UserInformation LoginName : Administrator UserName : Administrator RemoteConsolePrivilege : Yes UserConfigPrivilege : Yes VirtualMediaPrivilege : Yes VirtualPowerAndResetPrivilege : Yes iLOConfigPrivilege : Yes LoginName : user UserName : user RemoteConsolePrivilege : No UserConfigPrivilege : Yes VirtualMediaPrivilege : No VirtualPowerAndResetPrivilege : No iLOConfigPrivilege : No LoginName : admin1 UserName : admin1 RemoteConsolePrivilege : Yes UserConfigPrivilege : Yes VirtualMediaPrivilege : Yes VirtualPowerAndResetPrivilege : Yes iLOConfigPrivilege : Yes</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOUser -LoginName admin | fl LoginName : admin UserName : admin RemoteConsolePrivilege : Yes UserConfigPrivilege : Yes VirtualMediaPrivilege : Yes VirtualPowerAndResetPrivilege : Yes iLOConfigPrivilege : Yes IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 when the UserLogin parameter is provided and the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Get-HPEiLOUser -LoginName admin LoginName : admin UserName : admin HostBIOSConfigPrivilege : Yes HostNICConfigPrivilege : No HostStorageConfigPrivilege : Yes ResetServerPrivilege : Yes RemoteConsolePrivilege : Yes SystemRecoveryConfigPrivilege : No UserConfigPrivilege : Yes VirtualMediaPrivilege : No VirtualPowerAndResetPrivilege : Yes iLOConfigPrivilege : Yes ServiceAccount : Yes IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5, with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\>Get-HPEiLOUser -Connection $connection | fl UserInformation : {HPE.iLO.Response.RIBCL.UserDetail, HPE.iLO.Response.RIBCL.UserDetail} IP : 10.20.30.40 Hostname : xyz.example.com Status : OK StatusInfo : UserInformation : {HPE.iLO.Response.RIBCL.UserDetail, HPE.iLO.Response.RIBCL.UserDetail} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo : UserInformation : {HPE.iLO.Response.Redfish.UserDetail, HPE.iLO.Response.Redfish.UserDetail} IP : 10.20.30.42 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOUser</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-HPEiLOUserCertificateMapping</command:name> <maml:description> <maml:para>Gets the User Certificate Mapping detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOUserCertificateMapping</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOUserCertificateMapping cmdlet gets the User Certificate Mapping detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOUserCertificateMapping</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.Redfish.UserCertificateMappingInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOUserCertificateMapping PS C:\> $out UserCertificateMapping : {HPE.iLO.Response.Redfish.UserCertificateMapping, HPE.iLO.Response.Redfish.UserCertificateMapping} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOUserCertificateMapping-Connection $connection UserCertificateMapping : {HPE.iLO.Response.Redfish.UserCertificateMapping, HPE.iLO.Response.Redfish.UserCertificateMapping} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : UserCertificateMapping : {HPE.iLO.Response.Redfish.UserCertificateMapping, HPE.iLO.Response.Redfish.UserCertificateMapping} IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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-HPEiLOVirtualMediaStatus</command:name> <maml:description> <maml:para>Gets the Virtual Media drive status.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEiLOVirtualMediaStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEiLOVirtualMediaStatus cmdlet gets the Virtual Media drive status.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEiLOVirtualMediaStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Device specifies the Virtual Media device target. The possible values are Floppy, CD, USBStick, and DVD. These values are not case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD</command:parameterValue> <command:parameterValue required="false" variableLength="false">Floppy</command:parameterValue> <command:parameterValue required="false" variableLength="false">USBStick</command:parameterValue> <command:parameterValue required="false" variableLength="false">DVD</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Floppy</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Device specifies the Virtual Media device target. The possible values are Floppy, CD, USBStick, and DVD. These values are not case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD</command:parameterValue> <command:parameterValue required="false" variableLength="false">Floppy</command:parameterValue> <command:parameterValue required="false" variableLength="false">USBStick</command:parameterValue> <command:parameterValue required="false" variableLength="false">DVD</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Floppy</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>HPE.iLO.Response.RIBCL.VirtualMediaStatus[] or HPE.iLO.Response.Redfish.VirtualMediaStatus[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOVirtualMediaStatus -Device Floppy Device : {Floppy} ImageInserted : Yes ImageURL : http://ioctrac.chn.hpe.com/trac/raw-attachment/wiki/Poseidon/aj764.iso VMApplet : Disconnected VMBootOption : NoBoot VMWriteProtect : Enabled IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output of the cmdlet in iLO 4 for the device Floppy, when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $out = ,$connection | Get-HPEiLOVirtualMediaStatus PS C:\> $out VirtualMediaInformation : {HPE.iLO.Response.Redfish.VirtualMediaDetail, HPE.iLO.Response.Redfish.VirtualMediaDetail} IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : PS C:\> $out.VirtualMediaInformation ConnectedVia : Disconnected Device : {Floppy, USBStick} ImageInserted : No ImageName : ImageURL : VMWriteProtect : Disabled VMBootOption : ConnectedVia : Disconnected Device : {CD, DVD} ImageInserted : No ImageName : ImageURL : VMWriteProtect : Enabled VMBootOption : NoBoot</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output of the cmdlet in iLO 5, when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Get-HPEiLOVirtualMediStatus -Connection $connection -Device CD | fl Device : {CD} ImageInserted : No ImageURL : VMApplet : Disconnected VMBootOption : NoBoot VMWriteProtect : Disabled IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : ConnectedVia : Disconnected Device : {CD, DVD} ImageInserted : No ImageName : ImageURL : VMWriteProtect : Enabled VMBootOption : NoBoot IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output of iLO 4 and iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Mount-HPEiLOVirtualMedia</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOVirtualMediaStatus</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>Import-HPEiLOCertificate</command:name> <maml:description> <maml:para>Imports a signed certificate into iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Import</command:verb> <command:noun>HPEiLOCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Import-HPEiLOCertificate cmdlet imports a signed certificate into iLO. The signed certificate must be a signed version of a certificate signing request. NOTE : The iLO is reset after the certificate has been imported.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Import-HPEiLOCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Specifies the full certificate including the full header and full footer of the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Specifies the full certificate including the full header and full footer of the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>HPE.iLO.Response.ReturnStatus[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The iLO is reset at the end of a successful cmdlet execution. It is recommended to wait until successful reset, before executing any cmdlet futher.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $cert = @" -----BEGIN CERTIFICATE----- ASampleCertificateAAALftnNE12JR8T8XQqyzqc1tt6FLFRXLRM5PJpOf/IG4hN45 pNdJAhTC8O2505PzkGLf5qhrbDnusclCvoH7DuxyHjeOUVxbC5wFQBcGF4VnpYZ8nGQ Gt9TQ0iUV+NRwn4CR5ESoi63zTJIvKIYZDT2ISeXhF2iU6txjZzdeEm7vQz3slaY3dg AAAIAQ46i6FBzJAYXziF/qmWMt4y6SlylOQDAsxPKk7rpxegv8RlTeon/aeL7ojb9GQ 2xnEN5gobaNZxKz2d4/jwg3+qgTDT6V1G+b7+nEI/XHIc717/7oqgiOv4VE3WxN+HE9 JWsv2jwUpAzRGqJOoojRG/CCru0K+jgTOf/di1o0sw -----END CERTIFICATE----- "@ PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Import-HPEiLOCertificate -Certificate $cert</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output of cmdlet in iLO 4 or iLO 5, when connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $cert = @" -----BEGIN CERTIFICATE----- ASampleCertificateAAALftnNE12JR8T8XQqyzqc1tt6FLFRXLRM5PJpOf/IG4hN45 pNdJAhTC8O2505PzkGLf5qhrbDnusclCvoH7DuxyHjeOUVxbC5wFQBcGF4VnpYZ8nGQ Gt9TQ0iUV+NRwn4CR5ESoi63zTJIvKIYZDT2ISeXhF2iU6txjZzdeEm7vQz3slaY3dg AAAIAQ46i6FBzJAYXziF/qmWMt4y6SlylOQDAsxPKk7rpxegv8RlTeon/aeL7ojb9GQ 2xnEN5gobaNZxKz2d4/jwg3+qgTDT6V1G+b7+nEI/XHIc717/7oqgiOv4VE3WxN+HE9 JWsv2jwUpAzRGqJOoojRG/CCru0K+jgTOf/di1o0sw -----END CERTIFICATE----- "@ PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Import-HPEiLOCertificate -Connection $connection -Certificate $cert</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output of iLO 4 and iLO 5, with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Import-HPEiLOLDAPCACertificate</command:name> <maml:description> <maml:para>Imports LDAP CA certificate into iLO5 server only.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Import</command:verb> <command:noun>HPEiLOLDAPCACertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>During LDAP authentication, iLO validates the directory server certificate if the CA certificate is already imported. For successful certificate validation, make sure that you import the correct CA certificate. If certificate validation fails, iLO login is denied and an event is logged. If no CA certificate is imported, the directory server certificate validation step is skipped.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Import-HPEiLOLDAPCACertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Specifies the full certificate including the full header and full footer of the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this parameter will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Specifies the full certificate including the full header and full footer of the certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this parameter will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $con = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $cert = Get-Content -Path "C:\Users\admin\Downloads\cacertificate.cer" -raw PS C:\> $out = $con | Import-HPEiLOLDAPCACertificate -Certificate $cert</dev:code> <dev:remarks> <maml:para>Trying to import LDAP CA certificate into iLO5 server. Supported only on iLO5.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOLDAPCACertificate</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>Import-HPEiLOUserSSHKey</command:name> <maml:description> <maml:para>Imports an SSH Key and associated username into iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Import</command:verb> <command:noun>HPEiLOUserSSHKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Import-HPEiLOUserSSHKey cmdlet imports a SSH Key and associated username into iLO. This cmdlet is supported only on iLO 4 server.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Import-HPEiLOUserSSHKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSHKey</maml:name> <maml:description> <maml:para>After generating an SSH key using ssh-keygen, puttygen.exe, or another SSH key generating utility to produce a 1024 bit DSA key, and creating the key.pub file, perform the following steps: - Locate the key.pub file and insert the contents between-----BEGIN SSH KEY-----and-----END SSH KEY-----. The file begins with the text: ssh-dss. - At the end of the key, append a space and the name of a valid iLO username as displayed on the Modify User page. For example: xxx_some text_xxx ASmith. The username is case sensitive and must match the case of the iLO username to associate the SSH key with the correct user. Example of SSH Key with the user: -----BEGIN SSH KEY----- ssh-dss ASampleKeyAAALftnNE12JR8T8XQqyzqc1tt6FLFRXLRM5PJpOf/IG4hN45 +x+JbaqkhH+aKqFjlfO1NjszHrFN26H1AhWOjY2bEwj2wlJzBMAhXwnPQelQsCnJDf+ zCzbDn+5Va86+qWxm0lsDEChvZPM6wpjkXvHwuInjxTzOGQTq++vmYlo1/AAAAFQC1M FaZjE995QhX9H1DaDzpsVTXvwAAAIA6ec/hAkas2N762jtlHvSuvZaQRzu49DOtjXVI pNdJAhTC8O2505PzkGLf5qhrbDnusclCvoH7DuxyHjeOUVxbC5wFQBcGF4VnpYZ8nGQ Gt9TQ0iUV+NRwn4CR5ESoi63zTJIvKIYZDT2ISeXhF2iU6txjZzdeEm7vQz3slaY3dg AAAIAQ46i6FBzJAYXziF/qmWMt4y6SlylOQDAsxPKk7rpxegv8RlTeon/aeL7ojb9GQ 2xnEN5gobaNZxKz2d4/jwg3+qgTDT6V1G+b7+nEI/XHIc717/7oqgiOv4VE3WxN+HE9 JWsv2jwUpAzRGqJOoojRG/CCru0K+jgTOf/di1o0sw== ASmith -----END SSH KEY-----</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSHKey</maml:name> <maml:description> <maml:para>After generating an SSH key using ssh-keygen, puttygen.exe, or another SSH key generating utility to produce a 1024 bit DSA key, and creating the key.pub file, perform the following steps: - Locate the key.pub file and insert the contents between-----BEGIN SSH KEY-----and-----END SSH KEY-----. The file begins with the text: ssh-dss. - At the end of the key, append a space and the name of a valid iLO username as displayed on the Modify User page. For example: xxx_some text_xxx ASmith. The username is case sensitive and must match the case of the iLO username to associate the SSH key with the correct user. Example of SSH Key with the user: -----BEGIN SSH KEY----- ssh-dss ASampleKeyAAALftnNE12JR8T8XQqyzqc1tt6FLFRXLRM5PJpOf/IG4hN45 +x+JbaqkhH+aKqFjlfO1NjszHrFN26H1AhWOjY2bEwj2wlJzBMAhXwnPQelQsCnJDf+ zCzbDn+5Va86+qWxm0lsDEChvZPM6wpjkXvHwuInjxTzOGQTq++vmYlo1/AAAAFQC1M FaZjE995QhX9H1DaDzpsVTXvwAAAIA6ec/hAkas2N762jtlHvSuvZaQRzu49DOtjXVI pNdJAhTC8O2505PzkGLf5qhrbDnusclCvoH7DuxyHjeOUVxbC5wFQBcGF4VnpYZ8nGQ Gt9TQ0iUV+NRwn4CR5ESoi63zTJIvKIYZDT2ISeXhF2iU6txjZzdeEm7vQz3slaY3dg AAAIAQ46i6FBzJAYXziF/qmWMt4y6SlylOQDAsxPKk7rpxegv8RlTeon/aeL7ojb9GQ 2xnEN5gobaNZxKz2d4/jwg3+qgTDT6V1G+b7+nEI/XHIc717/7oqgiOv4VE3WxN+HE9 JWsv2jwUpAzRGqJOoojRG/CCru0K+jgTOf/di1o0sw== ASmith -----END SSH KEY-----</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $sshkey = @" -----BEGIN SSH KEY----- ssh-dss SampleKeyAAALftnNE12JR8T8XQqyzqc1tt6FLFRXLRM5PJpOf/IG4hN45 +x+JbaqkhH+aKqFjlfO1NjszHrFN26H1AhWOjY2bEwj2wlJzBMAhXwnPQelQsCnJDf+ zCzbDn+5Va86+qWxm0lsDEChvZPM6wpjkXvHwuInjxTzOGQTq++vmYlo1/AAAAFQC1M AAAIAQ46i6FBzJAYXziF/qmWMt4y6SlylOQDAsxPKk7rpxegv8RlTeon/aeL7ojb9GQ 2xnEN5gobaNZxKz2d4/jwg3+qgTDT6V1G+b7+nEI/XHIc717/7oqgiOv4VE3WxN+HE9 JWsv2jwUpAzRGqJOoojRG/CCru0K+jgTOf/di1o0sw== ASmith -----END SSH KEY----- "@ PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Import-HPEiLOUserSSHKey -SSHKey $sshkey</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output of the cmdlet in iLO 4, when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $sshkey = @" -----BEGIN SSH KEY----- ssh-dss SampleKeyAAALftnNE12JR8T8XQqyzqc1tt6FLFRXLRM5PJpOf/IG4hN45 +x+JbaqkhH+aKqFjlfO1NjszHrFN26H1AhWOjY2bEwj2wlJzBMAhXwnPQelQsCnJDf+ zCzbDn+5Va86+qWxm0lsDEChvZPM6wpjkXvHwuInjxTzOGQTq++vmYlo1/AAAAFQC1M AAAIAQ46i6FBzJAYXziF/qmWMt4y6SlylOQDAsxPKk7rpxegv8RlTeon/aeL7ojb9GQ 2xnEN5gobaNZxKz2d4/jwg3+qgTDT6V1G+b7+nEI/XHIc717/7oqgiOv4VE3WxN+HE9 JWsv2jwUpAzRGqJOoojRG/CCru0K+jgTOf/di1o0sw== ASmith -----END SSH KEY----- "@ PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Import-HPEiLOUserSSHKey -SSHKey $sshkey -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output of iLO 4, with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOUserSSHKey</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>Invoke-HPEiLOFirmwareVerificationScan</command:name> <maml:description> <maml:para>Invokes the firmware verification scan run.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>HPEiLOFirmwareVerificationScan</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-HPEiLOFirmwareVerificationScan cmdlet invokes the firmware verification scan run. The cmdlet is supported only on iLO 5 servers.</maml:para> <maml:para>NOTE : . When a firmware verification scan is in progress, you cannot install firmware updates or upload firmware to the iLO Repository. . Advanced license is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Invoke-HPEiLOFirmwareVerificationScan</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ScanTimeout</maml:name> <maml:description> <maml:para>Time taken to retrieve the scan result in seconds. The supported value is from 10 to 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ScanTimeout</maml:name> <maml:description> <maml:para>Time taken to retrieve the scan result in seconds. The supported value is from 10 to 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.UInt32[]</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>HPE.iLO.Response.Redfish.FirmwareVerificationLastScanResult[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $out = ,$connection | Invoke-HPEiLOFirmwareVerificationScan -ScanTimeout 10 PS C:\> $out ScanTime : 7/10/2017 7:38:17 PM ScanResult : OK FailedImageUri : IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output of cmdlet in iLO 5, when connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> $out = ,$connection | Invoke-HPEiLOFirmwareVerificationScan -ScanTimeout 10 PS C:\> $out ScanTime : 7/10/2017 7:38:17 PM ScanResult : OK FailedImageUri : IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : ScanTime : 7/10/2017 7:38:17 PM ScanResult : OK FailedImageUri : IP : 10.20.30.41 Hostname : xyz.com Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output of iLO 5, with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOFirmwareVerificationLastScanResult</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>Invoke-HPEiLOInstallSet</command:name> <maml:description> <maml:para>Invokes the install set to add on to the installation queue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>HPEiLOInstallSet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-HPEiLOInstallSet cmdlet invokes the install set to add on to the installation queue. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="NonMaintenanceWindowSet"> <!--NAME: NonMaintenanceWindowSet--> <maml:name>Invoke-HPEiLOInstallSet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the install set that needs to be added to the installation queue.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClearTaskQueue</maml:name> <maml:description> <maml:para>Previous items in the task queue can be cleared before the Install Set is invoked. Supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Expire</maml:name> <maml:description> <maml:para>The task expiration date and time. Supported format is yyyy-MM-dd HH:mm:ss. (For example 2018-06-27 19:23:14). Time must be given in 24 hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StartAfter</maml:name> <maml:description> <maml:para>The task start date and time. Supported format is of the form yyyy-MM-dd HH:mm:ss. (For example 2018-06-27 19:23:14). Time must be given in 24 hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TPMOverride</maml:name> <maml:description> <maml:para>If set to Yes, then the TPMOverrideFlag is passed in on the associated flash operations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRecoverySet</maml:name> <maml:description> <maml:para>If set to Yes, then the components in the flash operations are used to replace matching contents in the Recovery Set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="MaintenanceWindowSet"> <!--NAME: MaintenanceWindowSet--> <maml:name>Invoke-HPEiLOInstallSet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the install set that needs to be added to the installation queue.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClearTaskQueue</maml:name> <maml:description> <maml:para>Previous items in the task queue can be cleared before the Install Set is invoked. Supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindow</maml:name> <maml:description> <maml:para>Specifies the name of the maintenance window. It is the configured time period that applies to an installation task.</maml:para> <maml:para>Note: Maintenance Window can be added or modified using the cmdlets Add-HPEiLOMaintenanceWindow and Set-HPEiLOMaintenanceWindow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TPMOverride</maml:name> <maml:description> <maml:para>If set to Yes, then the TPMOverrideFlag is passed in on the associated flash operations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRecoverySet</maml:name> <maml:description> <maml:para>If set to Yes, then the components in the flash operations are used to replace matching contents in the Recovery Set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the install set that needs to be added to the installation queue.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClearTaskQueue</maml:name> <maml:description> <maml:para>Previous items in the task queue can be cleared before the Install Set is invoked. Supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Expire</maml:name> <maml:description> <maml:para>The task expiration date and time. Supported format is yyyy-MM-dd HH:mm:ss. (For example 2018-06-27 19:23:14). Time must be given in 24 hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StartAfter</maml:name> <maml:description> <maml:para>The task start date and time. Supported format is of the form yyyy-MM-dd HH:mm:ss. (For example 2018-06-27 19:23:14). Time must be given in 24 hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TPMOverride</maml:name> <maml:description> <maml:para>If set to Yes, then the TPMOverrideFlag is passed in on the associated flash operations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRecoverySet</maml:name> <maml:description> <maml:para>If set to Yes, then the components in the flash operations are used to replace matching contents in the Recovery Set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindow</maml:name> <maml:description> <maml:para>Specifies the name of the maintenance window. It is the configured time period that applies to an installation task.</maml:para> <maml:para>Note: Maintenance Window can be added or modified using the cmdlets Add-HPEiLOMaintenanceWindow and Set-HPEiLOMaintenanceWindow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>. StartAfter and Expire parameter should be used toegther.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Invoke-HPEiLOInstallSet -Name "System Recovery Set" -ClearTaskQueue Yes -TPMOverride Yes -UpdateRecoverySet Yes -Expire "2018-01-01 02:43:01" -StartAfter "2017-01-01 02:43:01"</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output of cmdlet in iLO 5, when connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Invoke-HPEiLOInstallSet -Connection $connection -Name "System Recovery Set" -ClearTaskQueue Yes -TPMOverride Yes -UpdateRecoverySet Yes -Expire "2018-01-01 02:43:01" -StartAfter "2017-01-01 02:43:01"</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output of iLO 5, with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOMaintenanceWindow</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>Invoke-HPEiLOProfileApply</command:name> <maml:description> <maml:para>Applies a deployment setting profile in iLO 4.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>HPEiLOProfileApply</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>You can script automated server configuration packages (deployment settings) to install multiple servers through iLO using PROFILE scripts. Use the Invoke-HPEiLOProfileApply cmdlet to apply a deployment setting profile in iLO 4. This cmdlet is supported only on iLO 4 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Invoke-HPEiLOProfileApply</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProfileDescriptionName</maml:name> <maml:description> <maml:para>This parameter specifies the descriptive name of the profile. The value must be unique on the server, and be a maximum of 27 characters long. Only alphanumerics and underscores are accepted. Spaces, periods, and slashes are invalid. An empty string is also invalid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>Toggle that controls whether the profile is immediately applied or is staged until the next reboot. Valid values are Stage and ApplyNow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ApplyNow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stage</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProfileDescriptionName</maml:name> <maml:description> <maml:para>This parameter specifies the descriptive name of the profile. The value must be unique on the server, and be a maximum of 27 characters long. Only alphanumerics and underscores are accepted. Spaces, periods, and slashes are invalid. An empty string is also invalid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>Toggle that controls whether the profile is immediately applied or is staged until the next reboot. Valid values are Stage and ApplyNow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ApplyNow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stage</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>If the cmdlet executes successfully, then a return object with StatusType "Warning" is returned.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>WARNING: When the script has successfully completed, the iLO management processor reboots to apply the changes.</maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Invoke-HPEiLOProfileApply -ProfileDescriptionName admin -Action ApplyNow</dev:code> <dev:remarks> <maml:para>This cmdlet shows the usage of cmdlet in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Invoke-HPEiLOProfileApply -Connection $connection -ProfileDescriptionName admin -Action ApplyNow</dev:code> <dev:remarks> <maml:para>This cmdlet shows the usage of cmdlet in which the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOProfileDownload</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOProfileApplyResult</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>Invoke-HPEiLOProfileDownload</command:name> <maml:description> <maml:para>Modifies a Profile Description, downloads a specific blob, and writes the blob in permanent(perm) and temporary(tmp) directory of the blob store.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>HPEiLOProfileDownload</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-HPEiLOProfileDownload cmdlet adds the description to a profile. It also downloads a specific blob to the blob store. A blob store is a region of memory that is accessible by both the iLO and the embedded software environment. Management software can communicate with the embedded environment through the iLO by reading and writing files to the permanent(perm) and temporary(tmp) directory of the blob store. This eliminates the need to communicate through the server's production network interfaces. This cmdlet is supported only on iLO 4 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Invoke-HPEiLOProfileDownload</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProfileDescriptionName</maml:name> <maml:description> <maml:para>This parameter specifies the descriptive name of the profile. The value must be unique on the server and be a maximum of 27 characters long. Only alphanumerics and underscores are accepted. Spaces, periods, and slashes are invalid. An empty string is also invalid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Specifies the name of the profile. This value is optional and accepts free-form text. Empty strings are invalid. The string can be 512 characters long.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProfileDescription</maml:name> <maml:description> <maml:para>Specifies a description of the profile. This value is optional and accepts free-form text. Empty strings are invalid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BLOBNameSpace</maml:name> <maml:description> <maml:para>Specifies an internal iLO storage indicator. Allowed values are Permanent and Temporary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Permanent</command:parameterValue> <command:parameterValue required="false" variableLength="false">Temporary</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BLOBName</maml:name> <maml:description> <maml:para>Specifies the name iLO will use to store the profile internally. This value can be a maximum of 31 characters long. Only alphanumerics and underscores are accepted; spaces, periods, and slashes are invalid. Hewlett Packard Enterprise recommends that you use the same value as ProfileDescriptionName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>URL</maml:name> <maml:description> <maml:para>Specifies the URL from which iLO will attempt to download the profile for local storage if BLOBNamespace and BLOBName are not used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProfileDescriptionName</maml:name> <maml:description> <maml:para>This parameter specifies the descriptive name of the profile. The value must be unique on the server and be a maximum of 27 characters long. Only alphanumerics and underscores are accepted. Spaces, periods, and slashes are invalid. An empty string is also invalid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Specifies the name of the profile. This value is optional and accepts free-form text. Empty strings are invalid. The string can be 512 characters long.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProfileDescription</maml:name> <maml:description> <maml:para>Specifies a description of the profile. This value is optional and accepts free-form text. Empty strings are invalid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BLOBNameSpace</maml:name> <maml:description> <maml:para>Specifies an internal iLO storage indicator. Allowed values are Permanent and Temporary.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Permanent</command:parameterValue> <command:parameterValue required="false" variableLength="false">Temporary</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BLOBName</maml:name> <maml:description> <maml:para>Specifies the name iLO will use to store the profile internally. This value can be a maximum of 31 characters long. Only alphanumerics and underscores are accepted; spaces, periods, and slashes are invalid. Hewlett Packard Enterprise recommends that you use the same value as ProfileDescriptionName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>URL</maml:name> <maml:description> <maml:para>Specifies the URL from which iLO will attempt to download the profile for local storage if BLOBNamespace and BLOBName are not used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Invoke-HPEiLOProfileDownload -ProfileDescriptionName admin123 -ProfileName admin -ProfileDescription basicprofile -BLOBNameSpace Permanent -BLOBName name</dev:code> <dev:remarks> <maml:para>This cmdlet shows the usage of the cmdlet in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\>Invoke-HPEiLOProfileDownload -Connection $connection -ProfileDescriptionName admin123 -ProfileName admin -ProfileDescription basicprofile -BLOBNameSpace Permanent -BLOBName name</dev:code> <dev:remarks> <maml:para>This cmdlet shows the usage of the cmdlet in which the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOProfileApply</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOProfileApplyResult</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>Invoke-HPEiLORepositoryComponent</command:name> <maml:description> <maml:para>Invokes the repository component and adds it to the installation queue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>HPEiLORepositoryComponent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-HPEiLORepositoryComponent cmdlet Invokes the repository component and adds it to the installation queue.This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="MaintenanceWindowSet"> <!--NAME: MaintenanceWindowSet--> <maml:name>Invoke-HPEiLORepositoryComponent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>User defined name of the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para>The unique filename of the component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindow</maml:name> <maml:description> <maml:para>Specifies the name of the maintenance window. It is the configured time period that applies to an installation task.</maml:para> <maml:para>Note: Maintenance Window can be added or modified using the cmdlets Add-HPEiLOMaintenanceWindow and Set-HPEiLOMaintenanceWindow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Command</maml:name> <maml:description> <maml:para>Command to execute. Supported values are "ApplyUpdate", "ResetServer", and "ResetBmc". - ApplyUpdate: Apply an update using the specified component. - ResetBmc: Reset the BMC. - ResetServer: Reset the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ApplyUpdate</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResetServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResetBmc</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRecoverySet</maml:name> <maml:description> <maml:para>If set to Yes, the components in the flash operations are used to replace matching contents in the Recovery Set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatableBy</maml:name> <maml:description> <maml:para>This is an unordered set of permitted updaters that can execute this item. Supported values are: - Bmc: This component may be scheduled for update by iLO. - RuntimeAgent: This component may be scheduled for update by a runtime update agent such as Smart Update Manager or Smart Update Tool. - Uefi: This component may be scheduled for update by UEFI BIOS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TPMOverride</maml:name> <maml:description> <maml:para>If set to true, the TPMOverrideFlag is passed in on the associated flash operations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="NonMaintenanceWindowSet"> <!--NAME: NonMaintenanceWindowSet--> <maml:name>Invoke-HPEiLORepositoryComponent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>User defined name of the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para>The unique filename of the component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Expire</maml:name> <maml:description> <maml:para>The task expiration date and time. Supported format is yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 19:23:14). Time must be given in 24-hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StartAfter</maml:name> <maml:description> <maml:para>The task start date and time. Supported format is yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 19:23:14). Time must be given in 24-hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Command</maml:name> <maml:description> <maml:para>Command to execute. Supported values are "ApplyUpdate", "ResetServer", and "ResetBmc". - ApplyUpdate: Apply an update using the specified component. - ResetBmc: Reset the BMC. - ResetServer: Reset the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ApplyUpdate</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResetServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResetBmc</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRecoverySet</maml:name> <maml:description> <maml:para>If set to Yes, the components in the flash operations are used to replace matching contents in the Recovery Set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatableBy</maml:name> <maml:description> <maml:para>This is an unordered set of permitted updaters that can execute this item. Supported values are: - Bmc: This component may be scheduled for update by iLO. - RuntimeAgent: This component may be scheduled for update by a runtime update agent such as Smart Update Manager or Smart Update Tool. - Uefi: This component may be scheduled for update by UEFI BIOS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TPMOverride</maml:name> <maml:description> <maml:para>If set to true, the TPMOverrideFlag is passed in on the associated flash operations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>User defined name of the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para>The unique filename of the component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaintenanceWindow</maml:name> <maml:description> <maml:para>Specifies the name of the maintenance window. It is the configured time period that applies to an installation task.</maml:para> <maml:para>Note: Maintenance Window can be added or modified using the cmdlets Add-HPEiLOMaintenanceWindow and Set-HPEiLOMaintenanceWindow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Command</maml:name> <maml:description> <maml:para>Command to execute. Supported values are "ApplyUpdate", "ResetServer", and "ResetBmc". - ApplyUpdate: Apply an update using the specified component. - ResetBmc: Reset the BMC. - ResetServer: Reset the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ApplyUpdate</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResetServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResetBmc</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRecoverySet</maml:name> <maml:description> <maml:para>If set to Yes, the components in the flash operations are used to replace matching contents in the Recovery Set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdatableBy</maml:name> <maml:description> <maml:para>This is an unordered set of permitted updaters that can execute this item. Supported values are: - Bmc: This component may be scheduled for update by iLO. - RuntimeAgent: This component may be scheduled for update by a runtime update agent such as Smart Update Manager or Smart Update Tool. - Uefi: This component may be scheduled for update by UEFI BIOS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TPMOverride</maml:name> <maml:description> <maml:para>If set to true, the TPMOverrideFlag is passed in on the associated flash operations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Expire</maml:name> <maml:description> <maml:para>The task expiration date and time. Supported format is yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 19:23:14). Time must be given in 24-hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StartAfter</maml:name> <maml:description> <maml:para>The task start date and time. Supported format is yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 19:23:14). Time must be given in 24-hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>If the example executes successfully, it does not return anything. In case of an error or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Invoke-HPEiLORepositoryComponent -TaskName "abcd" -Filename "ilo5_120_p27.bin" -Command ApplyUpdate -UpdatableBy Bmc -TPMOverride -Expire "2017-03-01 02:43:01" -StartAfter "2017-01-01 02:43:01"</dev:code> <dev:remarks> <maml:para>This example shows the output of the cmdlet in iLO 5, when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Invoke-HPEiLORepositoryComponent -Connection $connection -TaskName "abcd" -Filename "ilo5_120_p27.bin" -Command ApplyUpdate -UpdateRecoverySet No -UpdatableBy Bmc</dev:code> <dev:remarks> <maml:para>This example shows the output of iLO 5, with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOUnlockedRepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEiLO</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>Invoke-HPEiLOSecureSystemErase</command:name> <maml:description> <maml:para>Resets the system BIOS settings and iLO to manufacturing defaults. It also erases the user data on the system.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>HPEiLOSecureSystemErase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-HPEiLOSecureSystemErase cmdlet resets the system BIOS settings and iLO to manufacturing defaults. It also erases the user data in the NAND, TPMs, persistent memory devices, storage controller configurations, RAID settings, as well as the hard drives attached to the system. USB and other removable media is excluded. This cmdlet is supported on iLO 5 servers only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Invoke-HPEiLOSecureSystemErase</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Invoke-HPEiLOSecureSystemErase</dev:code> <dev:remarks> <maml:para>This example shows the output of the cmdlet in iLO 5, when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Invoke-HPEiLOSecureSystemErase -Connection $connection</dev:code> <dev:remarks> <maml:para>This example shows the output of iLO 5, with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSecureSystemEraseStatus</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>Invoke-HPEiLOSNMPTestTrap</command:name> <maml:description> <maml:para>Sends a test SNMP trap to the configured alert destinations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>HPEiLOSNMPTestTrap</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-HPEiLOSNMPTestTrap cmdlet sends a test SNMP trap to the preconfigured alert destinations. The SNMP alert destination of any valid IP address can be set using the existing Set-HPEiLOSNMPAlertDestination.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Invoke-HPEiLOSNMPTestTrap</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>The Invoke-HPEiLOSNMPTestTrap cmdlet sends the trap depending on the Alert Destination established with the Set-HPEiLOSNMPAlertDestination cmdlet. The Invoke-HPEiLOSNMPTestTrap does not take any SNMP-related parameters.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $obj = ,$connection | Invoke-HPEiLOSNMPTestTrap</dev:code> <dev:remarks> <maml:para>This cmdlet shows the usage of the cmdlet in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Invoke-HPEiLOSNMPTestTrap -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Mount-HPEiLOVirtualMedia</command:name> <maml:description> <maml:para>Mounts the specified media image.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Mount</command:verb> <command:noun>HPEiLOVirtualMedia</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Mount-HPEiLOVirtualMedia cmdlet mounts the media image specified in the ImageURL parameter and connects to the Virtual Media specified by the Device parameter. You must purchase the iLO Advanced license to enable this feature. This cmdlet specifies the location of the image to be used and will connect the device to the server. To perform any other operation apart from Connect, use the Set-HPEiLOVirtualMediaStatus. The cmdlet has the following parameters: . ImageURL . Device</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Mount-HPEiLOVirtualMedia</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ImageURL</maml:name> <maml:description> <maml:para>Specifies the URL for the media image. The URL format is as follows: protocol://username:password@hostname:port/filename,cgi-helper. - Protocol is mandatory and must be either http or https. - Username:password is optional. - Hostname is mandatory. - Port is optional. - Filename is mandatory. - Cgi-helper is optional. This enables the virtual floppy to be writable. In addition, the filename field can contain tokens that expand to host-specific strings: - The %m token expands to the MAC address. - The %i token expands to the IP address in dotted-quad form. - The %h token expands to the hostname. For example: http://john:abc123@imgserver.company.com/disk/win98dos.bin,/cgi-bin/hpvfhelp.pl https://imgserver.company.com/disk/boot%m.bin</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Specifies the Virtual Media device target. The possible values are Floppy, CD, USBStick, and DVD.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD</command:parameterValue> <command:parameterValue required="false" variableLength="false">Floppy</command:parameterValue> <command:parameterValue required="false" variableLength="false">USBStick</command:parameterValue> <command:parameterValue required="false" variableLength="false">DVD</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VMWriteProtect</maml:name> <maml:description> <maml:para>Sets the write protect flag value for the Virtual Floppy. The possible values are 'Yes' to enable Virtual Media write protect or 'No' to disable Virtual Media write protect. This parameter is applicable only for the device Floppy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ImageURL</maml:name> <maml:description> <maml:para>Specifies the URL for the media image. The URL format is as follows: protocol://username:password@hostname:port/filename,cgi-helper. - Protocol is mandatory and must be either http or https. - Username:password is optional. - Hostname is mandatory. - Port is optional. - Filename is mandatory. - Cgi-helper is optional. This enables the virtual floppy to be writable. In addition, the filename field can contain tokens that expand to host-specific strings: - The %m token expands to the MAC address. - The %i token expands to the IP address in dotted-quad form. - The %h token expands to the hostname. For example: http://john:abc123@imgserver.company.com/disk/win98dos.bin,/cgi-bin/hpvfhelp.pl https://imgserver.company.com/disk/boot%m.bin</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Specifies the Virtual Media device target. The possible values are Floppy, CD, USBStick, and DVD.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD</command:parameterValue> <command:parameterValue required="false" variableLength="false">Floppy</command:parameterValue> <command:parameterValue required="false" variableLength="false">USBStick</command:parameterValue> <command:parameterValue required="false" variableLength="false">DVD</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VMWriteProtect</maml:name> <maml:description> <maml:para>Sets the write protect flag value for the Virtual Floppy. The possible values are 'Yes' to enable Virtual Media write protect or 'No' to disable Virtual Media write protect. This parameter is applicable only for the device Floppy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>If the example executes successfully, it does not return anything. In case of an error or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Mount-HPEiLOVirtualMedia -Device Floppy -ImageURL http://10.1.2.3:8080/WinPENew.iso</dev:code> <dev:remarks> <maml:para>This example mounts the image in iLO 4, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Mount-HPEiLOVirtualMedia -Device CD -ImageURL http://10.1.2.3:8080/WinPENew.iso</dev:code> <dev:remarks> <maml:para>This example mounts the image in iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Mount-HPEiLOVirtualMedia -Connection $connection -Device CD,USBStick -ImageURL http://10.1.2.3:8080/WinPENew.iso</dev:code> <dev:remarks> <maml:para>This example mounts the image in iLO 4 and iLO 5, with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOVirtualMediaStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOVirtualMediaStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Dismount-HPEiLOVirtualMedia</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Read-HPEiLOSMBIOSRecord</command:name> <maml:description> <maml:para>Reads SMBIOS records data.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Read</command:verb> <command:noun>HPEiLOSMBIOSRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Reads the SMBIOS records from the output of the Get-HPEiLOSMBIOSData cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Read-HPEiLOSMBIOSRecord</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>SMBIOSRecord</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">HostDataInfo[]</command:parameterValue> <dev:type> <maml:name>HostDataInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>SMBIOSRecord</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">HostDataInfo[]</command:parameterValue> <dev:type> <maml:name>HostDataInfo[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.iLO.Response.SMBIOSDataCollection[]</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> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\Windows\system32> $rec = $smbios | Read-HPEiLOSMBIOSRecord PS C:\Windows\system32> $rec[2].SMBIOSRecord | ft Type StructureName Handle Manufacturer ProductName Version SerialNumber UUID WakeupType SKUNumber ---- ------------- ------ ------------ ----------- ------- ------------ ---- ---------- --------- 1 SystemInformation 95 HPE ProLiant BL460c Gen10 123 74736554-0000-3231-3300-000000000000 PowerSwitch Test 2 BaseboardInformation 113 HPE ProLiant BL460c Gen10 3 SystemEnclosureOrChassis 9217 3 SystemEnclosureOrChassis 100 HPE 123 4 ProcessorInformation 73 4 ProcessorInformation 74 7 CacheInformation 70 7 CacheInformation 71 7 CacheInformation 72 8 PortConnectorInformation 6 8 PortConnectorInformation 7 8 PortConnectorInformation 8 8 PortConnectorInformation 9 8 PortConnectorInformation 10 8 PortConnectorInformation 11 9 SystemSlots 128 9 SystemSlots 129 9 SystemSlots 130 9 SystemSlots 131 11 OEMStrings 101 16 PhysicalMemoryArray 12 16 PhysicalMemoryArray 13 17 MemoryDevice 22 UNKNOWN 17 MemoryDevice 23 UNKNOWN 17 MemoryDevice 24 UNKNOWN 17 MemoryDevice 25 UNKNOWN 17 MemoryDevice 26 UNKNOWN 17 MemoryDevice 27 UNKNOWN 17 MemoryDevice 28 UNKNOWN 17 MemoryDevice 29 UNKNOWN 17 MemoryDevice 30 UNKNOWN 17 MemoryDevice 31 UNKNOWN 17 MemoryDevice 32 UNKNOWN 17 MemoryDevice 33 UNKNOWN 17 MemoryDevice 34 UNKNOWN 17 MemoryDevice 35 UNKNOWN 17 MemoryDevice 36 UNKNOWN 17 MemoryDevice 37 UNKNOWN 19 MemoryArrayMappedAddress 20 19 MemoryArrayMappedAddress 21 26 VoltageProbe 256 32 SystemBootInformation 133 38 IPMIDeviceInformation 14 41 OnboardDevicesExtendedInformation 115 41 OnboardDevicesExtendedInformation 116 41 OnboardDevicesExtendedInformation 117 41 OnboardDevicesExtendedInformation 118 41 OnboardDevicesExtendedInformation 119 41 OnboardDevicesExtendedInformation 120 41 OnboardDevicesExtendedInformation 121 41 OnboardDevicesExtendedInformation 122 41 OnboardDevicesExtendedInformation 123 41 OnboardDevicesExtendedInformation 124 41 OnboardDevicesExtendedInformation 125 41 OnboardDevicesExtendedInformation 126 41 OnboardDevicesExtendedInformation 127</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Get-HPEiLOSMBIOSData</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</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>Register-HPEiLORemoteSupportSetting</command:name> <maml:description> <maml:para>Registers a supported server for Insight Online direct connect remote support.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Register</command:verb> <command:noun>HPEiLORemoteSupportSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Register-HPEiLORemoteSupportSetting cmdlet sets the registration of your device to HPE Insight Online Remote Server using a direct connect method. Once the device is registered with Insight Online, the remote server will poll all iLO for any hardware failures and collect information. This cmdlet is used to register ERS and IRS settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet" default="true"> <!--NAME: UsernamePasswordSet--> <!--TAG: DEFAULT--> <maml:name>Register-HPEiLORemoteSupportSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>The Remote Support connect model type. The supported values are CentralConnect and DirectConnect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DirectConnect</command:parameterValue> <command:parameterValue required="false" variableLength="false">CentralConnect</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HPEPassportUserID</maml:name> <maml:description> <maml:para>Specifies the HPE Passport username for all the iLOs or a list of usernames for each iLO in the input iLO list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HPEPassportPassword</maml:name> <maml:description> <maml:para>Specifies the HPE Passport password for all the iLOs or a list of passwords for each iLO in the input iLO list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyServer</maml:name> <maml:description> <maml:para>Specifies the web proxy URL to be configured as the proxy server for connecting to the target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyPort</maml:name> <maml:description> <maml:para>Sets the port for configuring the web proxy URL to connect to the target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyUsername</maml:name> <maml:description> <maml:para>Specifies the web proxy username.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyPassword</maml:name> <maml:description> <maml:para>Specifies the web proxy password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DestinationURL</maml:name> <maml:description> <maml:para>Specifies the hostname or IP of the IRS server</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DestinationPort</maml:name> <maml:description> <maml:para>Specifies the destination port of the IRS server. Values supported are between 1 and 65535.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Register-HPEiLORemoteSupportSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>The Remote Support connect model type. The supported values are CentralConnect and DirectConnect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DirectConnect</command:parameterValue> <command:parameterValue required="false" variableLength="false">CentralConnect</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HPEPassportCredential</maml:name> <maml:description> <maml:para>This object array is based on HPEPassportUserID and HPEPassportPassword to connect with the HPE Insight Online Remote Server. HPEPassportCredential should not be used along with HPEPassportUserID/HPEPassportPassword.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyServer</maml:name> <maml:description> <maml:para>Specifies the web proxy URL to be configured as the proxy server for connecting to the target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyPort</maml:name> <maml:description> <maml:para>Sets the port for configuring the web proxy URL to connect to the target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyCredential</maml:name> <maml:description> <maml:para>This object is based on the username and password used to configure the web proxy settings required for connecting with the HP Insight Online Remote Server. WebProxyCredential should not be used along with WebProxyUsername/WebProxyPassword.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DestinationURL</maml:name> <maml:description> <maml:para>Specifies the hostname or IP of the IRS server</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DestinationPort</maml:name> <maml:description> <maml:para>Specifies the destination port of the IRS server. Values supported are between 1 and 65535.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>The Remote Support connect model type. The supported values are CentralConnect and DirectConnect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DirectConnect</command:parameterValue> <command:parameterValue required="false" variableLength="false">CentralConnect</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HPEPassportUserID</maml:name> <maml:description> <maml:para>Specifies the HPE Passport username for all the iLOs or a list of usernames for each iLO in the input iLO list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HPEPassportPassword</maml:name> <maml:description> <maml:para>Specifies the HPE Passport password for all the iLOs or a list of passwords for each iLO in the input iLO list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyServer</maml:name> <maml:description> <maml:para>Specifies the web proxy URL to be configured as the proxy server for connecting to the target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyPort</maml:name> <maml:description> <maml:para>Sets the port for configuring the web proxy URL to connect to the target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyUsername</maml:name> <maml:description> <maml:para>Specifies the web proxy username.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyPassword</maml:name> <maml:description> <maml:para>Specifies the web proxy password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DestinationURL</maml:name> <maml:description> <maml:para>Specifies the hostname or IP of the IRS server</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DestinationPort</maml:name> <maml:description> <maml:para>Specifies the destination port of the IRS server. Values supported are between 1 and 65535.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HPEPassportCredential</maml:name> <maml:description> <maml:para>This object array is based on HPEPassportUserID and HPEPassportPassword to connect with the HPE Insight Online Remote Server. HPEPassportCredential should not be used along with HPEPassportUserID/HPEPassportPassword.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyCredential</maml:name> <maml:description> <maml:para>This object is based on the username and password used to configure the web proxy settings required for connecting with the HP Insight Online Remote Server. WebProxyCredential should not be used along with WebProxyUsername/WebProxyPassword.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.Management.Automation.PSCredential[] System.Int32[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Register-HPEiLORemoteSupportSetting -InterfaceType DirectConnect -HPEPassportUserID abcd@xyz.com -HPEPassportPassword admin -WebProxyServer 1.1.1.1 -WebProxyPort 2233 -WebProxyUsername admin1 -WebProxyPassword admin123</dev:code> <dev:remarks> <maml:para>This cmdlet sets the ERS direct connect setting on iLO 4 or iLO 5 server with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Register-HPEiLORemoteSupportSetting -InterfaceType CentralConnect -DestinationURL 15.15.15.15 -DestinationPort 2354</dev:code> <dev:remarks> <maml:para>This cmdlet sets the IRS setting on iLO 4 or iLO 5 server with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Register-HPEiLORemoteSupportSetting -Connection $connection -InterfaceType CentralConnect -DestinationURL 15.15.15.15 -DestinationPort 2354</dev:code> <dev:remarks> <maml:para>This cmdlet sets the remote support setting on iLO 4 and iLO 5 servers with an array of connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-HPEiLORemoteSupportSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLORemoteSupportSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLORemoteSupportSetting</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>Remove-HPEiLOCertificateRevocationList</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLOCertificateRevocationList</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLOCertificateRevocationList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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> </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>Remove-HPEiLODirectoryGroup</command:name> <maml:description> <maml:para>Removes an item from iLO directory group list.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLODirectoryGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEiLODirectoryGroup cmdlet removes an existing Directory Group from iLO. This cmdlet is supported on iLO5 servers only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLODirectoryGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>The name of the iLO directory group to be deleted. This name must already exist as a directory group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>The name of the iLO directory group to be deleted. This name must already exist as a directory group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $con = Connect-HPEiLO 192.168.10.10,192.168.10.31 admin admin123 -DisableCertificateAuthentication PS C:\> $rm = $con[0] | Remove-hpeiloDirectoryGroup -GroupName "z1" -verbose PS C:\> $rm = $con[1] | Remove-hpeiloDirectoryGroup -GroupName "z2" -verbose</dev:code> <dev:remarks> <maml:para>First remove directory group cmdlet trying to remove the group name by its name and second cmdlet is trying to remove it by using group name and group SID as they are the required parameters for searching the list of directory groups. Only supported on iLO5.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLODirectoryGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLODirectoryGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLODirectoryGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLODirectorySetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLODirectorySetting</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>Remove-HPEiLOFederationGroup</command:name> <maml:description> <maml:para>Removes the specified iLO from an iLO Federation group membership.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLOFederationGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEiLOFederationGroup command removes the specified iLO from an iLO Federation group membership.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLOFederationGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>The name of the iLO Federation group to be deleted, which must already exist as a membership group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>The name of the iLO Federation group to be deleted, which must already exist as a membership group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> Remove-HPEiLOFederationGroup -Connection $connection -GroupName testgroup</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 4 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Remove-HPEiLOFederationGroup -GroupName testgroup</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Remove-HPEiLOFederationGroup -GroupName testgroup</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOFederationGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOFederationGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOFederationGroup</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>Remove-HPEiLOInstallationTaskQueue</command:name> <maml:description> <maml:para>Removes the component specified from the Installation Task queue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLOInstallationTaskQueue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEiLOInstallationTaskQueue cmdlet removes the component specified from the Installation Task queue. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLOInstallationTaskQueue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>User defined name of the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TaskName</maml:name> <maml:description> <maml:para>User defined name of the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Remove-HPEiLOInstallationTaskQueue -TaskName TestInstallSet</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Remove-HPEiLOInstallationTaskQueue -Connection $connection -TaskName TestInstallSet</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOInstallationTaskQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOInstallationTaskQueue</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>Remove-HPEiLOInstallSet</command:name> <maml:description> <maml:para>Removes the install set.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLOInstallSet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEiLOInstallSet cmdlet removes the install set. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLOInstallSet</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the install set (client supplied upon creation).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the install set (client supplied upon creation).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Remove-HPEiLOInstallSet -Name TestInstallSet</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Remove-HPEiLOInstallSet -Connection $connection -Name TestInstallSet</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOInstallSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOInstallSet</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>Remove-HPEiLOLanguagePack</command:name> <maml:description> <maml:para>Removes the language pack from iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLOLanguagePack</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEiLOLanguagePack cmdlet removes the language pack from iLO. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLOLanguagePack</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para>Specifies one of the languages supported by the management processor. Supported values are ch and ja.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ja</command:parameterValue> <command:parameterValue required="false" variableLength="false">ch</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Language</maml:name> <maml:description> <maml:para>Specifies one of the languages supported by the management processor. Supported values are ch and ja.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ja</command:parameterValue> <command:parameterValue required="false" variableLength="false">ch</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Remove-HPEiLOLanguagePack -Language ja</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Remove-HPEiLOLanguagePack -Connection $connection -Language ja</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 with an array of connection objects passed as named input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOLanguagePack</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>Remove-HPEiLOMaintenanceWindow</command:name> <maml:description> <maml:para>Removes maintenance windows identified by name.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLOMaintenanceWindow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet removes the maintenance window identified by name. A maintenance window is a configured time period that applies to an installation task. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLOMaintenanceWindow</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name representing the Maintenance window entry.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name representing the Maintenance window entry.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$con = Connect-HPEiLO 192.168.10.34 admin admin123 -DisableCertificateAuthentication $con | Remove-HPEiLOMaintenanceWindow -Name Test123</dev:code> <dev:remarks> <maml:para>Test123 is a maintenance window entry name that will be removed after successful execution. Only on iLO 5 server.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOMaintenanceWindow</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>Remove-HPEiLOProfile</command:name> <maml:description> <maml:para>Removes a deployment profile.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLOProfile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEiLOProfile command removes a deployment profile. This cmdlet is supported only on iLO 4 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLOProfile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProfileDescriptionName</maml:name> <maml:description> <maml:para>Specifies the descriptive name of the profile. The value must be unique on the server, and be less than 27 characters long. Only alphanumerics and underscores are accepted; spaces, periods, and slashes are invalid. An empty string is invalid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProfileDescriptionName</maml:name> <maml:description> <maml:para>Specifies the descriptive name of the profile. The value must be unique on the server, and be less than 27 characters long. Only alphanumerics and underscores are accepted; spaces, periods, and slashes are invalid. An empty string is invalid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Remove-HPEiLOProfile -ProfileDescriptionName testgroup</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Remove-HPEiLOProfile -Connection $connection -ProfileDescriptionName testgroup</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 with an array of connection objects passed as named input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOProfileApply</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-HPEiLOProfileDownload</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOProfileApplyResult</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>Remove-HPEiLORepositoryComponent</command:name> <maml:description> <maml:para>Removes the Repository Component.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLORepositoryComponent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEiLORepositoryComponent removes the Repository Component. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLORepositoryComponent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The unique filename of the component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The unique filename of the component.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Remove-HPEiLORepositoryComponent -FileName "ilo5_115.bin"</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Remove-HPEiLORepositoryComponent -Connection $connection -FileName "ilo5_115.bin"</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOUnlockedRepositoryComponent</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>Remove-HPEiLOSNMPAlertDestination</command:name> <maml:description> <maml:para>Removes the SNMP alert destination.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLOSNMPAlertDestination</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEiLOSNMPAlertDestination removes the SNMP Alert destination.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLOSNMPAlertDestination</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>The unique identifier ID for each Alert destination.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>The unique identifier ID for each Alert destination.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.Int32[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Remove-HPEiLOSNMPAlertDestination -ID 2</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Remove-HPEiLOSNMPAlertDestination -Connection $connection -ID 2</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 4 and iLO 5 with an array of connection objects passed as named input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOSNMPAlertDestination</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSNMPAlertDestination</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSNMPAlertDestination</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>Remove-HPEiLOSNMPv3User</command:name> <maml:description> <maml:para>Removes the SNMPv3User.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLOSNMPv3User</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEiLOSNMPv3User removes the SNMPv3User.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLOSNMPv3User</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>The unique identifier ID for each SNMPv3user. The supported values for iLO 5 are 1-8.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>The unique identifier ID for each SNMPv3user. The supported values for iLO 5 are 1-8.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.Int32[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Remove-HPEiLOSNMPv3User -ID 2</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Remove-HPEiLOSNMPv3User -Connection $connection -ID 2</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 4 and iLO 5 with an array of connection objects passed as named input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOSNMPv3User</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSNMPv3User</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSNMPv3User</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>Remove-HPEiLOSSORecord</command:name> <maml:description> <maml:para>Removes an HPE SIM Trusted SSO Server record.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLOSSORecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEiLOSSORecord cmdlet removes an HPE SIM Trusted SSO Server record. You must have Configure iLO Settings privilege to execute This cmdlet. In iLO 5 servers - When This cmdlet is run multiple times on the same iLO, the servers are deleted in the order that the records are specified, and the records are renumbered by each deletion. Delete records in the highest-to-lowest order if you want to delete multiple records at the same time.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLOSSORecord</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Record"> <maml:name>Index</maml:name> <maml:description> <maml:para>Indicates the record number to delete. This number is consistent with the index returned using a Get-HPEiLOSSOSetting command.</maml:para> <maml:para>Alias : Record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Record"> <maml:name>Index</maml:name> <maml:description> <maml:para>Indicates the record number to delete. This number is consistent with the index returned using a Get-HPEiLOSSOSetting command.</maml:para> <maml:para>Alias : Record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.Int32[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Remove-HPEiLOSSORecord -Index 1</dev:code> <dev:remarks> <maml:para>This cmdlet deletes the SSO record present in index 1 of iLO 4 or iLO 5, when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>C:\PS> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Remove-HPEiLOSSORecord -Connection $connection -Index 2</dev:code> <dev:remarks> <maml:para>This cmdlet deletes the SSO record present in index 2 of iLO 4 and iLO 5, when an array of connection objects is passed named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOSSORecord</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSSOSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOSSOSetting</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>Remove-HPEiLOUser</command:name> <maml:description> <maml:para>Removes an existing local user account.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLOUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEiLOUser cmdlet removes an existing local user account. The LoginName parameter must exist in the current user database. The user must have the Administator User Accounts privilege to remove the user.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLOUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoveUserLogin"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>Specifies login name of the user account to be removed. This parameter is case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoveUserLogin"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>Specifies login name of the user account to be removed. This parameter is case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Remove-HPEiLOUser -LoginName testuser1</dev:code> <dev:remarks> <maml:para>This cmdlet removes the user given in LoginName from iLO user accounts of iLO 4 or iLO 5, when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Remove-HPEiLOUser -Connection $connection -LoginName testuser1</dev:code> <dev:remarks> <maml:para>This cmdlet removes the user given in LoginName from iLO user accounts of iLO 4 and iLO 5, when array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOUser</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>Remove-HPEiLOUserCertificateMapping</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLOUserCertificateMapping</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLOUserCertificateMapping</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserLogin</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserLogin</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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> </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>Remove-HPEiLOUserSSHKey</command:name> <maml:description> <maml:para>Removes any SSH keys associated with a particular UserLogin.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEiLOUserSSHKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEiLOUserSSHKey cmdlet removes any SSH keys associated with a particular UserLogin. Admin privilege is required to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEiLOUserSSHKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserLoginToEdit</maml:name> <maml:description> <maml:para>Specifies the UserLogin for which the SSH keys are to be deleted. The value must not be blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserLoginToEdit</maml:name> <maml:description> <maml:para>Specifies the UserLogin for which the SSH keys are to be deleted. The value must not be blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Remove-HPEiLOUserSSHKey -UserLoginToEdit testuser1</dev:code> <dev:remarks> <maml:para>This cmdlet removes the SSHkey for user given in UserLoginToEdit from iLO user accounts of iLO 4 when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Remove-HPEiLOUserSSHKey -Connection $connection -UserLogintoEdit testuser1</dev:code> <dev:remarks> <maml:para>This cmdlet removes the user SSHKey given in UserLogintoEdit from iLO user accounts of iLO 4 when an array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-HPEiLOUserSSHKey</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>Reset-HPEiLO</command:name> <maml:description> <maml:para>Resets the iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>HPEiLO</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Reset-HPEiLO cmdlet resets (reboots) the iLO or the host. You must have the Configure iLO settings privilege to execute the command. All active connections (including Remote Console and Virtual Media sessions) to the Lights-Out device will be dropped immediately when this script executes.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Reset-HPEiLO</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Specifies the device that needs to be reset. The possible values are : . iLO - iLO reset . Server - Server reset . Both - Resets both iLO and Server (Supported only on Gen10 servers)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">iLO</command:parameterValue> <command:parameterValue required="false" variableLength="false">Server</command:parameterValue> <command:parameterValue required="false" variableLength="false">Both</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ResetType</maml:name> <maml:description> <maml:para>Specifies the iLO Reset Type. This parameter is supported only on iLO 5 and the Device must be iLO. The possible values are : . ForceRestart - Perform a reset of the management processor firmware. . GracefulRestart - Perform a graceful shutdown followed by a restart of the system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ForceRestart</command:parameterValue> <command:parameterValue required="false" variableLength="false">GracefulRestart</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Specifies the device that needs to be reset. The possible values are : . iLO - iLO reset . Server - Server reset . Both - Resets both iLO and Server (Supported only on Gen10 servers)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">iLO</command:parameterValue> <command:parameterValue required="false" variableLength="false">Server</command:parameterValue> <command:parameterValue required="false" variableLength="false">Both</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ResetType</maml:name> <maml:description> <maml:para>Specifies the iLO Reset Type. This parameter is supported only on iLO 5 and the Device must be iLO. The possible values are : . ForceRestart - Perform a reset of the management processor firmware. . GracefulRestart - Perform a graceful shutdown followed by a restart of the system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ForceRestart</command:parameterValue> <command:parameterValue required="false" variableLength="false">GracefulRestart</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>. In case of iLO 5 servers, the connection will be lost post the iLO reset. . In case of iLO 5 servers, when the server power is On and the -Device parameter is executed with value Both, the system has to be powered off to perform this operation. AutoPowerOn must be set to achieve a power restore. . The iLO/Server is reset at the end of a successful cmdlet execution. It is recommended to wait until successful reset before executing any cmdlet further.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\ > Reset-HPEiLO -Connection $connection -Device iLO</dev:code> <dev:remarks> <maml:para>This cmdlet resets the iLO in iLO 4 or iLO 5, when the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\ > ,$connection | Reset-HPEiLO -Device Server</dev:code> <dev:remarks> <maml:para>This cmdlet resets the Server of iLO 4 or iLO 5, when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\ > ,$connection | Reset-HPEiLO -Device Both</dev:code> <dev:remarks> <maml:para>This cmdlet resets the Server and iLO of iLO 5 machine, when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\ > $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\ > Reset-HPEiLO -Connection $connection -Device iLO</dev:code> <dev:remarks> <maml:para>This cmdlet resets the iLO of the iLO 4 and iLO 5, when an array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 5</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\ > $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\ > Reset-HPEiLO -Connection $connection -Device iLO -ResetType GracefulRestart</dev:code> <dev:remarks> <maml:para>This cmdlet resets the iLO in iLO 5, when the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Reset-HPEiLOSecureBootKey</command:name> <maml:description> <maml:para>Resets the SecureBootKey value.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>HPEiLOSecureBootKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Reset-HPEiLOSecureBootKey cmdlet resets the SecureBootKey value. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Reset-HPEiLOSecureBootKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ResetType</maml:name> <maml:description> <maml:para>This parameter specifies what type of reset action to perform. Supported values are ResetAllKeysToDefault, DeleteAllKeys, and ResetAllKeysToDefault.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ResetAllKeysToDefault</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeleteAllKeys</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeletePK</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ResetType</maml:name> <maml:description> <maml:para>This parameter specifies what type of reset action to perform. Supported values are ResetAllKeysToDefault, DeleteAllKeys, and ResetAllKeysToDefault.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ResetAllKeysToDefault</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeleteAllKeys</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeletePK</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $connection | Reset-HPEiLOSecureBootKey -ResetType DeleteAllKeys</dev:code> <dev:remarks> <maml:para>This cmdlet resets the SecureBootKey in iLO 5, when the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\ > Reset-HPEiLOSecureBootKey -Connection $connection -ResetType DeletePK</dev:code> <dev:remarks> <maml:para>This cmdlet resets the Secure boot key in iLO 5, when array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Reset-HPEiLOSystemDefault</command:name> <maml:description> <maml:para>Resets all BIOS configuration settings to their default values.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>HPEiLOSystemDefault</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The cmdlet Reset-HPEiLOSystemDefault resets all BIOS configuration settings to their default values. This is supported only on iLO5 Gen10 Plus systems.</maml:para> <maml:para>Selecting this option resets all platform settings except:</maml:para> <maml:para>1. Secure boot BIOS settings 2. Date and time settings 3. Primary and redundant ROM selection (if supported) 4. Other entities, such as option cards or iLO, that must be individually reset. 5. When you use this feature, the iLO IP address and iLO settings stored in the nonvolatile memory are retained.</maml:para> <maml:para>The server must be powered off to enable this feature.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Reset-HPEiLOSystemDefault</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Reset-HPEiLOSystemDefault</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 Gen10 plus system with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Reset-HPEiLOSystemDefault -Connection $connection</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 with an array of connection objects passed as named input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Reset-HPEiLOSystemManufacturingDefault</command:name> <maml:description> <maml:para>Resets all BIOS configuration settings to default manufacturing values.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>HPEiLOSystemManufacturingDefault</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Reset-HPEiLOSystemManufacturingSetting cmdlet resets all BIOS configuration settings to their default manufacturing values and deletes all UEFI non-volatile variables. Such as boot configuration and Secure Boot security keys (if Secure Boot is enabled). Any changes made earlier are lost. A restart of the server is required to make this effective in BIOS configuration. This is supported only on iLO5 Gen10 Plus systems.</maml:para> <maml:para>The server must be powered off to enable this feature.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Reset-HPEiLOSystemManufacturingDefault</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Reset-HPEiLOSystemManufacturingDefault</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 Gen10 plus system with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Reset-HPEiLOSystemManufacturingDefault -Connection $connection</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 with an array of connection objects passed as named input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Restore-HPEiLOSetting</command:name> <maml:description> <maml:para>Restores the iLO setting from .bak file.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Restore</command:verb> <command:noun>HPEiLOSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Restore-HPEiLOSetting cmdlet restores the iLO setting from .bak file. This cmdlet is supported on iLO 5 servers only. The iLO configuration includes many categories such as power, network, security, the User Database, and license keys. Most of the configuration information is stored in the battery-powered SRAM memory device, and it can be backed up and restored. WARNING: All active connections are lost, post successful execution of the cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="LocalLocation" default="true"> <!--NAME: LocalLocation--> <!--TAG: DEFAULT--> <maml:name>Restore-HPEiLOSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>BackupFileLocation</maml:name> <maml:description> <maml:para>The file location of backup file which will be uploaded to the iLO. The supported file extension is .bak. For example - C:\Users\admin\testBackupFile.bak</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BackupFilePassword</maml:name> <maml:description> <maml:para>BackupFilePassword to be provided if the backup file was created with a backupfilePassword. BackupFilePassword cannot be null or empty string. Restoring the .bak file that is password protected will result in exception if the password is not supplied.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UploadTimeout</maml:name> <maml:description> <maml:para>The timeout value for uploading the firmware file. The default timeout value is 180 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>180</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="NANDLocation"> <!--NAME: NANDLocation--> <maml:name>Restore-HPEiLOSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RestoreFromNAND</maml:name> <maml:description> <maml:para>This parameter restores the iLO settings from NAND.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>BackupFileLocation</maml:name> <maml:description> <maml:para>The file location of backup file which will be uploaded to the iLO. The supported file extension is .bak. For example - C:\Users\admin\testBackupFile.bak</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BackupFilePassword</maml:name> <maml:description> <maml:para>BackupFilePassword to be provided if the backup file was created with a backupfilePassword. BackupFilePassword cannot be null or empty string. Restoring the .bak file that is password protected will result in exception if the password is not supplied.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UploadTimeout</maml:name> <maml:description> <maml:para>The timeout value for uploading the firmware file. The default timeout value is 180 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>180</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RestoreFromNAND</maml:name> <maml:description> <maml:para>This parameter restores the iLO settings from NAND.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.UInt32[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>. When you configure the FIPS and CNSA security states, iLO is reset to the factory default settings. If you do not configure these security states before performing a restore, the restored information is deleted when you update the security state.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Restore-HPEiLOSetting -BackupFileLocation C:\Users\admin\test.bak -BackupFilePassword admin123 -UploadTimeout 100</dev:code> <dev:remarks> <maml:para>This cmdlet restores the iLO setting in iLO 5, when the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Restore-HPEiLOSetting -RestoreFromNAND</dev:code> <dev:remarks> <maml:para>This cmdlet restores the iLO setting in iLO 5, when the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Restore-HPEiLOSetting -Connection $connection -BackupFileLocation C:\Users\admin\test.bak -BackupFilePassword admin123</dev:code> <dev:remarks> <maml:para>This cmdlet restores the iLO setting in iLO 5, when array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Backup-HPEiLOSetting</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>Save-HPEiLOAHSLog</command:name> <maml:description> <maml:para>Saves the AHS log.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Save</command:verb> <command:noun>HPEiLOAHSLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Saves the AHS log into the specified local path. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="DurationSet"> <!--NAME: DurationSet--> <maml:name>Save-HPEiLOAHSLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>FileLocation</maml:name> <maml:description> <maml:para>The directory location where AHS log file gets created. The file name of the format <HPE_ServerSerialNumber_Date> gets created in the specified directory location. The input must be an absolute path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Duration</maml:name> <maml:description> <maml:para>Specifies whether the entire log or recent log entries (7 days) has to be downloaded. Accepted values are "All" and "LastWeek".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastWeek</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CaseNumber</maml:name> <maml:description> <maml:para>Specifies the case number that gets inserted in the AHS log header. Accepts up to 14 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CompanyName</maml:name> <maml:description> <maml:para>Specifies the company name that gets inserted in the AHS log header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ContactName</maml:name> <maml:description> <maml:para>Specifies the contact person name that gets inserted in the AHS log header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>Specifies the email id of the contact person that gets inserted in the AHS log header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PhoneNumber</maml:name> <maml:description> <maml:para>Specifies the phone number of the contact person that gets inserted in the AHS log header. Accepts up to 39 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="DaysSet"> <!--NAME: DaysSet--> <maml:name>Save-HPEiLOAHSLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>FileLocation</maml:name> <maml:description> <maml:para>The directory location where AHS log file gets created. The file name of the format <HPE_ServerSerialNumber_Date> gets created in the specified directory location. The input must be an absolute path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CaseNumber</maml:name> <maml:description> <maml:para>Specifies the case number that gets inserted in the AHS log header. Accepts up to 14 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CompanyName</maml:name> <maml:description> <maml:para>Specifies the company name that gets inserted in the AHS log header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ContactName</maml:name> <maml:description> <maml:para>Specifies the contact person name that gets inserted in the AHS log header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Days</maml:name> <maml:description> <maml:para>This parameter when given downloads the most recent N days of the AHS log.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>Specifies the email id of the contact person that gets inserted in the AHS log header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PhoneNumber</maml:name> <maml:description> <maml:para>Specifies the phone number of the contact person that gets inserted in the AHS log header. Accepts up to 39 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="FromToSet"> <!--NAME: FromToSet--> <maml:name>Save-HPEiLOAHSLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>FileLocation</maml:name> <maml:description> <maml:para>The directory location where AHS log file gets created. The file name of the format <HPE_ServerSerialNumber_Date> gets created in the specified directory location. The input must be an absolute path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CaseNumber</maml:name> <maml:description> <maml:para>Specifies the case number that gets inserted in the AHS log header. Accepts up to 14 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CompanyName</maml:name> <maml:description> <maml:para>Specifies the company name that gets inserted in the AHS log header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ContactName</maml:name> <maml:description> <maml:para>Specifies the contact person name that gets inserted in the AHS log header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>Specifies the email id of the contact person that gets inserted in the AHS log header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FromDate</maml:name> <maml:description> <maml:para>This parameter must be given along with 'ToDate' to limit the range of log data returned. Supported format is of the form yyyy-MM-dd. (For example, 2018-06-27)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ToDate</maml:name> <maml:description> <maml:para>This parameter must be given along with 'FromDate' to limit the range of log data returned. Supported format is of the form yyyy-MM-dd. (For example, 2018-06-27)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PhoneNumber</maml:name> <maml:description> <maml:para>Specifies the phone number of the contact person that gets inserted in the AHS log header. Accepts up to 39 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>FileLocation</maml:name> <maml:description> <maml:para>The directory location where AHS log file gets created. The file name of the format <HPE_ServerSerialNumber_Date> gets created in the specified directory location. The input must be an absolute path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Duration</maml:name> <maml:description> <maml:para>Specifies whether the entire log or recent log entries (7 days) has to be downloaded. Accepted values are "All" and "LastWeek".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastWeek</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CaseNumber</maml:name> <maml:description> <maml:para>Specifies the case number that gets inserted in the AHS log header. Accepts up to 14 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CompanyName</maml:name> <maml:description> <maml:para>Specifies the company name that gets inserted in the AHS log header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ContactName</maml:name> <maml:description> <maml:para>Specifies the contact person name that gets inserted in the AHS log header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>Specifies the email id of the contact person that gets inserted in the AHS log header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PhoneNumber</maml:name> <maml:description> <maml:para>Specifies the phone number of the contact person that gets inserted in the AHS log header. Accepts up to 39 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Days</maml:name> <maml:description> <maml:para>This parameter when given downloads the most recent N days of the AHS log.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FromDate</maml:name> <maml:description> <maml:para>This parameter must be given along with 'ToDate' to limit the range of log data returned. Supported format is of the form yyyy-MM-dd. (For example, 2018-06-27)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ToDate</maml:name> <maml:description> <maml:para>This parameter must be given along with 'FromDate' to limit the range of log data returned. Supported format is of the form yyyy-MM-dd. (For example, 2018-06-27)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.UInt32[] System.DateTime[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $connection | Save-HPEiLOAHSLog -FileLocation C:\AHSLog -Duration LastWeek PS C:\></dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 server when connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $connection | Save-HPEiLOAHSLog -FileLocation C:\AHSLog -Days 20 -CompanyName $companyName -ContactName $contactName -Email $email -PhoneNumber $phone PS C:\></dev:code> <dev:remarks> <maml:para>This example shows the output on iLO 5 server, when connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Save-HPEiLOAHSLog -Connection $connection -FileLocation C:\AHSLog -Duration LastWeek PS C:\></dev:code> <dev:remarks> <maml:para>This example shows the output on multiple iLO 5 server, when connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOAHSStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOAHSStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOAHSData</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>Send-HPEiLORemoteSupportAHSSubmission</command:name> <maml:description> <maml:para>Initiates Active Health System data submission to the Insight Remote Support server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Send</command:verb> <command:noun>HPEiLORemoteSupportAHSSubmission</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Send-HPEiLORemoteSupportAHSSubmission cmdlet initiates Active Health System data submission to the Insight Remote Support server. This cmdlet is used to initiate AHS data submission in ERS and IRS server.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Send-HPEiLORemoteSupportAHSSubmission</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MessageID</maml:name> <maml:description> <maml:para>A unique message identifier in UUID format used to match the test Service Event with this request. It is returned in the submission package SOAP envelope header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Days</maml:name> <maml:description> <maml:para>The number of days to include in the transmission, up to a maximum of the last seven days not including the present day. Possible values are 1 to 7.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MessageID</maml:name> <maml:description> <maml:para>A unique message identifier in UUID format used to match the test Service Event with this request. It is returned in the submission package SOAP envelope header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Days</maml:name> <maml:description> <maml:para>The number of days to include in the transmission, up to a maximum of the last seven days not including the present day. Possible values are 1 to 7.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.Int32[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Send-HPEiLORemoteSupportAHSSubmission -MessageID kdfpf-le23l-sdop3-ip23dh-aw2fo -Days 5</dev:code> <dev:remarks> <maml:para>This cmdlet sends the AHS log on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Send-HPEiLORemoteSupportAHSSubmission -Connection $connection -MessageID kdfpf-le23l-sdop3-ip23dh-aw2fo -Days 5</dev:code> <dev:remarks> <maml:para>This cmdlet sends the AHS log on iLO 4 and iLO 5 servers with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Send-HPEiLORemoteSupportDataCollectionInfo</command:name> <maml:description> <maml:para>Initiates a data collection submission to the Insight Remote Support server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Send</command:verb> <command:noun>HPEiLORemoteSupportDataCollectionInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Send-HPEiLORemoteSupportDataCollectionInfo initiates a data collection submission to the Insight Remote Support server. This cmdlet is used to send ERS and IRS Data Collection.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Send-HPEiLORemoteSupportDataCollectionInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MessageID</maml:name> <maml:description> <maml:para>A unique message identifier in UUID format used to match the test Service Event with this request. It is returned in the submission package SOAP envelope header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Days</maml:name> <maml:description> <maml:para>The number of days to include in the transmission, up to a maximum of the last seven days not including the present day. Possible values are 1 to 7.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MessageID</maml:name> <maml:description> <maml:para>A unique message identifier in UUID format used to match the test Service Event with this request. It is returned in the submission package SOAP envelope header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Days</maml:name> <maml:description> <maml:para>The number of days to include in the transmission, up to a maximum of the last seven days not including the present day. Possible values are 1 to 7.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Send-HPEiLORemoteSupportDataCollectionInfo -MessageID kdfpf-le23l-sdop3-ip23dh-aw2fo -Days 10</dev:code> <dev:remarks> <maml:para>This cmdlet sends the data collection on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Send-HPEiLORemoteSupportDataCollectionInfo -Connection $connection -MessageID kdfpf-le23l-sdop3-ip23dh-aw2fo</dev:code> <dev:remarks> <maml:para>This cmdlet sends the data collection on iLO 4 and iLO 5 servers with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Send-HPEiLORemoteSupportTestEvent</command:name> <maml:description> <maml:para>Initiates a test service event submission to the Insight Remote Support server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Send</command:verb> <command:noun>HPEiLORemoteSupportTestEvent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Send-HPEiLORemoteSupportTestEvent cmdlet initiates a test service event submission to the Insight Remote Support server. This cmdlet is used to test ERS and IRS event.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Send-HPEiLORemoteSupportTestEvent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MessageID</maml:name> <maml:description> <maml:para>A unique message identifier in UUID format used to match the test Service Event with this request. It is returned in the submission package SOAP envelope header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MessageID</maml:name> <maml:description> <maml:para>A unique message identifier in UUID format used to match the test Service Event with this request. It is returned in the submission package SOAP envelope header.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Send-HPEiLORemoteSupportTestEvent -MessageID kdfpf-le23l-sdop3-ip23dh-aw2fo -Days 5</dev:code> <dev:remarks> <maml:para>This cmdlet sends the test event on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Send-HPEiLORemoteSupportTestEvent -Connection $connection -MessageID kdfpf-le23l-sdop3-ip23dh-aw2fo</dev:code> <dev:remarks> <maml:para>This cmdlet sends the test event on iLO 4 and iLO 5 servers with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Send-HPEiLORemoteSyslog</command:name> <maml:description> <maml:para>Sends TestSyslog to configured Remote Syslog email address.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Send</command:verb> <command:noun>HPEiLORemoteSyslog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Send-HPEiLORemoteSyslog cmdlet sends TestSyslog to the configured Remote Syslog email address. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Send-HPEiLORemoteSyslog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Send-HPEiLORemoteSyslog</dev:code> <dev:remarks> <maml:para>This cmdlet sends the testsyslog on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Send-HPEiLORemoteSyslog -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet sends the testsyslog on iLO 5 servers with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLORemoteSyslog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLORemoteSyslog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Send-HPEiLOSystemRecoveryEvent</command:name> <maml:description> <maml:para>Generates a recovery event that triggers a separate management tool to initiate a full system recovery.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Send</command:verb> <command:noun>HPEiLOSystemRecoveryEvent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Send-HPEiLOSystemRecoveryEvent cmdlet generates a recovery event that triggers a separate management tool to initiate a full system recovery. Recovery involves installation of the System Recovery Set followed by reimaging the server operating system. This cmdlet is supported in iLO 5 servers.</maml:para> <maml:para>CAUTION: Reimaging a server might cause the loss of existing data.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Send-HPEiLOSystemRecoveryEvent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>. Configure iLO Settings privilege . Virtual Media privilege . A license that supports this feature is installed. For information about the available license types and the features they support, see the licensing documentation at the following website: http://www.hpe.com/support/ilo-docs. . A System Recovery Set exists in the iLO Repository. . A supported management tool (such as iLO Amplifier Pack 1.15 or later) is configured to manage the server.</maml:para> <maml:para>After the execution of cmdlet the recovery event is sent to the management tool that is configured to listen for recovery events.</maml:para> <maml:para>If the event was sent successfully, the following informational event is logged in the IML(Get-HPEiLOIML): Firmware recovery is requested by Administrator.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $connection | Send-HPEiLORecoveryEvent</dev:code> <dev:remarks> <maml:para>This cmdlet sends recovery event in iLO 5, when the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\ > Send-HPEiLORecoveryEvent -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet sends recovery event in iLO 5, when array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOIML</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>Send-HPEiLOTestAlertMail</command:name> <maml:description> <maml:para>Sends the test alert mail to the configured mail address.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Send</command:verb> <command:noun>HPEiLOTestAlertMail</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Send-HPEiLOTestAlertMail cmdlet sends the test alert mail to the configured mail address. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Send-HPEiLOTestAlertMail</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $connection | Send-HPEiLOTestAlertMail</dev:code> <dev:remarks> <maml:para>This cmdlet sends the test alert mail in iLO 5, when the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Send-HPEiLOTestAlertMail -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet sends the alert mail in iLO 5, when an array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Set-HPEiLOAccessSetting</command:name> <maml:description> <maml:para>Modifies access settings of the host server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOAccessSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOAccessSetting cmdlet modifies global settings. You must have the Configure iLO Settings privilege to execute this cmdlet. In the case of iLO 4, the iLO device (not the server) resets automatically to make changes to the port settings effective. In the case of iLO 5 servers, you must reset the iLO to apply the changes.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOAccessSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SessionTimeoutMinutes</maml:name> <maml:description> <maml:para>Determines the maximum session timeout value in minutes. The accepted values are 0, 15, 30, 60, and 120. A value of 0 specifies infinite timeout.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">0</command:parameterValue> <command:parameterValue required="false" variableLength="false">15</command:parameterValue> <command:parameterValue required="false" variableLength="false">30</command:parameterValue> <command:parameterValue required="false" variableLength="false">60</command:parameterValue> <command:parameterValue required="false" variableLength="false">120</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLORBSUEnabled</maml:name> <maml:description> <maml:para>Determines if the F8 prompt for a ROM-based configuration appears during POST. The possible values are Yes to enable the F8 prompt to appear during POST and No to disable the F8 prompt during POST.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HTTPPort</maml:name> <maml:description> <maml:para>Specifies the HTTP port number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HTTPProtocolEnabled</maml:name> <maml:description> <maml:para>Indicates whether HTTP is enabled for the manager. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HTTPSPort</maml:name> <maml:description> <maml:para>Specifies the HTTPS (SSL) port number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HTTPSProtocolEnabled</maml:name> <maml:description> <maml:para>Indicates whether HTTPS is enabled for the manager. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="KVMIPPort"> <maml:name>RemoteConsolePort</maml:name> <maml:description> <maml:para>Specifies the port used for remote console.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteConsoleProtocolEnabled</maml:name> <maml:description> <maml:para>Indicates whether RemoteConsole is enabled for the manager. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteConsoleThumbnailEnabled</maml:name> <maml:description> <maml:para>This property enables or disables the accessibility of remote console thumbnail image in iLO. Disabling this property will not disable remote console feature. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RequireHostAuthentication</maml:name> <maml:description> <maml:para>Determines whether authentication is required for host-based utilities which use CHIF (typically use of CHIF requires Administrator/root credentials). The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FederationEnabled</maml:name> <maml:description> <maml:para>Indicates whether Federation is enabled for the manager. The possible values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MinimumPasswordLength</maml:name> <maml:description> <maml:para>Specifies how many characters are required in all user passwords. The value can be from 8 to 39 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPort</maml:name> <maml:description> <maml:para>Specifies the port used for virtual media.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>XMLReplyEnabled</maml:name> <maml:description> <maml:para>Determines whether management processor responds to anonymous XML discovery requests. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RequiredLoginForiLORBSU</maml:name> <maml:description> <maml:para>Determines if login credentials are required to access the RBSU for iLO. The possible values are Yes if login credentials are needed and No if login credentials are not needed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSHPort</maml:name> <maml:description> <maml:para>Specifies the port used for SSH connection. The processor must be reset if this value is changed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSHProtocolEnabled</maml:name> <maml:description> <maml:para>Determines if SSH is enabled. The valid values are Yes to enable the SSH functionality and No to disable the SSH functionality.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SerialCLIStatus</maml:name> <maml:description> <maml:para>Specifies the status of the CLI. The possible values include Disabled, Enabled-NoAuthenticationRequired, and Enabled-AuthenticationRequired.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled-NoAuthenticationRequired</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled-AuthenticationRequired</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SerialCLISpeed</maml:name> <maml:description> <maml:para>Specifies the CLI port speed. The possible values include: 9,600 bps, 19,200 bps, 38,400 bps, 57,600 bps, and 115,200 bps. NOTE: The serial port speed set using this parameter must match the speed of the serial port set in the RBSU.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">9600</command:parameterValue> <command:parameterValue required="false" variableLength="false">19200</command:parameterValue> <command:parameterValue required="false" variableLength="false">38400</command:parameterValue> <command:parameterValue required="false" variableLength="false">57600</command:parameterValue> <command:parameterValue required="false" variableLength="false">115200</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RBSUPostIP</maml:name> <maml:description> <maml:para>Determines whether the iLO IP address is displayed during the server POST process. The valid values are Yes to display the IP address and No to not display the IP address. This parameter is not supported on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EnforceAES3DESEncryption</maml:name> <maml:description> <maml:para>Determines if iLO enforces the use of AES/3DES encryption ciphers over the iLO interface, SSH, and XML connections. The possible values are Yes to enforce the use of AES/3DES and No to not enforce the use of AES/3DES. This parameter is not supported on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationFailureLoggingThreshold</maml:name> <maml:description> <maml:para>Specifies logging criteria for failed authentications. Possible values include: • Disabled • Enabled-EveryFailure • Enabled-Every2ndFailure • Enabled-Every3rdFailure(this is the default value) • Enabled-Every5thFailure</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled-EveryFailure</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled-Every2ndFailure</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled-Every3rdFailure</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled-Every5thFailure</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationFailureDelayTimeSeconds</maml:name> <maml:description> <maml:para>Specifies delay time in seconds between failed login authentications. Possible values include: • 2 - 2 seconds • 5 - 5 seconds • 10 - 10 seconds • 30 - 30 seconds</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">2</command:parameterValue> <command:parameterValue required="false" variableLength="false">5</command:parameterValue> <command:parameterValue required="false" variableLength="false">10</command:parameterValue> <command:parameterValue required="false" variableLength="false">30</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationFailuresBeforeDelay</maml:name> <maml:description> <maml:para>Specifies the number of authentication failures allowed before delaying login. Possible values include: • 0 - Every failure causes delay • 1 - One failure causes no delay • 3 - Three failures cause no delay • 5 - Five failures cause no delay</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">0</command:parameterValue> <command:parameterValue required="false" variableLength="false">1</command:parameterValue> <command:parameterValue required="false" variableLength="false">3</command:parameterValue> <command:parameterValue required="false" variableLength="false">5</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPProtocolEnabled</maml:name> <maml:description> <maml:para>Determines whether iLO should respond to external SNMP requests. Valid values are Yes to enable SNMP access and No to disable SNMP access. If disabled, the iLO Management Engine continues to operate and the information displayed in the iLO web interface is updated, but no alerts are generated and SNMP access is not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPPort</maml:name> <maml:description> <maml:para>Sets the port used for SNMP communications. The industry standard (default) SNMP port is 161 for SNMP access. Value must be a valid port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPTrapPort</maml:name> <maml:description> <maml:para>Sets the port to which SNMP traps (alerts) are sent. The industry standard (default) SNMP trap port is 162. Value must be a valid port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPMIProtocolEnabled</maml:name> <maml:description> <maml:para>Determines whether you can send industry-standard IPMI and DCMI commands over the LAN using a client-side application. Server-side IPMI/DCMI applications are still functional even when this setting is disabled. The valid values are Yes to enable this feature and No to disable this feature.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SerialOverLANLoggingEnabled</maml:name> <maml:description> <maml:para>Indicates whether Serial Over LAN (SOL) or Virtual Serial Port (VSP) logging is enabled. Valid values are Yes to enable this feature or No to disable this feature.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSDPNotifyIPv6Scope</maml:name> <maml:description> <maml:para>The scope for IPv6 Notify messages for SSDP. The possible values are: • Link • Site • Organization This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Link</command:parameterValue> <command:parameterValue required="false" variableLength="false">Site</command:parameterValue> <command:parameterValue required="false" variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSDPNotifyMulticastIntervalSeconds</maml:name> <maml:description> <maml:para>Indicates how often multicast is performed for SSDP. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">0</command:parameterValue> <command:parameterValue required="false" variableLength="false">30</command:parameterValue> <command:parameterValue required="false" variableLength="false">60</command:parameterValue> <command:parameterValue required="false" variableLength="false">120</command:parameterValue> <command:parameterValue required="false" variableLength="false">300</command:parameterValue> <command:parameterValue required="false" variableLength="false">600</command:parameterValue> <command:parameterValue required="false" variableLength="false">900</command:parameterValue> <command:parameterValue required="false" variableLength="false">1800</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSDPNotifyTTL</maml:name> <maml:description> <maml:para>The Time to Live (TTL) hop count for SSDP Notify messages. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSDPProtocolEnabled</maml:name> <maml:description> <maml:para>Indicates whether SSDP is enabled for the manager. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaProtocolEnabled</maml:name> <maml:description> <maml:para>Indicates whether Virtual Media is enabled for the manager. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RIBCLEnabled</maml:name> <maml:description> <maml:para>This property enables or disables RIBCL for the management processor. The management processor will require a reset when this field is modified.The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPMIPort</maml:name> <maml:description> <maml:para>The IPMI over LAN port number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VSPLogDownloadEnabled</maml:name> <maml:description> <maml:para>This property enables or disables download of the downloadable Virtual Serial Port (VSP) log. Valid values are Yes to enable this feature or No to disable this feature. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VSPDlLoggingEnabled</maml:name> <maml:description> <maml:para>This property enables or disables logging to the downloadable Virtual Serial Port (VSP) log. Valid values are Yes to enable this feature or No to disable this feature. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualNICEnabled</maml:name> <maml:description> <maml:para>Indicates whether the Virtual Network Interface is enabled or not. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VideoPresenceDetectOverride</maml:name> <maml:description> <maml:para>This property controls video presence detection on the VGA port. When set to 'Yes', firmware workaround detects some KVMs that are not automatically supported. When set to 'No', detects hardware-based automatic video presence. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ServerFQDN</maml:name> <maml:description> <maml:para>Specifies the ServerFQDN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the ServerName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LockConfiguration</maml:name> <maml:description> <maml:para>Specifies the Lock configuration settings. Supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DefaultUserName</maml:name> <maml:description> <maml:para>The parameter default name used to log in to the management processor when factory reset is performed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PhysicalMonitorHealthStatusEnabled</maml:name> <maml:description> <maml:para>Enables or Disables the display of Server Health Status on a physical monitor attached to the system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DefaultPassword</maml:name> <maml:description> <maml:para>This parameter default password is used to log in to the management processor when factory reset is performed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PasswordComplexityEnabled</maml:name> <maml:description> <maml:para>This parameter when enabled enforces complexity rules when a user password is set or changed. Three of four character classes must be present; ASCII UPPERCASE, LOWERCASE, DIGITS, and Other. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaEncryptionEnabled</maml:name> <maml:description> <maml:para>Enables or disables encryption on virtual media connections. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SessionTimeoutMinutes</maml:name> <maml:description> <maml:para>Determines the maximum session timeout value in minutes. The accepted values are 0, 15, 30, 60, and 120. A value of 0 specifies infinite timeout.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">0</command:parameterValue> <command:parameterValue required="false" variableLength="false">15</command:parameterValue> <command:parameterValue required="false" variableLength="false">30</command:parameterValue> <command:parameterValue required="false" variableLength="false">60</command:parameterValue> <command:parameterValue required="false" variableLength="false">120</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLORBSUEnabled</maml:name> <maml:description> <maml:para>Determines if the F8 prompt for a ROM-based configuration appears during POST. The possible values are Yes to enable the F8 prompt to appear during POST and No to disable the F8 prompt during POST.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HTTPPort</maml:name> <maml:description> <maml:para>Specifies the HTTP port number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HTTPProtocolEnabled</maml:name> <maml:description> <maml:para>Indicates whether HTTP is enabled for the manager. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HTTPSPort</maml:name> <maml:description> <maml:para>Specifies the HTTPS (SSL) port number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HTTPSProtocolEnabled</maml:name> <maml:description> <maml:para>Indicates whether HTTPS is enabled for the manager. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="KVMIPPort"> <maml:name>RemoteConsolePort</maml:name> <maml:description> <maml:para>Specifies the port used for remote console.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteConsoleProtocolEnabled</maml:name> <maml:description> <maml:para>Indicates whether RemoteConsole is enabled for the manager. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteConsoleThumbnailEnabled</maml:name> <maml:description> <maml:para>This property enables or disables the accessibility of remote console thumbnail image in iLO. Disabling this property will not disable remote console feature. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RequireHostAuthentication</maml:name> <maml:description> <maml:para>Determines whether authentication is required for host-based utilities which use CHIF (typically use of CHIF requires Administrator/root credentials). The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FederationEnabled</maml:name> <maml:description> <maml:para>Indicates whether Federation is enabled for the manager. The possible values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MinimumPasswordLength</maml:name> <maml:description> <maml:para>Specifies how many characters are required in all user passwords. The value can be from 8 to 39 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPort</maml:name> <maml:description> <maml:para>Specifies the port used for virtual media.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>XMLReplyEnabled</maml:name> <maml:description> <maml:para>Determines whether management processor responds to anonymous XML discovery requests. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RequiredLoginForiLORBSU</maml:name> <maml:description> <maml:para>Determines if login credentials are required to access the RBSU for iLO. The possible values are Yes if login credentials are needed and No if login credentials are not needed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSHPort</maml:name> <maml:description> <maml:para>Specifies the port used for SSH connection. The processor must be reset if this value is changed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSHProtocolEnabled</maml:name> <maml:description> <maml:para>Determines if SSH is enabled. The valid values are Yes to enable the SSH functionality and No to disable the SSH functionality.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SerialCLIStatus</maml:name> <maml:description> <maml:para>Specifies the status of the CLI. The possible values include Disabled, Enabled-NoAuthenticationRequired, and Enabled-AuthenticationRequired.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled-NoAuthenticationRequired</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled-AuthenticationRequired</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SerialCLISpeed</maml:name> <maml:description> <maml:para>Specifies the CLI port speed. The possible values include: 9,600 bps, 19,200 bps, 38,400 bps, 57,600 bps, and 115,200 bps. NOTE: The serial port speed set using this parameter must match the speed of the serial port set in the RBSU.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">9600</command:parameterValue> <command:parameterValue required="false" variableLength="false">19200</command:parameterValue> <command:parameterValue required="false" variableLength="false">38400</command:parameterValue> <command:parameterValue required="false" variableLength="false">57600</command:parameterValue> <command:parameterValue required="false" variableLength="false">115200</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RBSUPostIP</maml:name> <maml:description> <maml:para>Determines whether the iLO IP address is displayed during the server POST process. The valid values are Yes to display the IP address and No to not display the IP address. This parameter is not supported on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EnforceAES3DESEncryption</maml:name> <maml:description> <maml:para>Determines if iLO enforces the use of AES/3DES encryption ciphers over the iLO interface, SSH, and XML connections. The possible values are Yes to enforce the use of AES/3DES and No to not enforce the use of AES/3DES. This parameter is not supported on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationFailureLoggingThreshold</maml:name> <maml:description> <maml:para>Specifies logging criteria for failed authentications. Possible values include: • Disabled • Enabled-EveryFailure • Enabled-Every2ndFailure • Enabled-Every3rdFailure(this is the default value) • Enabled-Every5thFailure</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled-EveryFailure</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled-Every2ndFailure</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled-Every3rdFailure</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled-Every5thFailure</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationFailureDelayTimeSeconds</maml:name> <maml:description> <maml:para>Specifies delay time in seconds between failed login authentications. Possible values include: • 2 - 2 seconds • 5 - 5 seconds • 10 - 10 seconds • 30 - 30 seconds</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">2</command:parameterValue> <command:parameterValue required="false" variableLength="false">5</command:parameterValue> <command:parameterValue required="false" variableLength="false">10</command:parameterValue> <command:parameterValue required="false" variableLength="false">30</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationFailuresBeforeDelay</maml:name> <maml:description> <maml:para>Specifies the number of authentication failures allowed before delaying login. Possible values include: • 0 - Every failure causes delay • 1 - One failure causes no delay • 3 - Three failures cause no delay • 5 - Five failures cause no delay</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">0</command:parameterValue> <command:parameterValue required="false" variableLength="false">1</command:parameterValue> <command:parameterValue required="false" variableLength="false">3</command:parameterValue> <command:parameterValue required="false" variableLength="false">5</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPProtocolEnabled</maml:name> <maml:description> <maml:para>Determines whether iLO should respond to external SNMP requests. Valid values are Yes to enable SNMP access and No to disable SNMP access. If disabled, the iLO Management Engine continues to operate and the information displayed in the iLO web interface is updated, but no alerts are generated and SNMP access is not permitted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPPort</maml:name> <maml:description> <maml:para>Sets the port used for SNMP communications. The industry standard (default) SNMP port is 161 for SNMP access. Value must be a valid port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPTrapPort</maml:name> <maml:description> <maml:para>Sets the port to which SNMP traps (alerts) are sent. The industry standard (default) SNMP trap port is 162. Value must be a valid port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPMIProtocolEnabled</maml:name> <maml:description> <maml:para>Determines whether you can send industry-standard IPMI and DCMI commands over the LAN using a client-side application. Server-side IPMI/DCMI applications are still functional even when this setting is disabled. The valid values are Yes to enable this feature and No to disable this feature.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SerialOverLANLoggingEnabled</maml:name> <maml:description> <maml:para>Indicates whether Serial Over LAN (SOL) or Virtual Serial Port (VSP) logging is enabled. Valid values are Yes to enable this feature or No to disable this feature.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSDPNotifyIPv6Scope</maml:name> <maml:description> <maml:para>The scope for IPv6 Notify messages for SSDP. The possible values are: • Link • Site • Organization This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Link</command:parameterValue> <command:parameterValue required="false" variableLength="false">Site</command:parameterValue> <command:parameterValue required="false" variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSDPNotifyMulticastIntervalSeconds</maml:name> <maml:description> <maml:para>Indicates how often multicast is performed for SSDP. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">0</command:parameterValue> <command:parameterValue required="false" variableLength="false">30</command:parameterValue> <command:parameterValue required="false" variableLength="false">60</command:parameterValue> <command:parameterValue required="false" variableLength="false">120</command:parameterValue> <command:parameterValue required="false" variableLength="false">300</command:parameterValue> <command:parameterValue required="false" variableLength="false">600</command:parameterValue> <command:parameterValue required="false" variableLength="false">900</command:parameterValue> <command:parameterValue required="false" variableLength="false">1800</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSDPNotifyTTL</maml:name> <maml:description> <maml:para>The Time to Live (TTL) hop count for SSDP Notify messages. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SSDPProtocolEnabled</maml:name> <maml:description> <maml:para>Indicates whether SSDP is enabled for the manager. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaProtocolEnabled</maml:name> <maml:description> <maml:para>Indicates whether Virtual Media is enabled for the manager. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RIBCLEnabled</maml:name> <maml:description> <maml:para>This property enables or disables RIBCL for the management processor. The management processor will require a reset when this field is modified.The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPMIPort</maml:name> <maml:description> <maml:para>The IPMI over LAN port number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VSPLogDownloadEnabled</maml:name> <maml:description> <maml:para>This property enables or disables download of the downloadable Virtual Serial Port (VSP) log. Valid values are Yes to enable this feature or No to disable this feature. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VSPDlLoggingEnabled</maml:name> <maml:description> <maml:para>This property enables or disables logging to the downloadable Virtual Serial Port (VSP) log. Valid values are Yes to enable this feature or No to disable this feature. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualNICEnabled</maml:name> <maml:description> <maml:para>Indicates whether the Virtual Network Interface is enabled or not. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VideoPresenceDetectOverride</maml:name> <maml:description> <maml:para>This property controls video presence detection on the VGA port. When set to 'Yes', firmware workaround detects some KVMs that are not automatically supported. When set to 'No', detects hardware-based automatic video presence. The possible values are Yes and No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ServerFQDN</maml:name> <maml:description> <maml:para>Specifies the ServerFQDN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ServerName</maml:name> <maml:description> <maml:para>Specifies the ServerName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LockConfiguration</maml:name> <maml:description> <maml:para>Specifies the Lock configuration settings. Supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DefaultUserName</maml:name> <maml:description> <maml:para>The parameter default name used to log in to the management processor when factory reset is performed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PhysicalMonitorHealthStatusEnabled</maml:name> <maml:description> <maml:para>Enables or Disables the display of Server Health Status on a physical monitor attached to the system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DefaultPassword</maml:name> <maml:description> <maml:para>This parameter default password is used to log in to the management processor when factory reset is performed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PasswordComplexityEnabled</maml:name> <maml:description> <maml:para>This parameter when enabled enforces complexity rules when a user password is set or changed. Three of four character classes must be present; ASCII UPPERCASE, LOWERCASE, DIGITS, and Other. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaEncryptionEnabled</maml:name> <maml:description> <maml:para>Enables or disables encryption on virtual media connections. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.Int32[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>DefaultUsernameAndPassword</maml:title> <maml:alert> <maml:para>You cannot do a GET on the DefaultUsername and DefaultPassword attributes as these attributes are stored in iLO internal memory and are only visible and accessible after Factory Reset.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOAccessSetting -AuthenticationFailureLoggingThreshold Enabled-Every2ndFailure -AuthenticationFailureDelayTimeSeconds 2 -AuthenticationFailuresBeforeDelay 1 -RemoteSyslogEnabled Yes -RemoteSyslogPort 12 -RemoteSyslogServer 1.1.1.1 -EnforceAES3DESEncryption Yes</dev:code> <dev:remarks> <maml:para>This example sets the value of Access settings on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PSC:\> ,$connection | Set-HPEiLOAccessSetting -SSDPNotifyIPv6Scope Link -SSDPNotifyMulticastIntervalSeconds 10 -SSDPNotifyTTL 10 -SSDPProtocolEnabled yes</dev:code> <dev:remarks> <maml:para>This example sets the value of Access settings on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEiLOAccessSetting -Connection $connection -AuthenticationFailureLoggingThreshold Enabled-Every2ndFailure -AuthenticationFailureDelayTimeSeconds 2 -AuthenticationFailuresBeforeDelay 1 -RemoteSyslogEnabled Yes -RemoteSyslogPort 12 -RemoteSyslogServer 1.1.1.1 -EnforceAES3DESEncryption Yes -SessionTimeoutMinutes 15 -iLORBSUEnabled Yes -HTTPPort 123 -HTTPSPort 321 -RemoteConsolePort 100 -MinimumPasswordLength 10</dev:code> <dev:remarks> <maml:para>This example sets the value of Access settings on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOAccessSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-HPEiLO</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>Set-HPEiLOAdministratorPassword</command:name> <maml:description> <maml:para>Sets the administrator password to the specified value.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOAdministratorPassword</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOAdministratorPassword cmdlet sets the administrator account password to the specified value. This cmdlet assumes that there is an Administrator account because it is not intended to create one.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOAdministratorPassword</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>New password value to be set for the Administrator account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>New password value to be set for the Administrator account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOAdministratorPassword -Password admin1234</dev:code> <dev:remarks> <maml:para>This cmdlet sets administrator password on iLO 4 or iLO 5 with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEiLOAdministratorPassword -Connection $connection -Password admin1234</dev:code> <dev:remarks> <maml:para>This cmdlet sets the administrator password on iLO 4 and iLO 5 servers with array of connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Set-HPEiLOAHSStatus</command:name> <maml:description> <maml:para>Enables or disables AHS logging.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOAHSStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOAHSStatus cmdlet enables or disables AHS logging.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOAHSStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AHSEnabled</maml:name> <maml:description> <maml:para>Specifies if AHS logging is enabled or disabled. The possible values are Yes to enable AHS logging and No to disable AHS logging.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AHSEnabled</maml:name> <maml:description> <maml:para>Specifies if AHS logging is enabled or disabled. The possible values are Yes to enable AHS logging and No to disable AHS logging.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>If the cmdlet executes successfully, it does returns an object with warning or information. In case of an error, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>• In case of iLO 4 servers, This cmdlet resets the iLO when changing the status. However, if the command results in no status change (for example, if setting the status to Yes when the status is already enabled), the iLO will not reset. • In case of iLO 5 servers, after successful execution of the command, the user is expected to do a reset to apply the setting.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $out = ,$connection | Set-HPEiLOAHSStatus -AHSEnabled No</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of AHSEnabled on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEiLOAHSStatus -Connection $connection -AHSEnabled Yes</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of AHSEnabled iLO 4 and iLO 5 servers with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOAHSStatus</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>Set-HPEiLOAlertMailSetting</command:name> <maml:description> <maml:para>Modifies alertmail settings of the host server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOAlertMailSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOAlertMailSetting cmdlet modifies alertmail settings of the iLO. You must have the Configure iLO Settings privilege to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet" default="true"> <!--NAME: UsernamePasswordSet--> <!--TAG: DEFAULT--> <maml:name>Set-HPEiLOAlertMailSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailEmail</maml:name> <maml:description> <maml:para>Sets the destination email address for iLO email alerts. Value must be a single email address no longer than 63 characters and must be in standard email address format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailEnabled</maml:name> <maml:description> <maml:para>Determines whether iLO should send alert conditions detected independently of the host operating system via email. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSenderDomain</maml:name> <maml:description> <maml:para>Sets the domain name to be used in the sender (From) email address. The value is formed by using the iLO name as the hostname and the subject string as the domain name. The parameter value cannot be null or empty.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPPort</maml:name> <maml:description> <maml:para>Sets the port that the SMTP server uses for unauthenticated SMTP connections. The default value is 25.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPServer</maml:name> <maml:description> <maml:para>Sets the IP address or DNS name of the SMTP server or the MSA. This server cooperates with the MTA to deliver Email. The maximum string length is 63 characters. Note that the SMTP server is specified by support unauthenticated SMTP connections on port 25.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPAuthEnabled</maml:name> <maml:description> <maml:para>This parameter indicates whether AlertMail SMTP Authentication is enabled. It can be enabled only when the properties AlertMailSMTPSecureEnabled, AlertMailSMTPAuthUser, and AlertMailSMTPAuthPw are set or not empty. It takes Yes or No values. Works only on iLO 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPAuthUser</maml:name> <maml:description> <maml:para>It is the username credential for SMTP server authentication. Works only on iLO 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPAuthPw</maml:name> <maml:description> <maml:para>It is the password credential for SMTP server authentication. Works only on iLO 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPSecureEnabled</maml:name> <maml:description> <maml:para>This parameter Indicates whether AlertMail SMTP Secure Connection (SSL/TLS) is enabled. It takes Yes or No values. Works only on iLO 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Set-HPEiLOAlertMailSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailEmail</maml:name> <maml:description> <maml:para>Sets the destination email address for iLO email alerts. Value must be a single email address no longer than 63 characters and must be in standard email address format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailEnabled</maml:name> <maml:description> <maml:para>Determines whether iLO should send alert conditions detected independently of the host operating system via email. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSenderDomain</maml:name> <maml:description> <maml:para>Sets the domain name to be used in the sender (From) email address. The value is formed by using the iLO name as the hostname and the subject string as the domain name. The parameter value cannot be null or empty.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPPort</maml:name> <maml:description> <maml:para>Sets the port that the SMTP server uses for unauthenticated SMTP connections. The default value is 25.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPServer</maml:name> <maml:description> <maml:para>Sets the IP address or DNS name of the SMTP server or the MSA. This server cooperates with the MTA to deliver Email. The maximum string length is 63 characters. Note that the SMTP server is specified by support unauthenticated SMTP connections on port 25.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPAuthEnabled</maml:name> <maml:description> <maml:para>This parameter indicates whether AlertMail SMTP Authentication is enabled. It can be enabled only when the properties AlertMailSMTPSecureEnabled, AlertMailSMTPAuthUser, and AlertMailSMTPAuthPw are set or not empty. It takes Yes or No values. Works only on iLO 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPSecureEnabled</maml:name> <maml:description> <maml:para>This parameter Indicates whether AlertMail SMTP Secure Connection (SSL/TLS) is enabled. It takes Yes or No values. Works only on iLO 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPAuthCredential</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailEmail</maml:name> <maml:description> <maml:para>Sets the destination email address for iLO email alerts. Value must be a single email address no longer than 63 characters and must be in standard email address format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailEnabled</maml:name> <maml:description> <maml:para>Determines whether iLO should send alert conditions detected independently of the host operating system via email. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSenderDomain</maml:name> <maml:description> <maml:para>Sets the domain name to be used in the sender (From) email address. The value is formed by using the iLO name as the hostname and the subject string as the domain name. The parameter value cannot be null or empty.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPPort</maml:name> <maml:description> <maml:para>Sets the port that the SMTP server uses for unauthenticated SMTP connections. The default value is 25.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPServer</maml:name> <maml:description> <maml:para>Sets the IP address or DNS name of the SMTP server or the MSA. This server cooperates with the MTA to deliver Email. The maximum string length is 63 characters. Note that the SMTP server is specified by support unauthenticated SMTP connections on port 25.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPAuthEnabled</maml:name> <maml:description> <maml:para>This parameter indicates whether AlertMail SMTP Authentication is enabled. It can be enabled only when the properties AlertMailSMTPSecureEnabled, AlertMailSMTPAuthUser, and AlertMailSMTPAuthPw are set or not empty. It takes Yes or No values. Works only on iLO 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPAuthUser</maml:name> <maml:description> <maml:para>It is the username credential for SMTP server authentication. Works only on iLO 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPAuthPw</maml:name> <maml:description> <maml:para>It is the password credential for SMTP server authentication. Works only on iLO 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPSecureEnabled</maml:name> <maml:description> <maml:para>This parameter Indicates whether AlertMail SMTP Secure Connection (SSL/TLS) is enabled. It takes Yes or No values. Works only on iLO 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertMailSMTPAuthCredential</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.Int32[] System.String</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>If the example executes successfully, it does not return anything. In case of an error or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOAlertMailSetting -AlertMailEmail yv@abcd.com -AlertMailEnabled Yes -AlertMailSenderDomain 10.10.10.10 -AlertMailSMTPPort 25 -AlertMailSMTPServer 15.15.15.15</dev:code> <dev:remarks> <maml:para>This example sets the value of AlertMail settings on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEiLOAlertMailSetting -Connection $connection -AlertMailEmail yv@abcd.com -AlertMailEnabled Yes -AlertMailSenderDomain 10.10.10.10 -AlertMailSMTPPort 25 -AlertMailSMTPServer 15.15.15.15 -AlertMailSMTPAuthEnabled Yes -AlertMailSMTPSecureEnabled Yes -AlertMailSMTPAuthUser "admin" -AlertMailSMTPAuthPw "admin123"</dev:code> <dev:remarks> <maml:para>This example sets the value of AlertMail settings on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOAlertMailSetting</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>Set-HPEiLOAssetTag</command:name> <maml:description> <maml:para>Sets or clears the asset tag.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOAssetTag</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOAssetTag cmdlet sets or clears the asset tag. You must have VirtualMedia, ResetServer, and RemoteConsole privileges to execute this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOAssetTag</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AssetTag</maml:name> <maml:description> <maml:para>Enter a string to add or modify the asset tag, or enter an empty string to clear the asset tag. The parameter value can have up to a maximum length of 32 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AssetTag</maml:name> <maml:description> <maml:para>Enter a string to add or modify the asset tag, or enter an empty string to clear the asset tag. The parameter value can have up to a maximum length of 32 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEiLOAssetTag -Connection $connection -AssetTag "abcd"</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of Asset Tag on iLO 4 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOAssetTag -AssetTag "abcd"</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of Asset Tag on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEiLOAssetTag -Connection $connection -AssetTag "abcd"</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of Asset Tag on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOAssetTag</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>Set-HPEiLOBatteryBackUpUnit</command:name> <maml:description> <maml:para>Sets the battery back up unit.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOBatteryBackUpUnit</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOBatteryBackUpUnit cmdlet sets the battery backup unit. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOBatteryBackUpUnit</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BbuPowerSupplyAction</maml:name> <maml:description> <maml:para>Battery Backup Unit Power Supply action determines what will occur when a server is running on battery power. Supported values are DoNothing, MomentaryPowerButtonPress, and HostShutdown.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNothing</command:parameterValue> <command:parameterValue required="false" variableLength="false">MomentaryPowerButtonPress</command:parameterValue> <command:parameterValue required="false" variableLength="false">HostShutdown</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BbuPowerSupplyAction</maml:name> <maml:description> <maml:para>Battery Backup Unit Power Supply action determines what will occur when a server is running on battery power. Supported values are DoNothing, MomentaryPowerButtonPress, and HostShutdown.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DoNothing</command:parameterValue> <command:parameterValue required="false" variableLength="false">MomentaryPowerButtonPress</command:parameterValue> <command:parameterValue required="false" variableLength="false">HostShutdown</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOBatteryBackUpUnit -BbuPowerSupplyAction DoNothing</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of BbuPowerSupplyAction on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1-2 -Username admin -Password admin123 PS C:\> Set-HPEiLOBatteryBackUpUnit -Connection $connection -BbuPowerSupplyAction DoNothing</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of BbuPowerSupplyAction on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOBatteryBackUpUnit</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>Set-HPEiLOBootMode</command:name> <maml:description> <maml:para>Sets the pending boot mode that will take effect when the server is rebooted.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOBootMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOBootMode cmdlet sets the pending boot mode that will take effect on the server’s next restart.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOBootMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PendingBootMode</maml:name> <maml:description> <maml:para>Specifies the boot mode for the next server restart. The possible values are LegacyBios and UEFI.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">LegacyBios</command:parameterValue> <command:parameterValue required="false" variableLength="false">UEFI</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PendingBootMode</maml:name> <maml:description> <maml:para>Specifies the boot mode for the next server restart. The possible values are LegacyBios and UEFI.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">LegacyBios</command:parameterValue> <command:parameterValue required="false" variableLength="false">UEFI</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>. Gen8 systems does not supoort UEFI boot mode.</maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOBootMode -PendingBootMode LegacyBios</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of PendingBootMode on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOBootMode -PendingBootMode LegacyBios,UEFI</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of PendingBootMode on iLO 4 and iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOBootMode</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>Set-HPEiLOBrownout</command:name> <maml:description> <maml:para>Turns the brownout recovery feature on or off.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOBrownout</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOBrownout cmdlet turns the brownout recovery feature on or off.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOBrownout</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BrownoutEnabled</maml:name> <maml:description> <maml:para>When a brownout condition occurs in the server, this setting will determine if the server should recover from it. The supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BrownoutEnabled</maml:name> <maml:description> <maml:para>When a brownout condition occurs in the server, this setting will determine if the server should recover from it. The supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOBrownout -BrownoutEnabled Yes</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEiLOBrownout -Connection $connection -BrownoutEnabled Yes,No</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOBrownout</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Set-HPEiLOCACSmartCardAuthentication</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOCACSmartCardAuthentication</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOCACSmartCardAuthentication</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CertificateLoginEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LDAPCertificateNameMapping</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SubjectCN</command:parameterValue> <command:parameterValue required="false" variableLength="false">SubjectDN</command:parameterValue> <command:parameterValue required="false" variableLength="false">SANRFC822</command:parameterValue> <command:parameterValue required="false" variableLength="false">SANUPN</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StrictCACModeEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OCSPUri</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CertificateLoginEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LDAPCertificateNameMapping</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SubjectCN</command:parameterValue> <command:parameterValue required="false" variableLength="false">SubjectDN</command:parameterValue> <command:parameterValue required="false" variableLength="false">SANRFC822</command:parameterValue> <command:parameterValue required="false" variableLength="false">SANUPN</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StrictCACModeEnabled</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OCSPUri</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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> </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>Set-HPEiLOChassisPowerCapSetting</command:name> <maml:description> <maml:para>Modifies Apollo chassis Power capping settings</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOChassisPowerCapSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets Apollo chassis Power cap settings. This cmdlet works only on iLO 5 Apollo servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOChassisPowerCapSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ZoneNumber</maml:name> <maml:description> <maml:para>The zone number either on the entire chassis or specific zone. 0 for entire chassis, other number is for specific zone.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[][]</command:parameterValue> <dev:type> <maml:name>UInt32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerLimitInWatts</maml:name> <maml:description> <maml:para>The target power limit (in Watts) for the zone, it will be set to null when power limit disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[][]</command:parameterValue> <dev:type> <maml:name>UInt32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ZoneNumber</maml:name> <maml:description> <maml:para>The zone number either on the entire chassis or specific zone. 0 for entire chassis, other number is for specific zone.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[][]</command:parameterValue> <dev:type> <maml:name>UInt32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerLimitInWatts</maml:name> <maml:description> <maml:para>The target power limit (in Watts) for the zone, it will be set to null when power limit disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[][]</command:parameterValue> <dev:type> <maml:name>UInt32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.UInt32[][]</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>HPE.iLO.Response.Redfish.PowerCapSetting</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$con = Connect-HPEiLO 192.168.10.28 admin admin123 -DisableCertificateAuthentication -Verbose $zoneNumber = ,@(2,3) $powerLimit = ,@(300,400) $obj = $con | Set-HPEiLOChassisPowerCapSetting -ZoneNumber $zoneNumber -PowerLimitInWatts $powerLimit</dev:code> <dev:remarks> <maml:para>Chassis power cap setting on a single iLO 5 server.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$con = Connect-HPEiLO 192.168.10.28 admin admin123 -DisableCertificateAuthentication -Verbose $zoneNumber1 = ,@(2,3) $powerLimit1 = ,@(300,400) $zoneNumber2 = ,@(0,1) $powerLimit2 = ,@(900,100) $zonenums = @() $zonenums += $zoneNumber1 $zonenums += $zoneNumber2 $powernums = @() $powernums += $powerLimit1 $powernums += $powerLimit2 $obj = Set-HPEiLOChassisPowerCapSetting -Connection $con -ZoneNumber $zonenums -PowerLimitInWatts $powernums</dev:code> <dev:remarks> <maml:para>Chassis power cap setting on a multiple iLO 5 server.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOChassisPowerCapSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</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>Set-HPEiLOChassisPowerRegulatorSetting</command:name> <maml:description> <maml:para>Sets Apollo chassis power regulator settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOChassisPowerRegulatorSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets Apollo chassis Power regulator settings. This cmdlet works only on iLO 5 servers.</maml:para> <maml:para>Power regulation can take the following values: 1) ACRedundancy: AC Redundancy with Throttling Mode (Max Performance w/ Redundancy) 2) FullACDCRedundancy: Full AC/DC Redundancy Mode 3) UserConfig: User Configurable Mode 4) APM: APM Power Regulator Mode. Cannot configure by iLO 5) PowerFeedProtect: Power Feed Protection Mode</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOChassisPowerRegulatorSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EEPROMSaveEnabled</maml:name> <maml:description> <maml:para>Determines whether the EEPROM save is enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerRegulationEnabled</maml:name> <maml:description> <maml:para>Determines whether power regulation is enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerRegulatorMode</maml:name> <maml:description> <maml:para>Power regulation can take the following values: 1) ACRedundancy: AC Redundancy with Throttling Mode (Max Performance w/ Redundancy) 2) FullACDCRedundancy: Full AC/DC Redundancy Mode 3) UserConfig: User Configurable Mode 4) APM: APM Power Regulator Mode. Cannot configure by iLO 5) PowerFeedProtect: Power Feed Protection Mode</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ACRedundancyiwthThrottlingMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">FullACDCRedundancyMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserConfigMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">APMPowerCappingMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">PowerFeedProtectionMode</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>If the cmdlet executes successfully, it does not return anything. In case of an error or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EEPROMSaveEnabled</maml:name> <maml:description> <maml:para>Determines whether the EEPROM save is enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerRegulationEnabled</maml:name> <maml:description> <maml:para>Determines whether power regulation is enabled or disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerRegulatorMode</maml:name> <maml:description> <maml:para>Power regulation can take the following values: 1) ACRedundancy: AC Redundancy with Throttling Mode (Max Performance w/ Redundancy) 2) FullACDCRedundancy: Full AC/DC Redundancy Mode 3) UserConfig: User Configurable Mode 4) APM: APM Power Regulator Mode. Cannot configure by iLO 5) PowerFeedProtect: Power Feed Protection Mode</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ACRedundancyiwthThrottlingMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">FullACDCRedundancyMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserConfigMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">APMPowerCappingMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">PowerFeedProtectionMode</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>If the cmdlet executes successfully, it does not return anything. In case of an error or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$con34 = Connect-HPEiLO 192.168.10.34 admin admin123 -DisableCertificateAuthentication $con34 | Set-HPEiLOChassisPowerRegulatorSetting -EEPROMSaveEnabled Yes -PowerRegulationEnabled No -PowerRegulatorMode ACRedundancyiwthThrottlingMode -Force</dev:code> <dev:remarks> <maml:para>Sets the above settings on the chassis power regulatory settings.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOChassisPowerRegulatorSetting</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>Set-HPEiLOChassisPowerZoneConfiguration</command:name> <maml:description> <maml:para>Sets the Apollo chassis server power zone configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOChassisPowerZoneConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOChassisPowerZoneConfiguration cmdlet sets the Apollo chassis server power zone configuration. It allows to set each node to be grouped with the entire chassis or an existing user-defined zone. This cmdlet is supported on iLO 5 servers only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOChassisPowerZoneConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Operation</maml:name> <maml:description> <maml:para>Specifies whether an update is to be performed for the existing zone configuration or existing zone configuration is to be replaced with a new zone configuration. The supported values are 'Update' and 'Replace'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Update</command:parameterValue> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ZoneNumber</maml:name> <maml:description> <maml:para>Specifies the zone number for which the node is to be assigned or modified. When the zone number is specified as 0, then the given nodes will be assigned to the chassis.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ZonePriority</maml:name> <maml:description> <maml:para>Specifies the power regulation zone priority. When zones are configured, you can set the power regulation priority for each zone. When power caps are set, zones with the highest priority receive more power than zones with lower priority settings.</maml:para> <maml:para>You can set the priority value from 1 to 5. The highest priority is 1 and the lowest priority is 5. By default, each zone is set to priority 5. Multiple zones can be set to the same priority level.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NodeNumber</maml:name> <maml:description> <maml:para>The node number of zone configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[][]</command:parameterValue> <dev:type> <maml:name>UInt32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NodePriority</maml:name> <maml:description> <maml:para>The power regulation node priority. The range must be between 1 - 5, 5 being the default and lowest priority.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[][]</command:parameterValue> <dev:type> <maml:name>UInt32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Operation</maml:name> <maml:description> <maml:para>Specifies whether an update is to be performed for the existing zone configuration or existing zone configuration is to be replaced with a new zone configuration. The supported values are 'Update' and 'Replace'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Update</command:parameterValue> <command:parameterValue required="false" variableLength="false">Replace</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ZoneNumber</maml:name> <maml:description> <maml:para>Specifies the zone number for which the node is to be assigned or modified. When the zone number is specified as 0, then the given nodes will be assigned to the chassis.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ZonePriority</maml:name> <maml:description> <maml:para>Specifies the power regulation zone priority. When zones are configured, you can set the power regulation priority for each zone. When power caps are set, zones with the highest priority receive more power than zones with lower priority settings.</maml:para> <maml:para>You can set the priority value from 1 to 5. The highest priority is 1 and the lowest priority is 5. By default, each zone is set to priority 5. Multiple zones can be set to the same priority level.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NodeNumber</maml:name> <maml:description> <maml:para>The node number of zone configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[][]</command:parameterValue> <dev:type> <maml:name>UInt32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NodePriority</maml:name> <maml:description> <maml:para>The power regulation node priority. The range must be between 1 - 5, 5 being the default and lowest priority.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[][]</command:parameterValue> <dev:type> <maml:name>UInt32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.UInt32[] System.UInt32[][]</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>None.</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> $np = ,@(1,3) PS C:\> $nn = ,@(1,2) PS C:\> ,$connection | Set-HPEiLOChassisPowerZoneConfiguration -ZoneNumber 1 -ZonePriority 3 -Operation Update -NodeNumber $nn -NodePriority $np</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> $np = ,@(1,3) PS C:\> $nn = ,@(1,2) PS C:\> Set-HPEiLOChassisPowerZoneConfiguration -Connection $connection -ZoneNumber 1 -ZonePriority 3 -Operation Update -NodeNumber $nn -NodePriority $np</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOChassisPowerZoneConfiguration</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>Set-HPEiLOComputerLockConfiguration</command:name> <maml:description> <maml:para>Configures the computer lock settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOComputerLockConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOComputerLockConfiguration cmdlet configures the Remote Console Computer Lock feature.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOComputerLockConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LockType</maml:name> <maml:description> <maml:para>Lock option setting. The supported values are Windows, Custom, and Disabled. When Windows is given, KeySequence by default is set to Windows logo + L keys.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Windows</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeySequence</maml:name> <maml:description> <maml:para>When a hot key is pressed during a remote console session, the selected key combination (all keys pressed at the same time) will be transmitted in its place. Each hot key represents a combination of up to five keys that are sent to the host server when the hot key is pressed. Pass 'NONE' for unassigned items. The supported values are: ESC L_ALT R_ALT L_SHIFT R_SHIFT L_CTRL R_CTRL L_GUI R_GUI INS DEL HOME END PG UP PG DN ENTER TAB BREAK BACKSPACE NUM PLUS NUM MINUS SCRL LCK SYS RQ F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 SPACE ' , - . / 0 1 2 3 4 5 6 7 8 9 ; = [ \ ] ` a b c d e f g h i j k l m n o p q r s t u v w x y z</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LockType</maml:name> <maml:description> <maml:para>Lock option setting. The supported values are Windows, Custom, and Disabled. When Windows is given, KeySequence by default is set to Windows logo + L keys.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Windows</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeySequence</maml:name> <maml:description> <maml:para>When a hot key is pressed during a remote console session, the selected key combination (all keys pressed at the same time) will be transmitted in its place. Each hot key represents a combination of up to five keys that are sent to the host server when the hot key is pressed. Pass 'NONE' for unassigned items. The supported values are: ESC L_ALT R_ALT L_SHIFT R_SHIFT L_CTRL R_CTRL L_GUI R_GUI INS DEL HOME END PG UP PG DN ENTER TAB BREAK BACKSPACE NUM PLUS NUM MINUS SCRL LCK SYS RQ F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 SPACE ' , - . / 0 1 2 3 4 5 6 7 8 9 ; = [ \ ] ` a b c d e f g h i j k l m n o p q r s t u v w x y z</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.String[][]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $key = ,@("L_ALT","L_CTRL") PS C:\> ,$connection | Set-HPEiLOComputerLockConfiguration -LockType Custom -KeySequence $key</dev:code> <dev:remarks> <maml:para>This example sets the Computer Lock Configuration either for iLO 4 server or iLO 5 server, in which the Connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Set-HPEiLOComputerLockConfiguration -Connection $connection -LockType Windows</dev:code> <dev:remarks> <maml:para>This cmdlet sets the Computer Lock Configuration of iLO 4 and iLO 5 servers, in which the array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOComputerLockConfiguration</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>Set-HPEiLOCriticalTemperatureAction</command:name> <maml:description> <maml:para>Sets the server to Power On or Power Off after shutting down due to a critical temperature condition.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOCriticalTemperatureAction</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOCriticalTemperatureAction cmdlet controls the reaction of the server after a critical temperature shutdown. A value of No sets the server to automatically power on after a critical temperature shutdown (the default). A value of Yes sets the server to remain powered off after a critical temperature shutdown. This cmdlet is supported only on iLO 4 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOCriticalTemperatureAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RebootAfterShutdown</maml:name> <maml:description> <maml:para>Specifies the Critical Temperature setting. Possible values are Yes to keep server powered off after it shuts down due to critical temperature condition or No to power on the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>No</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RebootAfterShutdown</maml:name> <maml:description> <maml:para>Specifies the Critical Temperature setting. Possible values are Yes to keep server powered off after it shuts down due to critical temperature condition or No to power on the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>No</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>When the cmdlet does not execute correctly, output with the error message is produced. Otherwise, this cmdlet does not generate any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOCriticalTemperatureAction -RebootAfterShutdown Yes</dev:code> <dev:remarks> <maml:para>This example sets the RebootAfterShutdown for iLO 4 servers, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Set-HPEiLOCriticalTemperatureAction -Connection $connection -RebootAfterShutdown Yes,No,Yes</dev:code> <dev:remarks> <maml:para>This cmdlet sets the RebootAfterShutdown of iLO 4 servers, in which an array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOCriticalTemperatureAction</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Set-HPEiLODirectoryGroup</command:name> <maml:description> <maml:para>Modifies the Directory group user.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLODirectoryGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLODirectoryGroup cmdlet modifies the Directory group user. This cmdlet is supported on iLO 4 and iLO5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLODirectoryGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies the group name that has to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewGroupName</maml:name> <maml:description> <maml:para>Specifies the new group name for the existing group name.</maml:para> <maml:para>Note: If you want to modify only the privileges then do not use NewGroupName parameter. Instead, mention only the group name that needs change.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupSID</maml:name> <maml:description> <maml:para>Specifies the SID for a group container.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to add, edit, and delete iLO user accounts. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoteConsPriv"> <maml:name>RemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to remotely access the host system Remote Console, including video, keyboard, and mouse control. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to use scripted Virtual Media with the local iLO system. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ConfigiLOPriv"> <maml:name>iLOConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure most iLO settings, including security settings, and to remotely update firmware. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to log in to iLO. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to power-cycle or reset the local iLO system. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to configure the host BIOS settings by using the UEFI System Utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to configure the host NIC settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to configure the host storage settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to manage the System Recovery Set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Specifies the group name that has to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewGroupName</maml:name> <maml:description> <maml:para>Specifies the new group name for the existing group name.</maml:para> <maml:para>Note: If you want to modify only the privileges then do not use NewGroupName parameter. Instead, mention only the group name that needs change.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupSID</maml:name> <maml:description> <maml:para>Specifies the SID for a group container.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to add, edit, and delete iLO user accounts. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoteConsPriv"> <maml:name>RemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to remotely access the host system Remote Console, including video, keyboard, and mouse control. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to use scripted Virtual Media with the local iLO system. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ConfigiLOPriv"> <maml:name>iLOConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure most iLO settings, including security settings, and to remotely update firmware. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to log in to iLO. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to power-cycle or reset the local iLO system. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to configure the host BIOS settings by using the UEFI System Utilities.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to configure the host NIC settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to configure the host storage settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Enables directory users to manage the System Recovery Set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error prompt for any required parameter that is missing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>PARTIAL STATUS in iLO5</maml:title> <maml:alert> <maml:para>If you want to modify only the privileges then do not use NewGroupName parameter.</maml:para> <maml:para>$o = $con | Set-HPEiLODirectoryGroup -GroupName y3 -iLOConfigPrivilege Yes -HostNICConfigPrivilege Yes</maml:para> <maml:para>If the logged in user has insufficient privileges to change permissions of other users, then this cmdlet will return status as "PARTIAL". The cmdlet successfully creates the new user but does not have the permission to add privileges. This is because adding user and adding privileges is handled by two different Redfish URI's.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLODirectoryGroup -GroupName admin -NewGroupName admin123 -GroupSID 1-2-3-4 -UserConfigPrivilege Yes -iLOConfigPrivilege Yes -RemoteConsolePrivilege No -VirtualMediaPrivilege Yes -VirtualPowerAndResetPrivilege Yes -LoginPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet assigns a new group name to an exisiting directory group on iLO 4 along with various Privileges with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEiLODirectoryGroup -Connection $connection -GroupName admin -NewGroupName admin123 -GroupSID 1-2-3-4 -UserConfigPrivilege Yes -iLOConfigPrivilege Yes -RemoteConsolePrivilege No -VirtualMediaPrivilege Yes -VirtualPowerAndResetPrivilege Yes -LoginPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet assigns a new group name to an exisiting directory group on iLO 4 along with various privileges with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication $o = $connection | Set-HPEiLODirectoryGroup -RemoteConsolePrivilege Yes -NewGroupName newtg -GroupName tg -UserConfigPrivilege Yes -VirtualMediaPrivilege Yes -VirtualPowerAndResetPrivilege Yes -iLOConfigPrivilege Yes -LoginPrivilege Yes -HostBIOSConfigPrivilege Yes -HostNICConfigPrivilege Yes -HostStorageConfigPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet renames the existing group name to a new directory group on iLO5 along with various privileges with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLODirectoryGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLODirectoryGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLODirectoryGroup</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>Set-HPEiLODirectorySetting</command:name> <maml:description> <maml:para>Modifies the directory setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLODirectorySetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLODirectorySetting cmdlet modifies the directory setting. This cmdlet is supported on iLO 4 and iLO5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLODirectorySetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LDAPDirectoryAuthentication</maml:name> <maml:description> <maml:para>Enables or disables LDAP directory authentication. The possible values are Disabled, ExtendedSchema, and DirectoryDefaultSchema. The parameter is optional. If a parameter is not specified, then the parameter value for the specified setting is preserved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExtendedSchema</command:parameterValue> <command:parameterValue required="false" variableLength="false">DirectoryDefaultSchema</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LocalUserAccountEnabled</maml:name> <maml:description> <maml:para>Enables or disables local user accounts. The possible values are Yes to enable local user account or No to disable user account. The parameter is optional. If a parameter is not specified, then the parameter value for the specified setting is preserved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DirectoryServerAddress</maml:name> <maml:description> <maml:para>Specifies the location of the directory server. The directory server location is specified as an IP address or DNS name. The parameter is optional. If a parameter is not specified, then the parameter value for the specified setting is preserved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DirectoryServerPort</maml:name> <maml:description> <maml:para>Specifies the port number used to connect to the directory server. This value is obtained from the directory administrator. The secure LDAP port is 636, but the directory server can be configured for a different port number.</maml:para> <maml:para>Refer Notes of the cmdlet help before making any change to the default port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LOMObjectDN</maml:name> <maml:description> <maml:para>Specifies the unique name of iLO in the directory server. This value is obtained from the directory administrator. Distinguished names are limited to 256 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LOMObjectPassword</maml:name> <maml:description> <maml:para>Specifies the password associated with the iLO object in the directory server. Passwords are limited to 39 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GenericLDAPEnabled</maml:name> <maml:description> <maml:para>Specifies that this configuration uses the OpenLDAP supported BIND method. This setting is available only if Use Directory Default Schema is selected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserContext</maml:name> <maml:description> <maml:para>Specifies searchable contexts used to locate the user when the user is trying to authenticate using directories. If the user is not located using the first path, then the parameters specified in the second and third paths are used. The values for these parameters are obtained from the directory administrator. Directory User Contexts are limited to 128 characters each.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserContextIndex</maml:name> <maml:description> <maml:para>It is a number assigned to each user context detail that user passes to the cmdlet. It starts from usercontexindex 1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[][]</command:parameterValue> <dev:type> <maml:name>Int32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LDAPDirectoryAuthentication</maml:name> <maml:description> <maml:para>Enables or disables LDAP directory authentication. The possible values are Disabled, ExtendedSchema, and DirectoryDefaultSchema. The parameter is optional. If a parameter is not specified, then the parameter value for the specified setting is preserved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExtendedSchema</command:parameterValue> <command:parameterValue required="false" variableLength="false">DirectoryDefaultSchema</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LocalUserAccountEnabled</maml:name> <maml:description> <maml:para>Enables or disables local user accounts. The possible values are Yes to enable local user account or No to disable user account. The parameter is optional. If a parameter is not specified, then the parameter value for the specified setting is preserved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DirectoryServerAddress</maml:name> <maml:description> <maml:para>Specifies the location of the directory server. The directory server location is specified as an IP address or DNS name. The parameter is optional. If a parameter is not specified, then the parameter value for the specified setting is preserved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DirectoryServerPort</maml:name> <maml:description> <maml:para>Specifies the port number used to connect to the directory server. This value is obtained from the directory administrator. The secure LDAP port is 636, but the directory server can be configured for a different port number.</maml:para> <maml:para>Refer Notes of the cmdlet help before making any change to the default port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LOMObjectDN</maml:name> <maml:description> <maml:para>Specifies the unique name of iLO in the directory server. This value is obtained from the directory administrator. Distinguished names are limited to 256 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LOMObjectPassword</maml:name> <maml:description> <maml:para>Specifies the password associated with the iLO object in the directory server. Passwords are limited to 39 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GenericLDAPEnabled</maml:name> <maml:description> <maml:para>Specifies that this configuration uses the OpenLDAP supported BIND method. This setting is available only if Use Directory Default Schema is selected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserContext</maml:name> <maml:description> <maml:para>Specifies searchable contexts used to locate the user when the user is trying to authenticate using directories. If the user is not located using the first path, then the parameters specified in the second and third paths are used. The values for these parameters are obtained from the directory administrator. Directory User Contexts are limited to 128 characters each.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserContextIndex</maml:name> <maml:description> <maml:para>It is a number assigned to each user context detail that user passes to the cmdlet. It starts from usercontexindex 1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[][]</command:parameterValue> <dev:type> <maml:name>Int32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.Int32[][] System.String[][]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>If the cmdlet executes successfully, an object is returned with Status as Information. In case of an error or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Port number update will cause Directory test to fail</maml:title> <maml:alert> <maml:para>Because of iLO5 issue, if you modify port number (change the default number 636) then Start-HPEiLODirectorySettingTest will fail as iLO updates the Directory server address with port number as in it.(like IP:PORT format). The workaround is if you want to modify port number of directory server LDAP then first input the required port number for set cmdlet then in second call try without port number just with directory server settings.</maml:para> <maml:para>Set-HPEiLODirectorySetting -DirectoryServerAddress "192.168.1.1" -DirectoryServerPort "638"</maml:para> <maml:para>Set-HPEiLODirectorySetting -DirectoryServerAddress "192.168.1.1"</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $index = ,@(1,2) PS C:\> $value = ,@("context1","context2") PS C:\> ,$connection | Set-HPEiLODirectorySetting -LDAPDirectoryAuthentication DirectoryDefaultSchema -LocalUserAccountEnabled Yes -DirectoryServerAddress 1.1.1.1 -DirectoryServerPort 123 -LOMObjectDN abcd -LOMObjectPassword abcd.123 -UserContextIndex $index -UserContext $value</dev:code> <dev:remarks> <maml:para>This cmdlet sets the directory setting on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $index = ,@(1,2) PS C:\> $value = ,@("context1","context2") PS C:\> Set-HPEiLODirectorySetting -Connection $connection -LDAPDirectoryAuthentication DirectoryDefaultSchema -LocalUserAccountEnabled Yes -DirectoryServerAddress 1.1.1.1 -DirectoryServerPort 123 -LOMObjectDN abcd -LOMObjectPassword abcd.123 -UserContextIndex $index -UserContext $value</dev:code> <dev:remarks> <maml:para>This cmdlet sets the directory setting on iLO 4 servers with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>$con = Connect-HPEiLO 192.168.10.10,192.168.10.31 admin admin123 -DisableCertificateAuthentication $out = $con | Set-HPEiLODirectorySetting -LDAPDirectoryAuthentication DirectoryDefaultSchema -LocalUserAccountEnabled Yes -GenericLDAPEnabled Yes -DirectoryServerAddress "192.168.1.1" -DirectoryServerPort 638 -UserContext "CN=Users2,DC=Powershvpn2,DC=Com" -UserContextIndex 1</dev:code> <dev:remarks> <maml:para>This cmdlet sets the directory setting on iLO5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLODirectorySetting</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>Set-HPEiLOEncryptionSetting</command:name> <maml:description> <maml:para>Sets the security encryption setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOEncryptionSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOEncryptionSetting cmdlet sets the security encryption settings.</maml:para> <maml:para>WARNING: All active connections (including Remote Console and Virtual Media sessions) to the iLO device are dropped immediately when this cmdlet executes. Running Set-HPEiLOEncryptionSetting will reset iLO to defaults,clearing all user and license data. The username and password will be reset.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOEncryptionSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SecurityState</maml:name> <maml:description> <maml:para>The security level of the Encryption setting. The possible values are Production, HighSecurity, FIPS, CNSA, and SuiteB. • HighSecurity: iLO is operating in high security mode, requiring extra authentication on host interface(s), and stronger encryption on network interfaces. • FIPS: Same as High Security. This mode is intended to meet the FIPS 140-2 level 1 and Common Criteria security requirements. A reset to factory defaults is required to exit this mode. • Production: iLO is operating in a security mode. Default state for customer systems. • CNSA: Same as FIPS. Additionally meets the criteria for NSA Commercial National Security Algorithm suite. Must be in FIPS mode to transition to CNSA. • SuiteB: Same as FIPS. Additionally meets the criteria for NSA SuiteB Top Secret installations. Must be in FIPS mode to transition to SuiteB. • SynergySecurityMode: It is the mode supported by the Synergy Composer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Production</command:parameterValue> <command:parameterValue required="false" variableLength="false">HighSecurity</command:parameterValue> <command:parameterValue required="false" variableLength="false">FIPS</command:parameterValue> <command:parameterValue required="false" variableLength="false">CNSA</command:parameterValue> <command:parameterValue required="false" variableLength="false">SuiteB</command:parameterValue> <command:parameterValue required="false" variableLength="false">SynergySecurityMode</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SecurityState</maml:name> <maml:description> <maml:para>The security level of the Encryption setting. The possible values are Production, HighSecurity, FIPS, CNSA, and SuiteB. • HighSecurity: iLO is operating in high security mode, requiring extra authentication on host interface(s), and stronger encryption on network interfaces. • FIPS: Same as High Security. This mode is intended to meet the FIPS 140-2 level 1 and Common Criteria security requirements. A reset to factory defaults is required to exit this mode. • Production: iLO is operating in a security mode. Default state for customer systems. • CNSA: Same as FIPS. Additionally meets the criteria for NSA Commercial National Security Algorithm suite. Must be in FIPS mode to transition to CNSA. • SuiteB: Same as FIPS. Additionally meets the criteria for NSA SuiteB Top Secret installations. Must be in FIPS mode to transition to SuiteB. • SynergySecurityMode: It is the mode supported by the Synergy Composer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Production</command:parameterValue> <command:parameterValue required="false" variableLength="false">HighSecurity</command:parameterValue> <command:parameterValue required="false" variableLength="false">FIPS</command:parameterValue> <command:parameterValue required="false" variableLength="false">CNSA</command:parameterValue> <command:parameterValue required="false" variableLength="false">SuiteB</command:parameterValue> <command:parameterValue required="false" variableLength="false">SynergySecurityMode</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>• To disable FIPS security state, use the Set-HPEiLOFactoryDefault cmdlet. • Enabling FIPS mode resets critical iLO security settings to the factory default values, clears all user data, and erases the iLO Event Log and the Integrated Management Log. • For information regarding LicenseKey that is required for each SecurityState, refer to the HPE iLO licensing guide.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOEncryptionSetting -SecurityState FIPS</dev:code> <dev:remarks> <maml:para>This cmdlet sets SecurityState on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOEncryptionSetting -SecurityState Production</dev:code> <dev:remarks> <maml:para>This cmdlet sets SecurityState on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEiLOEncryptionSetting -Connection $connection -SecurityState FIPS</dev:code> <dev:remarks> <maml:para>This cmdlet sets SecurityState on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOFactoryDefault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOEncryptionSetting</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>Set-HPEiLOESKMSetting</command:name> <maml:description> <maml:para>Sets the communication setting for the Enterprise Secure Key Manager (ESKM) in iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOESKMSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set-HPEiLOESKMSetting is updated in the iLO navigation of administration. When the server’s operating system starts up, iLO will check whether a key exists in the ESKM Primary Server or ESKM Secondary Server. If a key is present, an SSH hand shake occurs and iLO allows the operating system to completely boot.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet" default="true"> <!--NAME: UsernamePasswordSet--> <!--TAG: DEFAULT--> <maml:name>Set-HPEiLOESKMSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMUsername</maml:name> <maml:description> <maml:para>Specifies the ESKM admin username as a string or list of ESKMUsernames. It can be a single string or it can be a collection of ESKMUsernames in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMPassword</maml:name> <maml:description> <maml:para>Specifies the ESKM admin user password as a string or list of ESKMPasswords. It can be a single string or it can be a collection of ESKMPasswords in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMGroupName</maml:name> <maml:description> <maml:para>Specifies the ESKM group name as a string or list of group names under which the ESKM user needs to be added. It can be a single string or it can be a collection of group names in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EnableRedundancy</maml:name> <maml:description> <maml:para>Determines whether redundancy is enabled. Possible values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMCertName</maml:name> <maml:description> <maml:para>Specifies the ESKM certificate name as a string or list of ESKMCertNames under which the ESKM user needs to be added. It can be a single string or it can be a collection of ESKMCertNames in the form of a string array. NOTE: The default value of ESKMCertName is set to Local CA, therefore, including its default parameter is not necessary. However, ESKMCertName can be specified to accept a custom value at run time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMPrimaryServerAddress</maml:name> <maml:description> <maml:para>Specifies the ESKM primary server address as a string or list of addresses under which the ESKM user needs to be added. It can be a single string or it can be a collection of addresses in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMPrimaryServerPort</maml:name> <maml:description> <maml:para>Specifies the ESKM primary server port as a string or list of ports. It can be a single string or it can be a collection of ports in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMSecondaryServerAddress</maml:name> <maml:description> <maml:para>Specifies the ESKM secondary server as a string or list of addresses under which the ESKM user needs to be added. It can be a single string or it can be a collection of addresses in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMSecondaryServerPort</maml:name> <maml:description> <maml:para>Specifies the ESKM secondary server port as a string or list of ports. It can be a single string or it can be a collection of ports in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Set-HPEiLOESKMSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMCredential</maml:name> <maml:description> <maml:para>ESKMCredential object based on username and password to log onto the Key Manager Server. Credential should not be used along with ESKMUserLogin/ESKMPassword.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMGroupName</maml:name> <maml:description> <maml:para>Specifies the ESKM group name as a string or list of group names under which the ESKM user needs to be added. It can be a single string or it can be a collection of group names in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EnableRedundancy</maml:name> <maml:description> <maml:para>Determines whether redundancy is enabled. Possible values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMCertName</maml:name> <maml:description> <maml:para>Specifies the ESKM certificate name as a string or list of ESKMCertNames under which the ESKM user needs to be added. It can be a single string or it can be a collection of ESKMCertNames in the form of a string array. NOTE: The default value of ESKMCertName is set to Local CA, therefore, including its default parameter is not necessary. However, ESKMCertName can be specified to accept a custom value at run time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMPrimaryServerAddress</maml:name> <maml:description> <maml:para>Specifies the ESKM primary server address as a string or list of addresses under which the ESKM user needs to be added. It can be a single string or it can be a collection of addresses in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMPrimaryServerPort</maml:name> <maml:description> <maml:para>Specifies the ESKM primary server port as a string or list of ports. It can be a single string or it can be a collection of ports in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMSecondaryServerAddress</maml:name> <maml:description> <maml:para>Specifies the ESKM secondary server as a string or list of addresses under which the ESKM user needs to be added. It can be a single string or it can be a collection of addresses in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMSecondaryServerPort</maml:name> <maml:description> <maml:para>Specifies the ESKM secondary server port as a string or list of ports. It can be a single string or it can be a collection of ports in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMUsername</maml:name> <maml:description> <maml:para>Specifies the ESKM admin username as a string or list of ESKMUsernames. It can be a single string or it can be a collection of ESKMUsernames in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMPassword</maml:name> <maml:description> <maml:para>Specifies the ESKM admin user password as a string or list of ESKMPasswords. It can be a single string or it can be a collection of ESKMPasswords in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMGroupName</maml:name> <maml:description> <maml:para>Specifies the ESKM group name as a string or list of group names under which the ESKM user needs to be added. It can be a single string or it can be a collection of group names in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EnableRedundancy</maml:name> <maml:description> <maml:para>Determines whether redundancy is enabled. Possible values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMCertName</maml:name> <maml:description> <maml:para>Specifies the ESKM certificate name as a string or list of ESKMCertNames under which the ESKM user needs to be added. It can be a single string or it can be a collection of ESKMCertNames in the form of a string array. NOTE: The default value of ESKMCertName is set to Local CA, therefore, including its default parameter is not necessary. However, ESKMCertName can be specified to accept a custom value at run time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMPrimaryServerAddress</maml:name> <maml:description> <maml:para>Specifies the ESKM primary server address as a string or list of addresses under which the ESKM user needs to be added. It can be a single string or it can be a collection of addresses in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMPrimaryServerPort</maml:name> <maml:description> <maml:para>Specifies the ESKM primary server port as a string or list of ports. It can be a single string or it can be a collection of ports in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMSecondaryServerAddress</maml:name> <maml:description> <maml:para>Specifies the ESKM secondary server as a string or list of addresses under which the ESKM user needs to be added. It can be a single string or it can be a collection of addresses in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMSecondaryServerPort</maml:name> <maml:description> <maml:para>Specifies the ESKM secondary server port as a string or list of ports. It can be a single string or it can be a collection of ports in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ESKMCredential</maml:name> <maml:description> <maml:para>ESKMCredential object based on username and password to log onto the Key Manager Server. Credential should not be used along with ESKMUserLogin/ESKMPassword.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.Management.Automation.PSCredential[] System.Int32[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOESKMSetting -ESKMUsername gen10ilouser -ESKMPassword 12mfw*team -ESKMGroupName gen10ilogroup -EnableRedundancy Yes -ESKMCertName "Local CA" -ESKMPrimaryServerAddress 16.95.240.119 -ESKMPrimaryServerPort 9444 -ESKMSecondaryServerAddress 16.95.240.120 -ESKMSecondaryServerPort 9444</dev:code> <dev:remarks> <maml:para>This example shows the execution of cmdlet when UsernamePassword set is used to set ESKMUsername and ESKMPassword for iLO 4 or iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $credential = Get-Credential PS C:\> ,$connection | Set-HPEiLOESKMSetting -ESKMCredential $credential -ESKMGroupName gen10ilogroup -EnableRedundancy Yes -ESKMCertName "Local CA" -ESKMPrimaryServerAddress 16.95.240.119 -ESKMPrimaryServerPort 9444 -ESKMSecondaryServerAddress 16.95.240.120 -ESKMSecondaryServerPort 9444</dev:code> <dev:remarks> <maml:para>This example shows the execution of cmdlet when the credential set is used to set ESKMUsername and ESKMPassword for iLO 4 or iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> Set-HPEiLOESKMSetting -Connection $connection -ESKMUsername gen10ilouser -ESKMPassword 12mfw*team -ESKMGroupName gen10ilogroup -EnableRedundancy No -ESKMCertName "Local CA" -ESKMPrimaryServerAddress 16.95.240.119 -ESKMPrimaryServerPort 9444 -ESKMSecondaryServerAddress 16.95.240.120 -ESKMSecondaryServerPort 9444</dev:code> <dev:remarks> <maml:para>This cmdlet sets the ESKM settings of the iLO 4 and iLO 5, in which an array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOESKMSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOESKMLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-HPEiLOESKMConnection</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>Set-HPEiLOFactoryDefault</command:name> <maml:description> <maml:para>Sets the Integrated Lights-Out device to factory default settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOFactoryDefault</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOFactoryDefault cmdlet sets the iLO device to factory default settings.</maml:para> <maml:para>WARNING : Resetting an iLO device to factory defaults changes the DNS name to the default, and the iLO device can be accessed using only the default Administrator user account and default password. Without these defaults, iLO access must be reconfigured using the RBSU.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOFactoryDefault</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOFactoryDefault</dev:code> <dev:remarks> <maml:para>This cmdlet sets the iLO to factory default setting on iLO 4 or iLO 5 along with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEiLOFactoryDefault -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet sets the iLO to factory default setting on iLO 4 and iLO 5 along with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Set-HPEiLOFederationGroup</command:name> <maml:description> <maml:para>Modifies an existing iLO Federation group.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOFederationGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOFederationGroup cmdlet is used to modify existing iLO Federation group membership and the associated privileges.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOFederationGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>The iLO federation existing group name to be changed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewGroupName</maml:name> <maml:description> <maml:para>The new name for the federation group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewGroupKey</maml:name> <maml:description> <maml:para>The password to set for the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to add, edit, and delete iLO user accounts. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoteConsPriv"> <maml:name>RemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to remotely access the host system Remote Console, including video, keyboard, and mouse control. The supported values are Yes and No. Aliases : RemoteConsPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to use scripted Virtual Media with the local iLO system. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ConfigiLOPriv"> <maml:name>iLOConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure most iLO settings, including security settings, and to remotely update firmware. The supported values are Yes and No. Aliases : ConfigiLOPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure Host BIOS Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure Host NIC settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure Host Storage Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to log in to iLO. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure System Recovery Configuration Privilege. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ResetServerPriv"> <maml:name>VirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to power-cycle or reset the local iLO system. The supported values are Yes and No. Aliases : ResetServerPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>The iLO federation existing group name to be changed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewGroupName</maml:name> <maml:description> <maml:para>The new name for the federation group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewGroupKey</maml:name> <maml:description> <maml:para>The password to set for the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to add, edit, and delete iLO user accounts. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoteConsPriv"> <maml:name>RemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to remotely access the host system Remote Console, including video, keyboard, and mouse control. The supported values are Yes and No. Aliases : RemoteConsPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to use scripted Virtual Media with the local iLO system. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ConfigiLOPriv"> <maml:name>iLOConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure most iLO settings, including security settings, and to remotely update firmware. The supported values are Yes and No. Aliases : ConfigiLOPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure Host BIOS Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure Host NIC settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure Host Storage Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to log in to iLO. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to configure System Recovery Configuration Privilege. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ResetServerPriv"> <maml:name>VirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Enables or disables members of a group to power-cycle or reset the local iLO system. The supported values are Yes and No. Aliases : ResetServerPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOFederationGroup -GroupName testgroup -NewGroupName newtestgroup -NewGroupKey testgroup123 -UserConfigPrivilege Yes -RemoteConsolePrivilege Yes -VirtualMediaPrivilege Yes -iLOConfigPrivilege Yes -LoginPrivilege Yes -VirtualPowerAndResetPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet assigns a new group name to an exisiting federation group on iLO 4 along with various privileges with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOFederationGroup -GroupName testgroup -NewGroupName newtestgroup -NewGroupKey testgroup123 -UserConfigPrivilege Yes -RemoteConsolePrivilege Yes -VirtualMediaPrivilege Yes -iLOConfigPrivilege Yes -LoginPrivilege Yes -VirtualPowerAndResetPrivilege Yes -HostBIOSConfigPrivilege Yes -HostNICConfigPrivilege Yes -HostStorageConfigPrivilege Yes -SystemRecoveryConfigPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet assigns a new group name to an exisiting federation group on iLO 5 along with various privileges with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOFederationGroup -GroupName testgroup -NewGroupName newtestgroup -NewGroupKey testgroup123 -UserConfigPrivilege Yes -RemoteConsolePrivilege Yes -VirtualMediaPrivilege Yes -iLOConfigPrivilege Yes -LoginPrivilege Yes -VirtualPowerAndResetPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet assigns a new group name to exisiting federation groups on multiple iLO 4 IPs along with various Privileges with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOFederationGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOFederationGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOFederationGroup</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>Set-HPEiLOFederationMulticast</command:name> <maml:description> <maml:para>Enables iLO Federation and sets iLO Federation multicast operations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOFederationMulticast</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOFederationMulticast cmdlet enables or disables iLO Federation, and sets the iLO Federation multicast options, including Multicast Discovery, Multicast Announcement Interval, IPv6Multicast Scope, and Multicast TTL. The iLO Federation cmdlets get data from and send commands to one or more iLOs.</maml:para> <maml:para>While enabling this setting, you can also specify the features that you want the group to access. In the iLO Federation -> Group Configuration you can create your own group along with the group key (that is required for other iLOs to join the existing group as a security measure). On creation of the group, you can enable the multicast options: Group Account Privileges. These privilege settings can be used to deny or allow access to the following iLO features (group and individual iLO):</maml:para> <maml:para>• Administrator user Accounts • Remote Access Control • Virtual Power and Reset • Virtual Media • Configure iLO Settings • Login Privilege</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOFederationMulticast</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AnnouncementInterval</maml:name> <maml:description> <maml:para>Sets the number of seconds between each multicast availability announcement on the network. Valid values are Disabled, 30, 60, 120, 300, 600, 900, and 1800 seconds. When disabled, iLO Federation features are unavailable. When AnnouncementInterval is set to Disabled, then FederationAuthentication is set to No by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">30</command:parameterValue> <command:parameterValue required="false" variableLength="false">60</command:parameterValue> <command:parameterValue required="false" variableLength="false">120</command:parameterValue> <command:parameterValue required="false" variableLength="false">300</command:parameterValue> <command:parameterValue required="false" variableLength="false">600</command:parameterValue> <command:parameterValue required="false" variableLength="false">900</command:parameterValue> <command:parameterValue required="false" variableLength="false">1800</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DiscoveryAuthentication</maml:name> <maml:description> <maml:para>Enables or disables iLO Discovery Authentication. The possible values are Yes and No. This parameter is mandatory. When set to No, other parameters cannot be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FederationManagement</maml:name> <maml:description> <maml:para>Enables or disables iLO Federation Management. The possible values are Enabled and Disabled. To set FederationManagement, set AnnouncementInterval to a value other than Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MulticastScope</maml:name> <maml:description> <maml:para>Sets the scope of multicast discovery. Valid values are Link, Site, and Organization. All devices in an iLO Federation group must have the same scope to properly enable peer discovery.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Site</command:parameterValue> <command:parameterValue required="false" variableLength="false">Link</command:parameterValue> <command:parameterValue required="false" variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MulticastTTL</maml:name> <maml:description> <maml:para>Sets the time to live, limiting the number of switches that can be traversed before the multicast discovery is stopped. Valid values are between 1 and 255. All devices in a federated group must have the same TTL to properly enable peer discovery.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AnnouncementInterval</maml:name> <maml:description> <maml:para>Sets the number of seconds between each multicast availability announcement on the network. Valid values are Disabled, 30, 60, 120, 300, 600, 900, and 1800 seconds. When disabled, iLO Federation features are unavailable. When AnnouncementInterval is set to Disabled, then FederationAuthentication is set to No by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">30</command:parameterValue> <command:parameterValue required="false" variableLength="false">60</command:parameterValue> <command:parameterValue required="false" variableLength="false">120</command:parameterValue> <command:parameterValue required="false" variableLength="false">300</command:parameterValue> <command:parameterValue required="false" variableLength="false">600</command:parameterValue> <command:parameterValue required="false" variableLength="false">900</command:parameterValue> <command:parameterValue required="false" variableLength="false">1800</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DiscoveryAuthentication</maml:name> <maml:description> <maml:para>Enables or disables iLO Discovery Authentication. The possible values are Yes and No. This parameter is mandatory. When set to No, other parameters cannot be used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FederationManagement</maml:name> <maml:description> <maml:para>Enables or disables iLO Federation Management. The possible values are Enabled and Disabled. To set FederationManagement, set AnnouncementInterval to a value other than Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MulticastScope</maml:name> <maml:description> <maml:para>Sets the scope of multicast discovery. Valid values are Link, Site, and Organization. All devices in an iLO Federation group must have the same scope to properly enable peer discovery.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Site</command:parameterValue> <command:parameterValue required="false" variableLength="false">Link</command:parameterValue> <command:parameterValue required="false" variableLength="false">Organization</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MulticastTTL</maml:name> <maml:description> <maml:para>Sets the time to live, limiting the number of switches that can be traversed before the multicast discovery is stopped. Valid values are between 1 and 255. All devices in a federated group must have the same TTL to properly enable peer discovery.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOFederationMulticast -AnnouncementInterval 120 -DiscoveryAuthentication Yes -FederationManagement Disabled -MulticastScope Link -MulticastTTL 200</dev:code> <dev:remarks> <maml:para>This cmdlet sets iLO Federation multicast operations on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEiLOFederationMulticast -Connection $connection -AnnouncementInterval 120 -DiscoveryAuthentication Yes -FederationManagement Enabled -MulticastScope Site -MulticastTTL 200</dev:code> <dev:remarks> <maml:para>This cmdlet sets iLO Federation multicast operations on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOFederationMulticast -AnnouncementInterval 120 -DiscoveryAuthentication Yes -FederationManagement Enabled -MulticastScope Site -MulticastTTL 200</dev:code> <dev:remarks> <maml:para>This cmdlet sets iLO Federation multicast operations on iLO 4 and iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOFederationMulticast</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>Set-HPEiLOFirmwarePolicy</command:name> <maml:description> <maml:para>Modifies the firmware downgrade policy settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOFirmwarePolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOFirmwarepolicy cmdlet modifies the firmware downgrade policy settings. This cmdlet is supported on iLO 5 servers only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOFirmwarePolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DowngradePolicy</maml:name> <maml:description> <maml:para>Restricts the firmware downgrade. The supported values are AllowDowngrade, RecoveryDowngrade, NoDowngrade. 1. AllowDowngrade- Downgrading firmware is allowed. 2. RecoveryDowngrade- Downgrading firmware is allowed by a user with the Recovery Set privilege. 3. NoDowngrade- Downgrading firmware is not allowed. This is a permanent setting and cannot be undone.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AllowDowngrade</command:parameterValue> <command:parameterValue required="false" variableLength="false">RecoveryDowngrade</command:parameterValue> <command:parameterValue required="false" variableLength="false">NoDowngrade</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DowngradePolicy</maml:name> <maml:description> <maml:para>Restricts the firmware downgrade. The supported values are AllowDowngrade, RecoveryDowngrade, NoDowngrade. 1. AllowDowngrade- Downgrading firmware is allowed. 2. RecoveryDowngrade- Downgrading firmware is allowed by a user with the Recovery Set privilege. 3. NoDowngrade- Downgrading firmware is not allowed. This is a permanent setting and cannot be undone.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AllowDowngrade</command:parameterValue> <command:parameterValue required="false" variableLength="false">RecoveryDowngrade</command:parameterValue> <command:parameterValue required="false" variableLength="false">NoDowngrade</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOFirmwarePolicy -DowngradePollicy AllowDowngrade</dev:code> <dev:remarks> <maml:para>This command shows the output on iLO 5 and connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> Set-HPEiLOFirmwarePolicy -Connection $connection -DowngradePollicy AllowDowngrade</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 when array of connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOFirmwarePolicy</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>Set-HPEiLOFirmwareVerificationScanSetting</command:name> <maml:description> <maml:para>Modifies the firmware verification scan setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOFirmwareVerificationScanSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOFirmwareVerificationScanSetting cmdlet modifies the firmware verification scan setting. This cmdlet is supported only in iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOFirmwareVerificationScanSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BackgroundScanEnabled</maml:name> <maml:description> <maml:para>Enables or disables Firmware Verification scanning. When enabled, iLO scans the supported installed firmware for file corruption.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntegrityFailureAction</maml:name> <maml:description> <maml:para>Determines the action iLO takes when a problem is found during a Firmware Verification scan. . To log the results, select LogOnly. . To log the results and initiate a repair action, select LogAndRepairAutomatically. If a problem is detected for a supported firmware type, iLO checks for the affected firmware type in a protected install set. By default, this set is the Recovery Set. If a firmware image is available, iLO flashes that firmware image to complete the repair.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">LogOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">LogAndRepairAutomatically</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ScanInterval</maml:name> <maml:description> <maml:para>Sets the background scan frequency in days. Valid values are from 1 to 365.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BackgroundScanEnabled</maml:name> <maml:description> <maml:para>Enables or disables Firmware Verification scanning. When enabled, iLO scans the supported installed firmware for file corruption.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntegrityFailureAction</maml:name> <maml:description> <maml:para>Determines the action iLO takes when a problem is found during a Firmware Verification scan. . To log the results, select LogOnly. . To log the results and initiate a repair action, select LogAndRepairAutomatically. If a problem is detected for a supported firmware type, iLO checks for the affected firmware type in a protected install set. By default, this set is the Recovery Set. If a firmware image is available, iLO flashes that firmware image to complete the repair.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">LogOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">LogAndRepairAutomatically</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ScanInterval</maml:name> <maml:description> <maml:para>Sets the background scan frequency in days. Valid values are from 1 to 365.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.UInt32[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOFirmwareVerificationScanSetting -BackgroundScanEnabled Yes -IntegrityFailureAction LogAndRepairAutomatically -ScanInterval 10</dev:code> <dev:remarks> <maml:para>This command shows the output on iLO 5 and connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> Set-HPEiLOFirmwareVerificationScanSetting -Connection $connection -BackgroundScanEnabled Yes -IntegrityFailureAction LogAndRepairAutomatically -ScanInterval 10</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 when array of connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOFirmwareVerificationScanSetting</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>Set-HPEiLOHotKeyConfig</command:name> <maml:description> <maml:para>Configures the remote console hot key settings in iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOHotKeyConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOHotKeyConfig cmdlet configures the remote console hot key settings in iLO. The command enables you to define up to six different sets of hot keys for use during a Remote Console session. Each hot key represents a combination of up to five different keys which are sent to the host machine whenever the hot key is pressed during a Remote Console session. The selected key combination (all keys pressed at the same time) are transmitted in its place. The following is the list of keys available to combine in a Remote Console hot key sequence.</maml:para> <maml:para>Supported hot keys: ESC L_ALT R_ALT L_SHIFT R_SHIFT L_CTRL R_CTRL L_GUI R_GUI INS DEL HOME END PG UP PG DN ENTER TAB BREAK BACKSPACE NUM PLUS NUM MINUS SCRL LCK SYS RQ F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 SPACE ' , - . / 0 1 2 3 4 5 6 7 8 9 ; = [ \ ] ` a b c d e f g h i j k l m n o p q r s t u v w x y z ; L_CTRL R_CTRL NUM MINUS NUM PLUS SCRL LCK BACKSPACE PRINT SCRN SYS RQ 1 2 3 4 5 6 7 8 9 0 NONE L_GUI R_GUI</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOHotKeyConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CtrlT</maml:name> <maml:description> <maml:para>Separated multiple setting values with commas. The parameter's value is optional. If a parameter is not specified, then the parameter value remains as previously set. The hot key can have up to five selections (for example, CTRL_T="L_CTRL,L_ALT,ESC,F2,F4"). Do not use spaces (“ “) in the values; to set a space in a value, type SPACE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CtrlU</maml:name> <maml:description> <maml:para>Separated multiple setting values with commas. The parameter's value is optional. If a parameter is not specified, then the parameter value remains as previously set. The hot key can have up to five selections (for example, CTRL_T="L_CTRL,L_ALT,ESC,F2,F4"). Do not use spaces (“ “) in the values; to set a space in a value, type SPACE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CtrlV</maml:name> <maml:description> <maml:para>Separated multiple setting values with commas. The parameter's value is optional. If a parameter is not specified, then the parameter value remains as previously set. The hot key can have up to five selections (for example, CTRL_T="L_CTRL,L_ALT,ESC,F2,F4"). Do not use spaces (“ “) in the values; to set a space in a value, type SPACE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CtrlW</maml:name> <maml:description> <maml:para>Separated multiple setting values with commas. The parameter's value is optional. If a parameter is not specified, then the parameter value remains as previously set. The hot key can have up to five selections (for example, CTRL_T="L_CTRL,L_ALT,ESC,F2,F4"). Do not use spaces (“ “) in the values; to set a space in a value, type SPACE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CtrlX</maml:name> <maml:description> <maml:para>Separated multiple setting values with commas. The parameter's value is optional. If a parameter is not specified, then the parameter value remains as previously set. The hot key can have up to five selections (for example, CTRL_T="L_CTRL,L_ALT,ESC,F2,F4"). Do not use spaces (“ “) in the values; to set a space in a value, type SPACE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CtrlY</maml:name> <maml:description> <maml:para>Separated multiple setting values with commas. The parameter's value is optional. If a parameter is not specified, then the parameter value remains as previously set. The hot key can have up to five selections (for example, CTRL_T="L_CTRL,L_ALT,ESC,F2,F4"). Do not use spaces (“ “) in the values; to set a space in a value, type SPACE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CtrlT</maml:name> <maml:description> <maml:para>Separated multiple setting values with commas. The parameter's value is optional. If a parameter is not specified, then the parameter value remains as previously set. The hot key can have up to five selections (for example, CTRL_T="L_CTRL,L_ALT,ESC,F2,F4"). Do not use spaces (“ “) in the values; to set a space in a value, type SPACE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CtrlU</maml:name> <maml:description> <maml:para>Separated multiple setting values with commas. The parameter's value is optional. If a parameter is not specified, then the parameter value remains as previously set. The hot key can have up to five selections (for example, CTRL_T="L_CTRL,L_ALT,ESC,F2,F4"). Do not use spaces (“ “) in the values; to set a space in a value, type SPACE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CtrlV</maml:name> <maml:description> <maml:para>Separated multiple setting values with commas. The parameter's value is optional. If a parameter is not specified, then the parameter value remains as previously set. The hot key can have up to five selections (for example, CTRL_T="L_CTRL,L_ALT,ESC,F2,F4"). Do not use spaces (“ “) in the values; to set a space in a value, type SPACE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CtrlW</maml:name> <maml:description> <maml:para>Separated multiple setting values with commas. The parameter's value is optional. If a parameter is not specified, then the parameter value remains as previously set. The hot key can have up to five selections (for example, CTRL_T="L_CTRL,L_ALT,ESC,F2,F4"). Do not use spaces (“ “) in the values; to set a space in a value, type SPACE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CtrlX</maml:name> <maml:description> <maml:para>Separated multiple setting values with commas. The parameter's value is optional. If a parameter is not specified, then the parameter value remains as previously set. The hot key can have up to five selections (for example, CTRL_T="L_CTRL,L_ALT,ESC,F2,F4"). Do not use spaces (“ “) in the values; to set a space in a value, type SPACE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CtrlY</maml:name> <maml:description> <maml:para>Separated multiple setting values with commas. The parameter's value is optional. If a parameter is not specified, then the parameter value remains as previously set. The hot key can have up to five selections (for example, CTRL_T="L_CTRL,L_ALT,ESC,F2,F4"). Do not use spaces (“ “) in the values; to set a space in a value, type SPACE.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[][]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $key1 = ,@("L_ALT","L_CTRL") PS C:\> $key2 = ,@("L_CTRL,L_ALT,ESC,F2,F4") PS C:\> ,$connection | Set-HPEiLOHotKeyConfig -CtrlT $key1 -CtrlU $key2</dev:code> <dev:remarks> <maml:para>This command shows the output on iLO 4 or iLO 5 and the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41,10.20.30.42 -Username admin -Password admin123 PS C:\> $key1 = ,@("L_ALT","L_CTRL") PS C:\> $key2 = ,@("L_CTRL,L_ALT,ESC,F2,F4") PS C:\> Set-HPEiLOHotKeyConfig -Connection $connection -CtrlT $key1 -CtrlU $key2</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 when an array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOHotKeyConfig</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>Set-HPEiLOIntegratedRemoteConsoleTrustSetting</command:name> <maml:description> <maml:para>Sets Integrated Remote Console (IRC) Trust settings of iLO 5.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOIntegratedRemoteConsoleTrustSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modifies Integrated Remote Console (IRC) Trust settings of iLO 5.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOIntegratedRemoteConsoleTrustSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TrustedCertificateRequired</maml:name> <maml:description> <maml:para>This parameter takes Yes or No as input and sets the IRC settings requirement of trusted certificate required option. Only works on iLO 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TrustedCertificateRequired</maml:name> <maml:description> <maml:para>This parameter takes Yes or No as input and sets the IRC settings requirement of trusted certificate required option. Only works on iLO 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:> $con | Set-HPEiLOIntegratedRemoteConsoleSetting -TrustedCertificateRequired Yes</dev:code> <dev:remarks> <maml:para>The TrustedCertificateRequired parameter can be changed in IRC settings</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOIntegratedRemoteConsoleTrustSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</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>Set-HPEiLOIPv4NetworkSetting</command:name> <maml:description> <maml:para>Modifies the IPv4 network setting of the host server corresponding to iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOIPv4NetworkSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOIPv4NetworkSetting cmdlet modifies the iLO IPv4 network settings. The iLO scripting firmware does not attempt to decipher if the network modifications are appropriate for the network environment. When modifying network settings, be aware of the network commands provided to the management processor. In some cases, the management processor ignores commands and no error is returned.</maml:para> <maml:para>For example, when a script includes the command to enable DHCP and a command to modify the IP address, the IP address is ignored. Changing the network settings to values that are not correct for the network environment could cause a loss of connectivity to iLO.</maml:para> <maml:para>If connectivity to iLO is lost, use the RBSU to reconfigure the network settings to values that are compatible with the network environment.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOIPv4NetworkSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>InterfaceType specifies the type of network connection present in the manager. The possible values are Dedicated and Shared. The following parameters are not supported for InterfaceType - Dedicated: • SharedNetworkPortType • SNPPort • VLANEnabled • VLANID The following parameters are not supported for InterfaceType - Shared: • FullDuplex • LinkSpeedMbps NOTE: InterfaceType Shared is not supported on BL servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dedicated</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shared</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SharedNetworkPortType</maml:name> <maml:description> <maml:para>Sets the Shared Network Port value. The values are LOM or FlexibleLOM. For iLO, the Shared Network Port feature is only available on servers with hardware, NIC firmware, and iLO firmware that supports this feature.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">LOM</command:parameterValue> <command:parameterValue required="false" variableLength="false">FlexibleLOM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNPPort</maml:name> <maml:description> <maml:para>The network adapter port number that is used for sharing. This feature is only applicable on systems and network adapters that support it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">1</command:parameterValue> <command:parameterValue required="false" variableLength="false">2</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VLANEnabled</maml:name> <maml:description> <maml:para>Enables or disables Virtual LAN. Possible values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VLANID</maml:name> <maml:description> <maml:para>Indicates the VLAN identifier for the corresponding VLAN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DNSName</maml:name> <maml:description> <maml:para>Specifies the DNS name for iLO. If an empty string is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name for the network where iLO resides. If an empty string is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NICEnabled</maml:name> <maml:description> <maml:para>Enables the NIC to reflect the state of iLO. The values are Yes to enable NIC or No to disable NIC.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FullDuplex</maml:name> <maml:description> <maml:para>Decides if iLO is to support full-duplex or half-duplex mode. It is only applicable if LinkSpeedMbps was not set to Automatic. The possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LinkSpeedMbps</maml:name> <maml:description> <maml:para>The link speed of the Ethernet interface in megabits per second. This property can only be modified on a dedicated network port. It cannot be modified for blade servers. The accepted values are 10,100,1000,2500,5000 and Automatic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Automatic</command:parameterValue> <command:parameterValue required="false" variableLength="false">10</command:parameterValue> <command:parameterValue required="false" variableLength="false">100</command:parameterValue> <command:parameterValue required="false" variableLength="false">1000</command:parameterValue> <command:parameterValue required="false" variableLength="false">2500</command:parameterValue> <command:parameterValue required="false" variableLength="false">5000</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4Enabled</maml:name> <maml:description> <maml:para>Enables or disables the DHCP. The possible values are Yes for enabling DHCP and No for disabling DHCP.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4Gateway</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned gateway address is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4DomainName</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned Domain Name is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4DNSServer</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned DNS Server is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4WINSServer</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned WINS server is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4StaticRoute</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned Static Route is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4NTPServer</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned NTP Server is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>Selects the IP address for iLO if DHCP is not enabled. If an empty string or 0.0.0.0 is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4SubnetMask</maml:name> <maml:description> <maml:para>Selects the subnet mask for iLO if DHCP is not enabled. If an empty string or 0.0.0.0 is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4Gateway</maml:name> <maml:description> <maml:para>Selects the default gateway IP address for iLO if DHCP is not enabled. If an empty string or 0.0.0.0 is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4StaticRouteIndex</maml:name> <maml:description> <maml:para>The index of the IPv4 static route that needs to be set. This parameter accepts an array of integers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[][]</command:parameterValue> <dev:type> <maml:name>Int32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4StaticRouteDestination</maml:name> <maml:description> <maml:para>The IPv4 static route destination address. This parameter accpets an array of IPv4 addresses.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4StaticRouteMask</maml:name> <maml:description> <maml:para>The IPv4 static route mask address. This parameter accpets an array of IPv4 addresses.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4StaticRouteGateway</maml:name> <maml:description> <maml:para>The IPv4 static route gateway address. This parameter accpets an array of IPv4 addresses.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DNSServerType</maml:name> <maml:description> <maml:para>DNSServerType specifies the DNS server for which the IPv4 address needs to be set. The possible values are Primary,Secondary, and Tertiary. DNSServerType must be provided along with DNSServerValue with valid values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DNSServer</maml:name> <maml:description> <maml:para>Currently configured IPv4 DNS servers in order mentioned in DNSServerType. Static values when not configured to use DHCPv4-supplied DNS servers; otherwise this property is read-only indicating the values are provided by DHCPv4.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RegisterDDNSServer</maml:name> <maml:description> <maml:para>Determines DDNS Server registration. The supported values are Enabled or Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PingGateway</maml:name> <maml:description> <maml:para>Determines whether to ping the IPv4 gateway on startup. The supported values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RegisterWINSServer</maml:name> <maml:description> <maml:para>Determines WINS Server registration. The supported values are Enabled or Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WINSServerType</maml:name> <maml:description> <maml:para>WINSServerType specifies the WINS server for which the IPv4 address needs to be set. The possible values are Primary and Secondary. WINSServerType must be provided along with WINSServerValue with valid values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WINSServer</maml:name> <maml:description> <maml:para>Currently configured IPv4 WINS servers in order mentioned in WINSServerType. Static values when not configured to use DHCPv4-supplied WINS servers; otherwise this property is read-only indicating the values are provided by DHCPv4.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLONICAutoDelay</maml:name> <maml:description> <maml:para>Specifies the number of seconds to test each NIC connection before moving to the next while scanning. Valid values are 90 to 1800. If not specified, the delay will default to 90 seconds. This parameter is supported only on iLO 4 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLONICFailOver</maml:name> <maml:description> <maml:para>Configures NIC Fail-over feature. To enable this feature, iLONicAutoSelect tag must also be present and must be a value other than DISABLED. Valid values are: • DISABLED • LINKACT • RCVDATA • DHCP This parameter is supported only on iLO 4 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">LINKACT</command:parameterValue> <command:parameterValue required="false" variableLength="false">RCVDATA</command:parameterValue> <command:parameterValue required="false" variableLength="false">DHCP</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLONICFailOverDelay</maml:name> <maml:description> <maml:para>Specifies the number of seconds to monitor each NIC connection before considering the connection as failed and switching to the next NIC. Valid values are 30 to 3600. If not specified, the delay will default to 300 seconds. This parameter is supported only on iLO 4 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLONICAutoSelect</maml:name> <maml:description> <maml:para>Allows iLO to automatically select between either the shared or dedicated network ports at startup. The feature looks for network activity on the ports, and the first port found with network activity is selected for use. Any changes to this setting do not take effect until the iLO is reset. Possible values are: • DISABLED • LINKACT • RCVDATA • DHCP This parameter is supported only on iLO 4 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">LINKACT</command:parameterValue> <command:parameterValue required="false" variableLength="false">RCVDATA</command:parameterValue> <command:parameterValue required="false" variableLength="false">DHCP</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLONICAutoSNPScan</maml:name> <maml:description> <maml:para>Scans multiple SNP ports during NIC auto-selection when supported by hardware. Valid values are 0 and 2. When the value is set to 0, iLO scans currently configured SNP port. When the value is set to 2, iLO scans the SNP ports 1 and 2. This parameter is supported only in iLO 4 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">0</command:parameterValue> <command:parameterValue required="false" variableLength="false">2</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>InterfaceType specifies the type of network connection present in the manager. The possible values are Dedicated and Shared. The following parameters are not supported for InterfaceType - Dedicated: • SharedNetworkPortType • SNPPort • VLANEnabled • VLANID The following parameters are not supported for InterfaceType - Shared: • FullDuplex • LinkSpeedMbps NOTE: InterfaceType Shared is not supported on BL servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dedicated</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shared</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SharedNetworkPortType</maml:name> <maml:description> <maml:para>Sets the Shared Network Port value. The values are LOM or FlexibleLOM. For iLO, the Shared Network Port feature is only available on servers with hardware, NIC firmware, and iLO firmware that supports this feature.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">LOM</command:parameterValue> <command:parameterValue required="false" variableLength="false">FlexibleLOM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNPPort</maml:name> <maml:description> <maml:para>The network adapter port number that is used for sharing. This feature is only applicable on systems and network adapters that support it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">1</command:parameterValue> <command:parameterValue required="false" variableLength="false">2</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VLANEnabled</maml:name> <maml:description> <maml:para>Enables or disables Virtual LAN. Possible values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VLANID</maml:name> <maml:description> <maml:para>Indicates the VLAN identifier for the corresponding VLAN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DNSName</maml:name> <maml:description> <maml:para>Specifies the DNS name for iLO. If an empty string is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name for the network where iLO resides. If an empty string is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NICEnabled</maml:name> <maml:description> <maml:para>Enables the NIC to reflect the state of iLO. The values are Yes to enable NIC or No to disable NIC.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FullDuplex</maml:name> <maml:description> <maml:para>Decides if iLO is to support full-duplex or half-duplex mode. It is only applicable if LinkSpeedMbps was not set to Automatic. The possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LinkSpeedMbps</maml:name> <maml:description> <maml:para>The link speed of the Ethernet interface in megabits per second. This property can only be modified on a dedicated network port. It cannot be modified for blade servers. The accepted values are 10,100,1000,2500,5000 and Automatic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Automatic</command:parameterValue> <command:parameterValue required="false" variableLength="false">10</command:parameterValue> <command:parameterValue required="false" variableLength="false">100</command:parameterValue> <command:parameterValue required="false" variableLength="false">1000</command:parameterValue> <command:parameterValue required="false" variableLength="false">2500</command:parameterValue> <command:parameterValue required="false" variableLength="false">5000</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4Enabled</maml:name> <maml:description> <maml:para>Enables or disables the DHCP. The possible values are Yes for enabling DHCP and No for disabling DHCP.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4Gateway</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned gateway address is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4DomainName</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned Domain Name is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4DNSServer</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned DNS Server is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4WINSServer</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned WINS server is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4StaticRoute</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned Static Route is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4NTPServer</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned NTP Server is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>Selects the IP address for iLO if DHCP is not enabled. If an empty string or 0.0.0.0 is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4SubnetMask</maml:name> <maml:description> <maml:para>Selects the subnet mask for iLO if DHCP is not enabled. If an empty string or 0.0.0.0 is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4Gateway</maml:name> <maml:description> <maml:para>Selects the default gateway IP address for iLO if DHCP is not enabled. If an empty string or 0.0.0.0 is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4StaticRouteIndex</maml:name> <maml:description> <maml:para>The index of the IPv4 static route that needs to be set. This parameter accepts an array of integers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[][]</command:parameterValue> <dev:type> <maml:name>Int32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4StaticRouteDestination</maml:name> <maml:description> <maml:para>The IPv4 static route destination address. This parameter accpets an array of IPv4 addresses.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4StaticRouteMask</maml:name> <maml:description> <maml:para>The IPv4 static route mask address. This parameter accpets an array of IPv4 addresses.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv4StaticRouteGateway</maml:name> <maml:description> <maml:para>The IPv4 static route gateway address. This parameter accpets an array of IPv4 addresses.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DNSServerType</maml:name> <maml:description> <maml:para>DNSServerType specifies the DNS server for which the IPv4 address needs to be set. The possible values are Primary,Secondary, and Tertiary. DNSServerType must be provided along with DNSServerValue with valid values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DNSServer</maml:name> <maml:description> <maml:para>Currently configured IPv4 DNS servers in order mentioned in DNSServerType. Static values when not configured to use DHCPv4-supplied DNS servers; otherwise this property is read-only indicating the values are provided by DHCPv4.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RegisterDDNSServer</maml:name> <maml:description> <maml:para>Determines DDNS Server registration. The supported values are Enabled or Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PingGateway</maml:name> <maml:description> <maml:para>Determines whether to ping the IPv4 gateway on startup. The supported values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RegisterWINSServer</maml:name> <maml:description> <maml:para>Determines WINS Server registration. The supported values are Enabled or Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WINSServerType</maml:name> <maml:description> <maml:para>WINSServerType specifies the WINS server for which the IPv4 address needs to be set. The possible values are Primary and Secondary. WINSServerType must be provided along with WINSServerValue with valid values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WINSServer</maml:name> <maml:description> <maml:para>Currently configured IPv4 WINS servers in order mentioned in WINSServerType. Static values when not configured to use DHCPv4-supplied WINS servers; otherwise this property is read-only indicating the values are provided by DHCPv4.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLONICAutoDelay</maml:name> <maml:description> <maml:para>Specifies the number of seconds to test each NIC connection before moving to the next while scanning. Valid values are 90 to 1800. If not specified, the delay will default to 90 seconds. This parameter is supported only on iLO 4 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLONICFailOver</maml:name> <maml:description> <maml:para>Configures NIC Fail-over feature. To enable this feature, iLONicAutoSelect tag must also be present and must be a value other than DISABLED. Valid values are: • DISABLED • LINKACT • RCVDATA • DHCP This parameter is supported only on iLO 4 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">LINKACT</command:parameterValue> <command:parameterValue required="false" variableLength="false">RCVDATA</command:parameterValue> <command:parameterValue required="false" variableLength="false">DHCP</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLONICFailOverDelay</maml:name> <maml:description> <maml:para>Specifies the number of seconds to monitor each NIC connection before considering the connection as failed and switching to the next NIC. Valid values are 30 to 3600. If not specified, the delay will default to 300 seconds. This parameter is supported only on iLO 4 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLONICAutoSelect</maml:name> <maml:description> <maml:para>Allows iLO to automatically select between either the shared or dedicated network ports at startup. The feature looks for network activity on the ports, and the first port found with network activity is selected for use. Any changes to this setting do not take effect until the iLO is reset. Possible values are: • DISABLED • LINKACT • RCVDATA • DHCP This parameter is supported only on iLO 4 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">LINKACT</command:parameterValue> <command:parameterValue required="false" variableLength="false">RCVDATA</command:parameterValue> <command:parameterValue required="false" variableLength="false">DHCP</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLONICAutoSNPScan</maml:name> <maml:description> <maml:para>Scans multiple SNP ports during NIC auto-selection when supported by hardware. Valid values are 0 and 2. When the value is set to 0, iLO scans currently configured SNP port. When the value is set to 2, iLO scans the SNP ports 1 and 2. This parameter is supported only in iLO 4 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">0</command:parameterValue> <command:parameterValue required="false" variableLength="false">2</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.Int32[] System.Int32[][] System.String[][]</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>In case of an error or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>• In case of iLO 4 servers, when the script has successfully completed, the iLO management processor reboots to apply the changes. It is recommended to wait until the reset is successful before executing any cmdlet further. • In case of iLO 5 servers, you must reset the iLO to successfully apply the setting.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOIPv4NetworkSetting -InterfaceType Dedicated -DHCPv4Enabled No -IPv4Address 1.1.1.1 -IPv4Gateway 2.2.2.2 -IPv4SubnetMask 3.3.3.3 -DNSName testDNS -DomainName abcd.com -NICEnabled Yes -FullDuplex Enabled -LinkSpeedMbps 100</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of the IPV4 network settings for iLO 4 or iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $gateway = ,@("1.1.1.1","") $dest = ,@("2.2.2.2","") $mask = ,@("3.3.3.3","") $index = ,@(2,1) $dnstype = ,@("Primary","Tertiary") $dnsserver = ,@("4.4.4.4","") $dnstype = ,@("Primary","Tertiary") $dnsserver = ,@("5.5.5.5","") PS C:\> ,$connection | Set-HPEiLOIPv4NetworkSetting -InterfaceType Dedicated -IPv4StaticRouteIndex $index -IPv4StaticRouteDestination $dest -IPv4SubnetMask $mask -IPv4Gateway $gateway -DNSServerType $dnstype -DNSServer $dnsserver -WINSServerType $winstype -WINSServer $winsserver</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of the IPV4 network settings for iLO 4 or iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOIPv4NetworkSetting -InterfaceType Shared -SharedNetworkPortType LOM -SNPPort 1 -VLANEnabled Enabled -VLANID 2</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of the IPV4 network settings for iLO 4 or iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEiLOIPv4NetworkSetting -Connection $connection -InterfaceType Dedicated -DHCPv4Enabled Yes -DHCPv4Gateway Enabled -DHCPv4DomainName Enabled -DHCPv4DNSServer Disabled -DHCPv4WINSServer Enabled -DHCPv4StaticRoute Enabled -DHCPv4NTPServer Disabled</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of the IPV4 network settings for iLO 4 and iLO 5, in which the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOIPv4NetworkSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Set-HPEiLOIPv6NetworkSetting</command:name> <maml:description> <maml:para>Modifies the IPv6 network setting of the host server corresponding to iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOIPv6NetworkSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOIPv6NetworkSetting cmdlet modifies IPv6 network settings. You must have the Configure iLO Settings privilege to execute This cmdlet. The iLO scripting firmware does not attempt to decipher if the network modifications are appropriate for the network environment. When modifying network settings, be aware of the network commands provided to the management processor. In some cases, the management processor ignores commands and no error is returned. For example, when a script includes the command to enable DHCP and a command to modify the IPv6 address, the IPv6 address is ignored. Changing the network settings to values that are not correct for the network environment could cause a loss of connectivity to iLO. When the script has successfully completed, the iLO management processor reboots to apply the changes. If connectivity to iLO is lost, use the RBSU to reconfigure the network settings to values that are compatible with the network environment. Only Server, Username, and Password will be prompted for if not provided. If parameter values are not provided, they remain unchanged. A list of servers (with or without port number) and corresponding username/password or credential values must be provided as parameters.</maml:para> <maml:para>NOTE: For the Static IPv6 Address settings, all the addresses from 1 to 4 should be provided with correct values, otherwise, the unspecified addresses will be deleted by default. For example, if only address 3 is provided with valid values and other addresses are not specified, the current settings of address1, address2, and address4 will be deleted.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOIPv6NetworkSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>InterfaceType specifies the type of network connection present in the manager. The possible values are Dedicated and Shared.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dedicated</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shared</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SharedNetworkPortType</maml:name> <maml:description> <maml:para>Sets the Shared Network Port value. The values are LOM or FlexibleLOM. For iLO, the Shared Network Port feature is only available on servers with hardware, NIC firmware, and iLO firmware that supports this feature.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">LOM</command:parameterValue> <command:parameterValue required="false" variableLength="false">FlexibleLOM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNPPort</maml:name> <maml:description> <maml:para>The network adapter port number that is used for sharing. This feature is only applicable on systems and network adapters that support it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">1</command:parameterValue> <command:parameterValue required="false" variableLength="false">2</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VLANEnabled</maml:name> <maml:description> <maml:para>Enables or disables Virtual LAN. Possible values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VLANID</maml:name> <maml:description> <maml:para>Indicates the VLAN identifier for the corresponding VLAN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DNSName</maml:name> <maml:description> <maml:para>Specifies the DNS name for iLO. If an empty string is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name for the network where iLO resides. If an empty string is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NICEnabled</maml:name> <maml:description> <maml:para>Enables the NIC to reflect the state of iLO. The values are Yes to enable NIC or No to disable NIC.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FullDuplex</maml:name> <maml:description> <maml:para>Decides if iLO is to support full-duplex or half-duplex mode. It is only applicable if LinkSpeedMbps was not set to Automatic. The possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LinkSpeedMbps</maml:name> <maml:description> <maml:para>The link speed of the Ethernet interface in megabits per second. This property can only be modified on a dedicated network port. It cannot be modified for blade servers. The accepted values are 10,100,1000,2500,5000 and Automatic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Automatic</command:parameterValue> <command:parameterValue required="false" variableLength="false">10</command:parameterValue> <command:parameterValue required="false" variableLength="false">100</command:parameterValue> <command:parameterValue required="false" variableLength="false">1000</command:parameterValue> <command:parameterValue required="false" variableLength="false">2500</command:parameterValue> <command:parameterValue required="false" variableLength="false">5000</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6DNSServer</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned DNS server is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6SNTPSetting</maml:name> <maml:description> <maml:para>Determines whether iLO is to get the SNTP time servers and time zone from the DHCP server or whether the user enters that information manually. Possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6RapidCommit</maml:name> <maml:description> <maml:para>DHCPv6RapidCommit is used when DHCPv6Stateful is enabled. It providesa reduction in the amount of DHCPv6 network traffic needed to assign addresses, but should not be used if more than one DHCPv6 server is present in the network for the purpose of assigning addresses. DHCPv6 database errors may result if more than one server can assign iLO an IPv6 address and Rapid Commit mode is enabled. Possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6StatefulMode</maml:name> <maml:description> <maml:para>Determines whether DHCPv6 Stateful mode is enabled or disabled. The supported values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6StatelessMode</maml:name> <maml:description> <maml:para>Determines whether DHCPv6 Stateless mode is enabled or disabled. The supported values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6DomainName</maml:name> <maml:description> <maml:para>Determines whether to use a DHCPv6-supplied domain name. Can only be enabled when DHCPv6 Stateless mode is also enabled; otherwise, this property will be set to Disabled and will be read-only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6DefaultGateway</maml:name> <maml:description> <maml:para>The IPv6 static default gateway entry.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PreferredProtocol</maml:name> <maml:description> <maml:para>The possible values are Enabled and Disabled. If Enabled is selected, IPv6 addresses will be used when both IPv6 and IPv4 are available.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RegDDNSServer"> <maml:name>RegisterDDNSServer</maml:name> <maml:description> <maml:para>Instructs iLO to register the management port with a DDNS server. The possible values are Enabled to register the management port or Disabled to not register the management port with DNS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="AddressAutoCfg"> <maml:name>StatelessAddressAutoConfiguration</maml:name> <maml:description> <maml:para>Determines whether StateLess Address Auto-Configuration is enabled or disabled.The supported values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6StaticAddress</maml:name> <maml:description> <maml:para>Specifies the list of IPv6 with details in PowerShell object format or in a string[] format. Possible values are valid IPv6 address and empty string " " . If " " is entered, the current value is deleted. IPv6Address must be provided with IPv6StaticAddressPrefixLength at the same time with valid values. At the maximum, 4 IPv6StaticAddress can be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6StaticAddressPrefixLength</maml:name> <maml:description> <maml:para>Specifies the list of Prefix Length to IPv6StaticAddress. Possible values are from 0 to 128 in Integer array format. A 0 means to clear the current prefix length value. If IPv6StaticAddress is a valid IPv6 address, IPv6StaticAddressPrefixLength cannot be set to 0, because they are not a correct IPv6 combination. At the maximum, 4 IPv6StaticAddressPrefixLength can be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[][]</command:parameterValue> <dev:type> <maml:name>Int32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6StaticRouteIndex</maml:name> <maml:description> <maml:para>The index of the IPv6 static route that needs to be set. This parameter accepts an array of integers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[][]</command:parameterValue> <dev:type> <maml:name>Int32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6StaticRouteDestination</maml:name> <maml:description> <maml:para>The IPv6 static route destination address. This parameter accpets an array of IPv6 addresses.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6StaticRoutePrefixLength</maml:name> <maml:description> <maml:para>The prefix length of the IPv6 static route destination address. This parameter accepts an array of integers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[][]</command:parameterValue> <dev:type> <maml:name>Int32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6StaticRouteGateway</maml:name> <maml:description> <maml:para>The IPv6 static route gateway. This parameter accpets an array of IPv6 addresses.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DNSServerType</maml:name> <maml:description> <maml:para>DNSServerType specifies the DNS server for which the IPv6 address needs to be set. The possible values are Primary,Secondary and Tertiary. DNSServerType must be provided along with DNSServerValue with valid values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DNSServer</maml:name> <maml:description> <maml:para>Currently configured IPv6 DNS servers in order of descending preference. Static values when not configured to use DHCPv6-supplied DNS servers; otherwise this property is read-only indicating the values are provided by DHCPv6.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>InterfaceType specifies the type of network connection present in the manager. The possible values are Dedicated and Shared.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dedicated</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shared</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SharedNetworkPortType</maml:name> <maml:description> <maml:para>Sets the Shared Network Port value. The values are LOM or FlexibleLOM. For iLO, the Shared Network Port feature is only available on servers with hardware, NIC firmware, and iLO firmware that supports this feature.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">LOM</command:parameterValue> <command:parameterValue required="false" variableLength="false">FlexibleLOM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNPPort</maml:name> <maml:description> <maml:para>The network adapter port number that is used for sharing. This feature is only applicable on systems and network adapters that support it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">1</command:parameterValue> <command:parameterValue required="false" variableLength="false">2</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VLANEnabled</maml:name> <maml:description> <maml:para>Enables or disables Virtual LAN. Possible values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VLANID</maml:name> <maml:description> <maml:para>Indicates the VLAN identifier for the corresponding VLAN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DNSName</maml:name> <maml:description> <maml:para>Specifies the DNS name for iLO. If an empty string is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name for the network where iLO resides. If an empty string is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NICEnabled</maml:name> <maml:description> <maml:para>Enables the NIC to reflect the state of iLO. The values are Yes to enable NIC or No to disable NIC.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FullDuplex</maml:name> <maml:description> <maml:para>Decides if iLO is to support full-duplex or half-duplex mode. It is only applicable if LinkSpeedMbps was not set to Automatic. The possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LinkSpeedMbps</maml:name> <maml:description> <maml:para>The link speed of the Ethernet interface in megabits per second. This property can only be modified on a dedicated network port. It cannot be modified for blade servers. The accepted values are 10,100,1000,2500,5000 and Automatic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Automatic</command:parameterValue> <command:parameterValue required="false" variableLength="false">10</command:parameterValue> <command:parameterValue required="false" variableLength="false">100</command:parameterValue> <command:parameterValue required="false" variableLength="false">1000</command:parameterValue> <command:parameterValue required="false" variableLength="false">2500</command:parameterValue> <command:parameterValue required="false" variableLength="false">5000</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6DNSServer</maml:name> <maml:description> <maml:para>Specifies if the DHCP-assigned DNS server is to be used. The possible values are Enabled and Disabled. This selection is only valid if DHCP is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6SNTPSetting</maml:name> <maml:description> <maml:para>Determines whether iLO is to get the SNTP time servers and time zone from the DHCP server or whether the user enters that information manually. Possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6RapidCommit</maml:name> <maml:description> <maml:para>DHCPv6RapidCommit is used when DHCPv6Stateful is enabled. It providesa reduction in the amount of DHCPv6 network traffic needed to assign addresses, but should not be used if more than one DHCPv6 server is present in the network for the purpose of assigning addresses. DHCPv6 database errors may result if more than one server can assign iLO an IPv6 address and Rapid Commit mode is enabled. Possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6StatefulMode</maml:name> <maml:description> <maml:para>Determines whether DHCPv6 Stateful mode is enabled or disabled. The supported values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6StatelessMode</maml:name> <maml:description> <maml:para>Determines whether DHCPv6 Stateless mode is enabled or disabled. The supported values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6DomainName</maml:name> <maml:description> <maml:para>Determines whether to use a DHCPv6-supplied domain name. Can only be enabled when DHCPv6 Stateless mode is also enabled; otherwise, this property will be set to Disabled and will be read-only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6DefaultGateway</maml:name> <maml:description> <maml:para>The IPv6 static default gateway entry.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PreferredProtocol</maml:name> <maml:description> <maml:para>The possible values are Enabled and Disabled. If Enabled is selected, IPv6 addresses will be used when both IPv6 and IPv4 are available.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RegDDNSServer"> <maml:name>RegisterDDNSServer</maml:name> <maml:description> <maml:para>Instructs iLO to register the management port with a DDNS server. The possible values are Enabled to register the management port or Disabled to not register the management port with DNS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="AddressAutoCfg"> <maml:name>StatelessAddressAutoConfiguration</maml:name> <maml:description> <maml:para>Determines whether StateLess Address Auto-Configuration is enabled or disabled.The supported values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6StaticAddress</maml:name> <maml:description> <maml:para>Specifies the list of IPv6 with details in PowerShell object format or in a string[] format. Possible values are valid IPv6 address and empty string " " . If " " is entered, the current value is deleted. IPv6Address must be provided with IPv6StaticAddressPrefixLength at the same time with valid values. At the maximum, 4 IPv6StaticAddress can be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6StaticAddressPrefixLength</maml:name> <maml:description> <maml:para>Specifies the list of Prefix Length to IPv6StaticAddress. Possible values are from 0 to 128 in Integer array format. A 0 means to clear the current prefix length value. If IPv6StaticAddress is a valid IPv6 address, IPv6StaticAddressPrefixLength cannot be set to 0, because they are not a correct IPv6 combination. At the maximum, 4 IPv6StaticAddressPrefixLength can be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[][]</command:parameterValue> <dev:type> <maml:name>Int32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6StaticRouteIndex</maml:name> <maml:description> <maml:para>The index of the IPv6 static route that needs to be set. This parameter accepts an array of integers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[][]</command:parameterValue> <dev:type> <maml:name>Int32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6StaticRouteDestination</maml:name> <maml:description> <maml:para>The IPv6 static route destination address. This parameter accpets an array of IPv6 addresses.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6StaticRoutePrefixLength</maml:name> <maml:description> <maml:para>The prefix length of the IPv6 static route destination address. This parameter accepts an array of integers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[][]</command:parameterValue> <dev:type> <maml:name>Int32[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IPv6StaticRouteGateway</maml:name> <maml:description> <maml:para>The IPv6 static route gateway. This parameter accpets an array of IPv6 addresses.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DNSServerType</maml:name> <maml:description> <maml:para>DNSServerType specifies the DNS server for which the IPv6 address needs to be set. The possible values are Primary,Secondary and Tertiary. DNSServerType must be provided along with DNSServerValue with valid values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DNSServer</maml:name> <maml:description> <maml:para>Currently configured IPv6 DNS servers in order of descending preference. Static values when not configured to use DHCPv6-supplied DNS servers; otherwise this property is read-only indicating the values are provided by DHCPv6.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.Int32[]</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>In case of an error or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>• In case of iLO 4 servers, when InterfaceType is given as Shared, the following parameters are not supported: DHCPv6DNSServer,DHCPv6SNTPSetting,DHCPv6RapidCommit,DHCPv6StatefulMode,DHCPv6StatelessMode,DHCPv6DomainName,IPv6DefaultGateway,PreferredProtocol,RegisterDDNSServer,StatelessAddressAutoConfiguration,IPv6StaticAddress,IPv6StaticAddressPrefixLength,IPv6StaticRouteIndex,IPv6StaticRouteDestination,IPv6StaticRoutePrefixLength,IPv6StaticRouteGateway,DNSServerType, and DNSServer.</maml:para> <maml:para>• In case of iLO 4 servers, iLO is reset post successful execution of the cmdlet. It is recommended to wait until the reset is successful before executing any cmdlet further.</maml:para> <maml:para>• In case of iLO 5 servers, you must reset the iLO to successfully apply the setting.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $gateway = ,@("aa80::3ea8:2aff:fe19:e15d","") $dest = ,@("ab80::3ea8:2aff:fe19:e15d","") $staticpl = ,@(64,0) $index = ,@(2,1) $dnsserver = ,@("ac80::3ea8:2aff:fe19:e15d","") $dnstype = ,@("primary","tertiary") $ipaddressindex = ,@(2,1,4) $ipaddress = ,@("ad80::3ea8:2aff:fe19:e15d","","") $ipaddressprefixlength = ,@(64,0,44) PS C:\> $conn | Set-HPEiLOIPv6NetworkSetting -InterfaceType Dedicated -IPv6StaticAddress $ipaddress -IPv6StaticAddressPrefixLength $ipaddressprefixlength -DNSServerType $dnstype -DNSServer $dnsserver -IPv6StaticRouteIndex $index -IPv6StaticRouteGateway $gateway -IPv6StaticRoutePrefixLength $staticpl -IPv6StaticRouteDestination $dest -DHCPv6DNSServer Disabled</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of the IPV6 network settings for iLO 4 or iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEiLOIPv6NetworkSetting -Connection $connection -InterfaceType Dedicated -DHCPv6DomainName Enabled -DHCPv6DNSServer Enabled -DHCPv6Stateful Enabled -DHCPv6RapidCommit Enabled -DHCPv6SNTPSetting Disabled -DHCPv6Stateless Enabled</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of the IPV6 network settings for iLO 4 and iLO 5, in which the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEiLOIPv6NetworkSetting -Connection $connection -InterfaceType Dedicated -DNSName "sampleDNS" -DomainName "DomainName" -NICEnabled Enabled -FullDuplex Enabled -LinkSpeedMbps 10 -DefaultGateway "ad80::3ea8:2aff:fe19:e15d" -RegisterDDNSServer Enabled -AddressAutoConfiguration Enabled</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of the IPV6 network settings for iLO 4 and iLO 5, in which the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOIPv6NetworkSetting</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>Set-HPEiLOKerberosConfig</command:name> <maml:description> <maml:para>Configures the Kerberos authentication.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOKerberosConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOKerberosConfig cmdlet modifies the directory settings related to kerberos configuration in iLO.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOKerberosConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KerberosEnabled</maml:name> <maml:description> <maml:para>Enables or disables Kerberos authentication. Supported values are Yes to enable Kerberos authentication and No to disable Kerberos authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>Specifies the Kerberos realm for which the domain controller is configured. By convention, the Kerberos realm name for a given domain is the domain name converted to uppercase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KDCAddress</maml:name> <maml:description> <maml:para>Specifies the location of the domain controller. The domain controller location is specified as an IP address or DNS name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KDCPort</maml:name> <maml:description> <maml:para>Specifies the port number used to connect to the domain controller. The Kerberos port number is 88, but the domain controller can be configured for a different port number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16[]</command:parameterValue> <dev:type> <maml:name>UInt16[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Keytab</maml:name> <maml:description> <maml:para>Specifies the contents of the keytab file which is a binary file containing pairs of principals and encrypted passwords on iLO 4 servers and url which points to the keytab file in case of iLO 5 servers. In the Windows environment, the keytab file is generated with a ktpass utility. After generating a binary keytab file using the appropriate utility, use a Base64 encoder to convert the binary file to ASCII format. Place the Base64 contents between: -----BEGIN KEYTAB----- and -----END KEYTAB-----.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KerberosEnabled</maml:name> <maml:description> <maml:para>Enables or disables Kerberos authentication. Supported values are Yes to enable Kerberos authentication and No to disable Kerberos authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>Specifies the Kerberos realm for which the domain controller is configured. By convention, the Kerberos realm name for a given domain is the domain name converted to uppercase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KDCAddress</maml:name> <maml:description> <maml:para>Specifies the location of the domain controller. The domain controller location is specified as an IP address or DNS name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KDCPort</maml:name> <maml:description> <maml:para>Specifies the port number used to connect to the domain controller. The Kerberos port number is 88, but the domain controller can be configured for a different port number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16[]</command:parameterValue> <dev:type> <maml:name>UInt16[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Keytab</maml:name> <maml:description> <maml:para>Specifies the contents of the keytab file which is a binary file containing pairs of principals and encrypted passwords on iLO 4 servers and url which points to the keytab file in case of iLO 5 servers. In the Windows environment, the keytab file is generated with a ktpass utility. After generating a binary keytab file using the appropriate utility, use a Base64 encoder to convert the binary file to ASCII format. Place the Base64 contents between: -----BEGIN KEYTAB----- and -----END KEYTAB-----.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.UInt16[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $keyTab =@ "-----BEGIN KEYTAB----- abcdBase64encodedText -----END KEYTAB-----" PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOKerberosConfig -KerberosEnabled Yes -Realm ABCD.COM -KDCAddress 2.2.2.2 -KDCPort 65 -KeyTab $keyTab</dev:code> <dev:remarks> <maml:para>This cmdlet sets the Kerberos configuration in iLO 4 server, in which the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEiLOKerberosConfig -Connection $connection -KerberosEnabled Yes -Realm ABCD.COM -KDCAddress 2.2.2.2 -KDCPort 65 -KeyTab https://10.20.40.2/webfiles/KerbersoKeytab.keytab</dev:code> <dev:remarks> <maml:para>This cmdlet sets the KeberosConfig setting in iLO 5 with connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $keyTab =@ "-----BEGIN KEYTAB----- abcdBase64encodedText -----END KEYTAB-----" PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEiLOKerberosConfig -Connection $connection -KerberosEnabled Yes -Realm ABCD.COM -KDCAddress 2.2.2.2 -KDCPort 65 -KeyTab $keyTab</dev:code> <dev:remarks> <maml:para>This cmdlet sets the KeberosConfig setting on iLO 4 and iLO 5 with array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOKerberosConfig</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>Set-HPEiLOLanguage</command:name> <maml:description> <maml:para>Sets the default language on iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOLanguage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOLanguage cmdlet sets the language setting on iLO.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOLanguage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="LanguageID"> <maml:name>DefaultLanguage</maml:name> <maml:description> <maml:para>Specifies the language ID which is the two letter designation for a language. Examples for DefaultLanguage are: EN (English), JA (Japanese), ZH (Simplified Chinese).</maml:para> <maml:para>Aliases : LanguageID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ja</command:parameterValue> <command:parameterValue required="false" variableLength="false">ch</command:parameterValue> <command:parameterValue required="false" variableLength="false">en</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="LanguageID"> <maml:name>DefaultLanguage</maml:name> <maml:description> <maml:para>Specifies the language ID which is the two letter designation for a language. Examples for DefaultLanguage are: EN (English), JA (Japanese), ZH (Simplified Chinese).</maml:para> <maml:para>Aliases : LanguageID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ja</command:parameterValue> <command:parameterValue required="false" variableLength="false">ch</command:parameterValue> <command:parameterValue required="false" variableLength="false">en</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOLanguage -DefaultLanguage en</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of DefaultLanguage to en (English) in iLO 4 or iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEiLOLanguage -Connection $connection -DefaultLanguage JA</dev:code> <dev:remarks> <maml:para>This cmdlet sets the DefaultLanguage to JA(Japanese) in iLO 4 and iLO 5, in which, the array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOLanguage</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>Set-HPEiLOLicense</command:name> <maml:description> <maml:para>Applies a license key for the Integrated Lights-Out Advanced Pack.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOLicense</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOLicense cmdlet activates or deactivates iLO features based on the license type. There are three types of licenses 1. Advanced 2. Essentials 3. Scale-out.</maml:para> <maml:para>Details of the licenses are available at https://www.hpe.com/us/en/servers/integrated-lights-out-ilo.html. The iLO license pack is licensed to a single server. You may not use the same individual license key on more than one server. Contact your Account Representative for information on Volume Licensing or Master License Agreements if you want to use the same key for multiple servers. You must have the Configure iLO Settings privilege to execute this cmdlet.</maml:para> <maml:para>NOTE: You do not have to use a licensing key on a ProLiant BL Class server. Advanced features are automatically activated.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOLicense</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Signals the activation of the iLO advanced/essential/scale-out licensing. This parameter specifies the license key value. The key must be entered as one continuous string. Commas, periods, or other characters must not separate the key value. The key only accepts 25 characters; other characters entered to separate key values are interpreted as a part of the key, and results in the wrong key being entered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Key</maml:name> <maml:description> <maml:para>Signals the activation of the iLO advanced/essential/scale-out licensing. This parameter specifies the license key value. The key must be entered as one continuous string. Commas, periods, or other characters must not separate the key value. The key only accepts 25 characters; other characters entered to separate key values are interpreted as a part of the key, and results in the wrong key being entered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.String</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> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOLicense -Key 12345-67890-12345-67890-12345</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEiLOLicense -Connection $connection -Key 12345-67890-12345-67890-12345</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOLicense</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>Set-HPEiLOLogConfig</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOLogConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOLogConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>MaxSizeRollBackups</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>MaxFileSize</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue> <command:parameterValue required="false" variableLength="false">Error</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>MaxSizeRollBackups</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>MaxFileSize</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String System.Int32</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> </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>Set-HPEiLOLoginSecurityBanner</command:name> <maml:description> <maml:para>Sets the security message for the iLO login screen.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOLoginSecurityBanner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set-HPEiLOLoginSecurityBanner cmdlet gets the security message to be displayed on the iLO login screen.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOLoginSecurityBanner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SecurityMessageEnabled</maml:name> <maml:description> <maml:para>Enables or disables the display of security message on the iLO login screen. Accepted values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SecurityMessageText</maml:name> <maml:description> <maml:para>The security message to be displayed on the iLO login screen.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SecurityMessageEnabled</maml:name> <maml:description> <maml:para>Enables or disables the display of security message on the iLO login screen. Accepted values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SecurityMessageText</maml:name> <maml:description> <maml:para>The security message to be displayed on the iLO login screen.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> ,$connection | Set-HPEiLOLoginSecurityBanner -SecurityMessageEnabled Yes -SecurityMessageText TestSecurityMessage</dev:code> <dev:remarks> <maml:para>This cmdlet enables the display of security text mesage on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Set-HPEiLOLoginSecurityBanner -Connection $connection -SecurityMessageEnabled Yes -SecurityMessageText TestSecurityMessage</dev:code> <dev:remarks> <maml:para>This cmdlet enables the display of security text mesage on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>C:\> ,$connection | Set-HPEiLOLoginSecurityBanner -SecurityMessageEnabled Yes -SecurityMessageText TestSecurityMessage</dev:code> <dev:remarks> <maml:para>This cmdlet enables the display of security text mesage on iLO 4 and iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOLoginSecurityBanner</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>Set-HPEiLOMaintenanceWindow</command:name> <maml:description> <maml:para>Modifies the existing maintenance window data.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOMaintenanceWindow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOMaintenaceWindow cmdlet modifies the existing maintenance window data, such as Name and Description.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOMaintenanceWindow</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Expire</maml:name> <maml:description> <maml:para>Specifies the new end time(UTC) for the existing maintenance window. Supported format is of the form yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 19:23:14). Time must be given in 24-hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StartAfter</maml:name> <maml:description> <maml:para>Specifies the new start time (UTC) for the existing maintenance window. Supported format is of the form yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 19:23:14). Time must be given in 24-hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a new description for the existing maintenance window. Accepts a string of length between 0 to 64.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name for the existing maintenance window. Accepts a string of length between 1 to 64.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the existing maintenance window that requires a modification. It is case sensitive. Accepts a string of length between 1 to 64.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Expire</maml:name> <maml:description> <maml:para>Specifies the new end time(UTC) for the existing maintenance window. Supported format is of the form yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 19:23:14). Time must be given in 24-hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StartAfter</maml:name> <maml:description> <maml:para>Specifies the new start time (UTC) for the existing maintenance window. Supported format is of the form yyyy-MM-dd HH:mm:ss. (For example, 2018-06-27 19:23:14). Time must be given in 24-hour format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime[]</command:parameterValue> <dev:type> <maml:name>DateTime[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a new description for the existing maintenance window. Accepts a string of length between 0 to 64.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Specifies the new name for the existing maintenance window. Accepts a string of length between 1 to 64.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the existing maintenance window that requires a modification. It is case sensitive. Accepts a string of length between 1 to 64.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.DateTime[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOMaintenanceWindow -Expire "2018-09-29 03:15" -StartAfter "2018-09-28 19:00" -Name TestMaint -NewName "TestMaintModified" -Description "Modified test maintenance window desc"</dev:code> <dev:remarks> <maml:para>This cmdlet adds the maintenance window to iLO 5 when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> [DateTime]$startTime = Get-Date PS C:\> [DateTime]$endTime = (Get-Date).AddDays(2) PS C:\> ,$connection | Set-HPEiLOMaintenanceWindow -Expire $endTime -StartAfter $startTime -Name TestMaint -Description "test maintenance window"</dev:code> <dev:remarks> <maml:para>This cmdlet adds the maintenance window on iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOMaintenanceWindow</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEiLOMaintenanceWindow</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>Set-HPEiLOMaxThreadLimit</command:name> <maml:description> <maml:para>Sets the maximum number of threads that can be spawned by the cmdlets of HPEiLOCmdlets module.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOMaxThreadLimit</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOMaxThreadLimit cmdlet sets the upper limit to the maximum number of parallel threads that can be created by the cmdlet of this module. Parallel threads are created when a cmdlet intents to fetch information from multiple targets.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOMaxThreadLimit</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>MaxThreadLimit</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>MaxThreadLimit</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int32</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Set-HPEiLOMaxThreadLimit -MaxThreadLimit 300</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> 120 | Set-HPEiLOMaxThreadLimit</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOMaxThreadLimit</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>Set-HPEiLOOneTimeBootOption</command:name> <maml:description> <maml:para>Sets one time boot option.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOOneTimeBootOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOOneTimeBootOption cmdlet sets one time boot order.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOOneTimeBootOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BootSourceOverrideEnable</maml:name> <maml:description> <maml:para>BootSourceOverrideTarget must be specified before BootSourceOverrideEnable can be used. Supported values are Disabled, Once, and Continuous. • Disabled: The system will boot normally. • Once: On its next boot cycle, the system will boot (one time) to the Boot Source Override Target. The value of BootSourceOverrideEnabled is then reset back to Disabled. • Continuous: The system will boot to the target specified in the BootSourceOverrideTarget until this property is set to Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Once</command:parameterValue> <command:parameterValue required="false" variableLength="false">Continuous</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BootSourceOverrideTarget</maml:name> <maml:description> <maml:para>The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnable is set to Once or Continuous.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">PXE</command:parameterValue> <command:parameterValue required="false" variableLength="false">Floppy</command:parameterValue> <command:parameterValue required="false" variableLength="false">CD</command:parameterValue> <command:parameterValue required="false" variableLength="false">USB</command:parameterValue> <command:parameterValue required="false" variableLength="false">HDD</command:parameterValue> <command:parameterValue required="false" variableLength="false">BIOSSetup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Diags</command:parameterValue> <command:parameterValue required="false" variableLength="false">UEFIShell</command:parameterValue> <command:parameterValue required="false" variableLength="false">UEFITarget</command:parameterValue> <command:parameterValue required="false" variableLength="false">SDCard</command:parameterValue> <command:parameterValue required="false" variableLength="false">UEFIHTTP</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emb-Menu</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emb-ACU</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emb-HPSUM-Auto</command:parameterValue> <command:parameterValue required="false" variableLength="false">IntelligentProvisioning</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootCustom</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BootCustomName</maml:name> <maml:description> <maml:para>If a device's value is BootCustom, BootCustomName becomes a required input parameter, and the value must have the format: Bootxxxx (for example, Boot0009).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UEFITargetBootSourceOverride</maml:name> <maml:description> <maml:para>This parameter is the UEFI Device Path of the device to boot from when BootSourceOverrideTarget is UefiTarget.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BootSourceOverrideEnable</maml:name> <maml:description> <maml:para>BootSourceOverrideTarget must be specified before BootSourceOverrideEnable can be used. Supported values are Disabled, Once, and Continuous. • Disabled: The system will boot normally. • Once: On its next boot cycle, the system will boot (one time) to the Boot Source Override Target. The value of BootSourceOverrideEnabled is then reset back to Disabled. • Continuous: The system will boot to the target specified in the BootSourceOverrideTarget until this property is set to Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Once</command:parameterValue> <command:parameterValue required="false" variableLength="false">Continuous</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BootSourceOverrideTarget</maml:name> <maml:description> <maml:para>The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnable is set to Once or Continuous.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">PXE</command:parameterValue> <command:parameterValue required="false" variableLength="false">Floppy</command:parameterValue> <command:parameterValue required="false" variableLength="false">CD</command:parameterValue> <command:parameterValue required="false" variableLength="false">USB</command:parameterValue> <command:parameterValue required="false" variableLength="false">HDD</command:parameterValue> <command:parameterValue required="false" variableLength="false">BIOSSetup</command:parameterValue> <command:parameterValue required="false" variableLength="false">Diags</command:parameterValue> <command:parameterValue required="false" variableLength="false">UEFIShell</command:parameterValue> <command:parameterValue required="false" variableLength="false">UEFITarget</command:parameterValue> <command:parameterValue required="false" variableLength="false">SDCard</command:parameterValue> <command:parameterValue required="false" variableLength="false">UEFIHTTP</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emb-Menu</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emb-ACU</command:parameterValue> <command:parameterValue required="false" variableLength="false">Emb-HPSUM-Auto</command:parameterValue> <command:parameterValue required="false" variableLength="false">IntelligentProvisioning</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootCustom</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BootCustomName</maml:name> <maml:description> <maml:para>If a device's value is BootCustom, BootCustomName becomes a required input parameter, and the value must have the format: Bootxxxx (for example, Boot0009).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UEFITargetBootSourceOverride</maml:name> <maml:description> <maml:para>This parameter is the UEFI Device Path of the device to boot from when BootSourceOverrideTarget is UefiTarget.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOOneTimeBootOption -BootSourceOverrideTarget CD</dev:code> <dev:remarks> <maml:para>This cmdlet sets the one time boot order in iLO 4 server when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOOneTimeBootOption -BootSourceOverrideEnable Continuous -BootSourceOverrideTarget CD</dev:code> <dev:remarks> <maml:para>This cmdlet sets the one time boot order when BootMode is Legacy in iLO 5 server when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOOneTimeBootOption -BootSourceOverrideEnable Continuous -UEFITargetBootSourceOverride "UsbClass(0xFFFF,0xFFFF,0xFF,0xFF,0xFF)"</dev:code> <dev:remarks> <maml:para>This cmdlet sets the one time boot order when BootMode is Uefi in iLO 5 server when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Set-HPEiLOOneTimeBootOption -Connection $connection -BootSourceOverrideTarget CD</dev:code> <dev:remarks> <maml:para>This cmdlet sets the One time boot order in iLO 4 and iLO 5 and the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOOneTimeBootOption</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>Set-HPEiLOPerformanceAlertSetting</command:name> <maml:description> <maml:para>Modifies the lower or upper threshold for the specified sensor.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOPerformanceAlertSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOPerformanceAlertSetting cmdlet modifies the lower or upper threshold for the specified sensor. This cmdlet is supported on iLO 5 servers only.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOPerformanceAlertSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>The name of the sensor for which the threshold is to be set. Valid values are 'CPUUtilization', 'MemoryBusUtilization', 'IOBusUtilization', 'CPUInterconnectUtilization', 'JitterCount', and 'CPUPower'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CPUUtilization</command:parameterValue> <command:parameterValue required="false" variableLength="false">MemoryBusUtilization</command:parameterValue> <command:parameterValue required="false" variableLength="false">IOBusUtilization</command:parameterValue> <command:parameterValue required="false" variableLength="false">CPUInterconnectUtilization</command:parameterValue> <command:parameterValue required="false" variableLength="false">JitterCount</command:parameterValue> <command:parameterValue required="false" variableLength="false">CPUPower</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LowerThresholdReading</maml:name> <maml:description> <maml:para>The lowest value the sensor can report before an event is posted in the IML. Valid values are from 1 to 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LowerThresholdDwellTime</maml:name> <maml:description> <maml:para>The number of seconds the sensor reading is below the configured value before the threshold is violated. When a threshold is violated, an event is posted in the IML.</maml:para> <maml:para>For example, if you set an upper threshold to 70% with a dwell time of 30 seconds, an event is posted when the sensor reports readings over 70% for more than 30 seconds.</maml:para> <maml:para>To enable an alert, set the dwell time between 20 and 64800 (20 seconds to 18 hours) in multiples of 20. If you enter a value that is not a multiple of 20, the value is rounded up to the next multiple of 20.</maml:para> <maml:para>To disable an alert, set the dwell time to 0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UpperThresholdReading</maml:name> <maml:description> <maml:para>The highest value the sensor can report before an event is posted in the IML. Valid values are from 1 to 100. • For utilization sensors, enter a percentage of utilization for the selected sensor. • For CPU Power, enter a value in watts. • For Jitter Count, enter the threshold count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UpperThresholdDwellTime</maml:name> <maml:description> <maml:para>The number of seconds the sensor reading is above the configured value before the threshold is violated. When a threshold is violated, an event is posted in the IML.</maml:para> <maml:para>For example, if you set an upper threshold to 70% with a dwell time of 30 seconds, an event is posted when the sensor reports readings over 70% for more than 30 seconds.</maml:para> <maml:para>To enable an alert, set the dwell time between 20 and 64800 (20 seconds to 18 hours) in multiples of 20. If you enter a value that is not a multiple of 20, the value is rounded up to the next multiple of 20.</maml:para> <maml:para>To disable an alert, set the dwell time to 0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and username and password provided to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>The name of the sensor for which the threshold is to be set. Valid values are 'CPUUtilization', 'MemoryBusUtilization', 'IOBusUtilization', 'CPUInterconnectUtilization', 'JitterCount', and 'CPUPower'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CPUUtilization</command:parameterValue> <command:parameterValue required="false" variableLength="false">MemoryBusUtilization</command:parameterValue> <command:parameterValue required="false" variableLength="false">IOBusUtilization</command:parameterValue> <command:parameterValue required="false" variableLength="false">CPUInterconnectUtilization</command:parameterValue> <command:parameterValue required="false" variableLength="false">JitterCount</command:parameterValue> <command:parameterValue required="false" variableLength="false">CPUPower</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LowerThresholdReading</maml:name> <maml:description> <maml:para>The lowest value the sensor can report before an event is posted in the IML. Valid values are from 1 to 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LowerThresholdDwellTime</maml:name> <maml:description> <maml:para>The number of seconds the sensor reading is below the configured value before the threshold is violated. When a threshold is violated, an event is posted in the IML.</maml:para> <maml:para>For example, if you set an upper threshold to 70% with a dwell time of 30 seconds, an event is posted when the sensor reports readings over 70% for more than 30 seconds.</maml:para> <maml:para>To enable an alert, set the dwell time between 20 and 64800 (20 seconds to 18 hours) in multiples of 20. If you enter a value that is not a multiple of 20, the value is rounded up to the next multiple of 20.</maml:para> <maml:para>To disable an alert, set the dwell time to 0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UpperThresholdReading</maml:name> <maml:description> <maml:para>The highest value the sensor can report before an event is posted in the IML. Valid values are from 1 to 100. • For utilization sensors, enter a percentage of utilization for the selected sensor. • For CPU Power, enter a value in watts. • For Jitter Count, enter the threshold count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UpperThresholdDwellTime</maml:name> <maml:description> <maml:para>The number of seconds the sensor reading is above the configured value before the threshold is violated. When a threshold is violated, an event is posted in the IML.</maml:para> <maml:para>For example, if you set an upper threshold to 70% with a dwell time of 30 seconds, an event is posted when the sensor reports readings over 70% for more than 30 seconds.</maml:para> <maml:para>To enable an alert, set the dwell time between 20 and 64800 (20 seconds to 18 hours) in multiples of 20. If you enter a value that is not a multiple of 20, the value is rounded up to the next multiple of 20.</maml:para> <maml:para>To disable an alert, set the dwell time to 0.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>None.</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\>,$connection | Set-HPEiLOPerformanceAlertSetting -Sensor CPUUtilization -LowerThresholdReading 80 -LowerThresholdDwellTime 20 PS C:\></dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2,10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $obj = Set-HPEiLOPerformanceAlertSetting -Connection $connection -Sensor CPUUtilization -LowerThresholdReading 80 -LowerThresholdDwellTime 40 PS C:\></dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the array of connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOPerformanceAlertSetting</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>Set-HPEiLOPersistentBootOrder</command:name> <maml:description> <maml:para>Sets the persistent boot order.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOPersistentBootOrder</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOPersistentBootOrder cmdlet sets the persistent boot order.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOPersistentBootOrder</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BootOrder</maml:name> <maml:description> <maml:para>The possible set of values for the boot devices is different for different iLOs.</maml:para> <maml:para>iLO 4: Specifies one or more boot devices from CDROM, FlexibleLOM, EmbeddedLOM, NIC, HDD, SA_HDD, USB_HDD, or PCI_DEVICE in a comma-separated-string format for each server.</maml:para> <maml:para>If you do not list every option, the remaining options are shifted toward the bottom of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>BootOrder</maml:name> <maml:description> <maml:para>The possible set of values for the boot devices is different for different iLOs.</maml:para> <maml:para>iLO 4: Specifies one or more boot devices from CDROM, FlexibleLOM, EmbeddedLOM, NIC, HDD, SA_HDD, USB_HDD, or PCI_DEVICE in a comma-separated-string format for each server.</maml:para> <maml:para>If you do not list every option, the remaining options are shifted toward the bottom of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[][]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $order = ,@("FLOPPY","HDD","USB","CDROM","NETWORK1") PS C:\>,$connection | Set-HPEiLOPersistentBootOrder -BootOrder $order</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $order = ,@("NIC.FlexLOM.1.1.Httpv6","Shell.Emb.1.2","HD.Slot.5.2","Generic.USB.1.1","HD.Slot.5.3") PS C:\> $obj = Set-HPEiLOPersistentBootOrder -Connection $connection -BootOrder $order PS C:\> $obj IP Hostname Status StatusInfo -- -------- ------ ---------- 10.20.30.2 xyz.example.com INFORMATION HPE.iLO.Response.StatusInfo PS C:\> $obj.StatusInfo Category Message AffectedAttribute -------- ------- ----------------- General SystemResetRequired</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> $order = @(@("NETWORK1","CDROM","USB","HDD","FLOPPY"),@("HD.Slot.5.3","Generic.USB.1.1","HD.Slot.5.2","Shell.Emb.1.2","NIC.FlexLOM.1.1.Httpv6")) PS C:\> Set-HPEiLOPersistentBootOrder -Connection $connection -BootOrder $order</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of Boot Order on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOPersistentBootOrder</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>Set-HPEiLOPersistentMouseKeyboard</command:name> <maml:description> <maml:para>Sets the persistent mouse and keyboard setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOPersistentMouseKeyboard</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set-HPEiLOPersistentmouseKeyboard cmdlet enables or disables the persistent mouse and keyboard setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOPersistentMouseKeyboard</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PersistenceEnabled</maml:name> <maml:description> <maml:para>Enables or disables the persistent mouse and keyboard setting.The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PersistenceEnabled</maml:name> <maml:description> <maml:para>Enables or disables the persistent mouse and keyboard setting.The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOPersistentMouseKeyboard -PersistenceEnabled Yes</dev:code> <dev:remarks> <maml:para>This cmdlet enables the persistent mouse and keyboard setting on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOPersistentMouseKeyboard -PersistenceEnabled No</dev:code> <dev:remarks> <maml:para>This cmdlet disables the persistent mouse and keyboard setting on iLO 4 and iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOPersistentMouseKeyboard</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>Set-HPEiLOPostSetting</command:name> <maml:description> <maml:para>Sets the Post setting detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOPostSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOPostSetting sets the Post setting detail.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOPostSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PostMode</maml:name> <maml:description> <maml:para>The manner in which the system will operate during and at completion of POST. Supported values are: • Normal: Normal operations • PostToReboot: Server boots until Discovery Completes, then reboots. • PostToShutdown: Server boots until Discovery Completes, then shuts down.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" variableLength="false">PostToShutdown</command:parameterValue> <command:parameterValue required="false" variableLength="false">PostToReboot</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PostDiscoveryMode</maml:name> <maml:description> <maml:para>The manner in which the system will operate during the discovery section of POST. Supported values are: • Auto: BIOS will automatically use ForceFastBoot if the system hardware has not changed from last time of FullDiscovery or ForceFullDiscovery if the system hardware has changed. • ForceFastBoot: Server uses the existing cached discovery data. • ForceFullDiscovery: Server makes a full discovery of all devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Auto</command:parameterValue> <command:parameterValue required="false" variableLength="false">ForceFullDiscovery</command:parameterValue> <command:parameterValue required="false" variableLength="false">ForceFastBoot</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EndOfPostDelaySeconds</maml:name> <maml:description> <maml:para>Supported on UEFI based systems only. The number of seconds to delay before finalizing POST with the Mode action (for example, delay before shutdown).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PostMode</maml:name> <maml:description> <maml:para>The manner in which the system will operate during and at completion of POST. Supported values are: • Normal: Normal operations • PostToReboot: Server boots until Discovery Completes, then reboots. • PostToShutdown: Server boots until Discovery Completes, then shuts down.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Normal</command:parameterValue> <command:parameterValue required="false" variableLength="false">PostToShutdown</command:parameterValue> <command:parameterValue required="false" variableLength="false">PostToReboot</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PostDiscoveryMode</maml:name> <maml:description> <maml:para>The manner in which the system will operate during the discovery section of POST. Supported values are: • Auto: BIOS will automatically use ForceFastBoot if the system hardware has not changed from last time of FullDiscovery or ForceFullDiscovery if the system hardware has changed. • ForceFastBoot: Server uses the existing cached discovery data. • ForceFullDiscovery: Server makes a full discovery of all devices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Auto</command:parameterValue> <command:parameterValue required="false" variableLength="false">ForceFullDiscovery</command:parameterValue> <command:parameterValue required="false" variableLength="false">ForceFastBoot</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EndOfPostDelaySeconds</maml:name> <maml:description> <maml:para>Supported on UEFI based systems only. The number of seconds to delay before finalizing POST with the Mode action (for example, delay before shutdown).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.UInt32[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOPostSetting -PostMode Normal -PostDiscoveryMode Auto -EndOfPostDelaySeconds 5</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of Post setting on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Set-HPEiLOPostSetting -Connection $connection -PostMode Normal -PostDiscoveryMode Auto -EndOfPostDelaySeconds 5</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of PostSetting iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOPostSetting</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>Set-HPEiLOPowerCapSetting</command:name> <maml:description> <maml:para>Sets the power cap feature on the host server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOPowerCapSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set-HPEiLOPowerCap cmdlet sets a power cap on the server. You must have the Configure iLO Settings privilege to execute this cmdlet or to modify the power cap. You cannot set this property if a dynamic power cap is set for the server. Dynamic power capping is set and modified using either Onboard Administrator or Insight Power Manager. You must purchase the iLO Advanced license to enable this feature.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOPowerCapSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerCap</maml:name> <maml:description> <maml:para>Specifies the power cap on the server. Valid power cap values are determined using a power test run on the server at boot. The possible values are 0 to disable the power cap, or a numeric value in watts (as determined in the power test.)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LimitException</maml:name> <maml:description> <maml:para>The action that is taken if the power cannot be maintained below the PowerCap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NoAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">HardPowerOff</command:parameterValue> <command:parameterValue required="false" variableLength="false">LogEventOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">Oem</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerCap</maml:name> <maml:description> <maml:para>Specifies the power cap on the server. Valid power cap values are determined using a power test run on the server at boot. The possible values are 0 to disable the power cap, or a numeric value in watts (as determined in the power test.)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LimitException</maml:name> <maml:description> <maml:para>The action that is taken if the power cannot be maintained below the PowerCap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NoAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">HardPowerOff</command:parameterValue> <command:parameterValue required="false" variableLength="false">LogEventOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">Oem</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOPowerCapSetting -PowerCap 50</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of PowerCap on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOPowerCapSetting -PowerCap 50 -LimitException HardPowerOff</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of PowerCap on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOPowerCapSetting -PowerCap 90</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of PowerCap on iLO 4 and iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOPowerCapSetting</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>Set-HPEiLOPowerRegulatorSetting</command:name> <maml:description> <maml:para>Sets the state of the processor power regulator feature of the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOPowerRegulatorSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOPowerRegulatorSetting cmdlet sets the Power Regulator Setting for the server processor. You must have Virtual Power and Reset privilege to execute</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOPowerRegulatorSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Controls the Dynamic Power Saver feature of the server processor if the feature is supported. The possible values are Dynamic, Max, Min, and OSControl.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dynamic</command:parameterValue> <command:parameterValue required="false" variableLength="false">Max</command:parameterValue> <command:parameterValue required="false" variableLength="false">Min</command:parameterValue> <command:parameterValue required="false" variableLength="false">OSControl</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Controls the Dynamic Power Saver feature of the server processor if the feature is supported. The possible values are Dynamic, Max, Min, and OSControl.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dynamic</command:parameterValue> <command:parameterValue required="false" variableLength="false">Max</command:parameterValue> <command:parameterValue required="false" variableLength="false">Min</command:parameterValue> <command:parameterValue required="false" variableLength="false">OSControl</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOPowerRegulatorSetting -Mode Dynamic</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of Power regulator mode to Dynamic on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOPowerRegulatorSetting -Mode Max</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of Power regulator mode to Max on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.2,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOPowerRegulatorSetting -Mode Max</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of Power regulator mode to Max on iLO 4 and iLO 5 with an array of iLO connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOPowerCapSetting</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>Set-HPEiLOProcessorJitterControl</command:name> <maml:description> <maml:para>Sets the Processor Jitter control.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOProcessorJitterControl</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOProcessorJitterControl cmdlet sets the Processor Jitter control. This cmdlet is supported only on iLO 5 servers. This setting is part of Intelligent System Tuning.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOProcessorJitterControl</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Provides various jitter control modes: • Auto - When configured in Auto mode, the platform will monitor frequency variance of the processor and automatically make adjustments to minimize variance over time. • Manual - When configured in Manual mode, you can operate the processor at a fixed frequency. • Disabled - Jitter control is disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Auto</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Manual</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FrequencyLimitMHz</maml:name> <maml:description> <maml:para>Frequency limit of the Processor in MHz. Value ranges from 0-10000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProcessorJitterControlOptimization</maml:name> <maml:description> <maml:para>Provides Jitter Control Optimizations and below are the accepted values: . OptimizedForThroughput: Threshold and Polling rate will be optimized for Maximum Throughput . OptimizedForLatency: Threshold and Polling rate will be optimized for Low Latency . ZeroLatency:Threshold and Polling rate will be optimized for Zero Latency</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">OptimizedForThroughput</command:parameterValue> <command:parameterValue required="false" variableLength="false">OptimizedForLatency</command:parameterValue> <command:parameterValue required="false" variableLength="false">ZeroLatency</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Provides various jitter control modes: • Auto - When configured in Auto mode, the platform will monitor frequency variance of the processor and automatically make adjustments to minimize variance over time. • Manual - When configured in Manual mode, you can operate the processor at a fixed frequency. • Disabled - Jitter control is disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Auto</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Manual</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>FrequencyLimitMHz</maml:name> <maml:description> <maml:para>Frequency limit of the Processor in MHz. Value ranges from 0-10000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProcessorJitterControlOptimization</maml:name> <maml:description> <maml:para>Provides Jitter Control Optimizations and below are the accepted values: . OptimizedForThroughput: Threshold and Polling rate will be optimized for Maximum Throughput . OptimizedForLatency: Threshold and Polling rate will be optimized for Low Latency . ZeroLatency:Threshold and Polling rate will be optimized for Zero Latency</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">OptimizedForThroughput</command:parameterValue> <command:parameterValue required="false" variableLength="false">OptimizedForLatency</command:parameterValue> <command:parameterValue required="false" variableLength="false">ZeroLatency</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String System.UInt32[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOProcessorJitterControl -Mode Manual -FrequencyLimitMHz 800 -ProcessorJitterControlOptimization OptimizedForLatency</dev:code> <dev:remarks> <maml:para>This example sets the value of Processor Jitter Control on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO -IP 10.20.30.2,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Set-HPEiLOProcessorJitterControl -Connection $connection -Mode Auto</dev:code> <dev:remarks> <maml:para>This example sets the value of Processor Jitter Control on iLO 5 with an array of iLO connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOProcessorJitterControl</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>Set-HPEiLORemoteSupportSetting</command:name> <maml:description> <maml:para>Sets the web proxy settings for servers that use Insight Online direct connect remote support.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLORemoteSupportSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLORemoteSupportSetting cmdlet sets proxy settings like proxy server and the Internet connection port to the remote server. Proxy settings apply only to direct connect registrations. This cmdlet is used to set ERS and IRS related settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet" default="true"> <!--NAME: UsernamePasswordSet--> <!--TAG: DEFAULT--> <maml:name>Set-HPEiLORemoteSupportSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyServer</maml:name> <maml:description> <maml:para>Specifies the web proxy URL to be configured as the proxy server for connecting to the target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyPort</maml:name> <maml:description> <maml:para>Sets the port for configuring the web proxy URL to connect to the target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyUsername</maml:name> <maml:description> <maml:para>Specifies the web proxy username.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyPassword</maml:name> <maml:description> <maml:para>Specifies the web proxy password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MaintenanceModeEnabled</maml:name> <maml:description> <maml:para>Use maintenance mode when you perform maintenance on a server. In maintenance mode, any events or messages that are sent to Insight RS or Insight Online are flagged to indicate that the event requires no action. This feature helps Hewlett Packard Enterprise to determine whether to open a support case. Supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DurationInMinutes</maml:name> <maml:description> <maml:para>Specifies the time in minutes for which the iLO is in maintenance mode. This parameter must be provided when 'MaintenanceModeEnabled' parameter value is 'Yes'. Supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Set-HPEiLORemoteSupportSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyServer</maml:name> <maml:description> <maml:para>Specifies the web proxy URL to be configured as the proxy server for connecting to the target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyPort</maml:name> <maml:description> <maml:para>Sets the port for configuring the web proxy URL to connect to the target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyCredential</maml:name> <maml:description> <maml:para>This object is based on the username and password used to configure the web proxy settings required for connecting with the HP Insight Online Remote Server. WebProxyCredential should not be used along with WebProxyUsername/WebProxyPassword.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MaintenanceModeEnabled</maml:name> <maml:description> <maml:para>Use maintenance mode when you perform maintenance on a server. In maintenance mode, any events or messages that are sent to Insight RS or Insight Online are flagged to indicate that the event requires no action. This feature helps Hewlett Packard Enterprise to determine whether to open a support case. Supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DurationInMinutes</maml:name> <maml:description> <maml:para>Specifies the time in minutes for which the iLO is in maintenance mode. This parameter must be provided when 'MaintenanceModeEnabled' parameter value is 'Yes'. Supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyServer</maml:name> <maml:description> <maml:para>Specifies the web proxy URL to be configured as the proxy server for connecting to the target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyPort</maml:name> <maml:description> <maml:para>Sets the port for configuring the web proxy URL to connect to the target server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyUsername</maml:name> <maml:description> <maml:para>Specifies the web proxy username.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyPassword</maml:name> <maml:description> <maml:para>Specifies the web proxy password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MaintenanceModeEnabled</maml:name> <maml:description> <maml:para>Use maintenance mode when you perform maintenance on a server. In maintenance mode, any events or messages that are sent to Insight RS or Insight Online are flagged to indicate that the event requires no action. This feature helps Hewlett Packard Enterprise to determine whether to open a support case. Supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DurationInMinutes</maml:name> <maml:description> <maml:para>Specifies the time in minutes for which the iLO is in maintenance mode. This parameter must be provided when 'MaintenanceModeEnabled' parameter value is 'Yes'. Supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebProxyCredential</maml:name> <maml:description> <maml:para>This object is based on the username and password used to configure the web proxy settings required for connecting with the HP Insight Online Remote Server. WebProxyCredential should not be used along with WebProxyUsername/WebProxyPassword.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.Int32[] System.Management.Automation.PSCredential[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLORemoteSupportSetting -WebProxyServer 1.1.1.1 -WebProxyPort 1234 -WebProxyUsername admin -WebProxyPassword admin123</dev:code> <dev:remarks> <maml:para>This examples sets the web proxy setting on iLO 4 or iLO 5 server with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Set-HPEiLORemoteSupportSetting -Connection $connection -WebProxyServer 1.1.1.1 -WebProxyPort 1234 -WebProxyCredential $credential</dev:code> <dev:remarks> <maml:para>This examples sets the Web proxy on iLO 4 and iLO 5 servers with an array of connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLORemoteSupportSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-HPEiLORemoteSupportSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unregister-HPEiLORemoteSupportSetting</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>Set-HPEiLORemoteSyslog</command:name> <maml:description> <maml:para>Sets the iLO Remote Syslog settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLORemoteSyslog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set-HPEiLORemoteSyslog cmdlet allows iLO to send event notification messages to Syslog servers. The iLO firmware Remote Syslog includes the IML and iLO Event Log. An iLO license that supports this feature is required.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLORemoteSyslog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteSyslogEnabled</maml:name> <maml:description> <maml:para>Determines whether iLO should send event notification messages to a Syslog server. Valid values are Yes to enable sending event notification messages and No to disable sending of notification messages to Syslog server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteSyslogServer</maml:name> <maml:description> <maml:para>Sets the IP address, FQDN, IPv6 name, or short name of the server running the Syslog service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteSyslogPort</maml:name> <maml:description> <maml:para>Sets the port number through which the Syslog server listens.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteSyslogEnabled</maml:name> <maml:description> <maml:para>Determines whether iLO should send event notification messages to a Syslog server. Valid values are Yes to enable sending event notification messages and No to disable sending of notification messages to Syslog server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteSyslogServer</maml:name> <maml:description> <maml:para>Sets the IP address, FQDN, IPv6 name, or short name of the server running the Syslog service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteSyslogPort</maml:name> <maml:description> <maml:para>Sets the port number through which the Syslog server listens.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLORemoteSyslog -RemoteSyslogEnabled Yes -RemoteSyslogServer 10.20.30.40 -RemoteSyslogPort 344</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of PowerCap on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLORemoteSyslog -RemoteSyslogEnabled Yes -RemoteSyslogServer 10.20.30.40 -RemoteSyslogPort 344</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of PowerCap on iLO 4 and iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLORemoteSyslog</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>Set-HPEiLORepositoryComponent</command:name> <maml:description> <maml:para>Modifies the existing repository component data.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLORepositoryComponent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLORepositoryComponent cmdlet modifies the existing repository information.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLORepositoryComponent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para>Specifies the file name of the component which needs to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Criticality</maml:name> <maml:description> <maml:para>Specifies the criticality of the component. Accepted values are 'Critical', 'Optional', and 'Recommended'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Optional</command:parameterValue> <command:parameterValue required="false" variableLength="false">Recommended</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specifies a string defining customized parameters for some components provided by client at upload time and given to the component at execution time. Accepts a string of length between 0 to 1280.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ExecutionParameter</maml:name> <maml:description> <maml:para>Client supplied execution parameters. These are supplied at upload time and given to the component at execution time. Accepts a string of length between 0 to 256.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Filename</maml:name> <maml:description> <maml:para>Specifies the file name of the component which needs to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Criticality</maml:name> <maml:description> <maml:para>Specifies the criticality of the component. Accepted values are 'Critical', 'Optional', and 'Recommended'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Optional</command:parameterValue> <command:parameterValue required="false" variableLength="false">Recommended</command:parameterValue> <command:parameterValue required="false" variableLength="false">Critical</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specifies a string defining customized parameters for some components provided by client at upload time and given to the component at execution time. Accepts a string of length between 0 to 1280.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ExecutionParameter</maml:name> <maml:description> <maml:para>Client supplied execution parameters. These are supplied at upload time and given to the component at execution time. Accepts a string of length between 0 to 256.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLORepositoryComponent -FileName "cp034766.exe" -ExecutionParameters "/silent /force" -Criticality Recommended</dev:code> <dev:remarks> <maml:para>This cmdlet adds the maintenance window to iLO 5 when the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLORepositoryComponent -FileName "ilo5_135.bin" -ExecutionParameters "/silent /force" -Criticality Recommended</dev:code> <dev:remarks> <maml:para>This cmdlet adds the maintenance window on iLO 5 with an array of connection objects passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLORepositoryComponent</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLORepositoryComponent</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>Set-HPEiLOSecureBoot</command:name> <maml:description> <maml:para>Enables the secure boot mode.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOSecureBoot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOSecureBoot cmdlet enables or disables the secure boot feature. This cmdlet is supported only in iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOSecureBoot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SecureBootEnable</maml:name> <maml:description> <maml:para>Enable or disable UEFI Secure Boot (takes effect on next boot). Supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SecureBootEnable</maml:name> <maml:description> <maml:para>Enable or disable UEFI Secure Boot (takes effect on next boot). Supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOSecureBoot -SecureBootEnable Yes</dev:code> <dev:remarks> <maml:para>This cmdlet sets SecureBootEnable on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1-2 -Username admin -Password admin123 PS C:\> Set-HPEiLOSecureBoot -Connection $connection -SecureBootEnable Yes</dev:code> <dev:remarks> <maml:para>This cmdlet sets SecurityState on iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSecureBoot</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>Set-HPEiLOServerPower</command:name> <maml:description> <maml:para>Toggles the power on the host server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOServerPower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOServerPower cmdlet toggles the power on the host server in which the iLO is executing.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOServerPower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Power</maml:name> <maml:description> <maml:para>The power state of the server. The supported values are On, Off, Reset, MomentaryPress, PressAndHold, ColdBoot,AuxCycle, NMI, GracefulShutdown and PushPowerButton.</maml:para> <maml:para>WARNING : In case of iLO 5 servers, when AuxCycle is set successfully, the connection is lost.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">On</command:parameterValue> <command:parameterValue required="false" variableLength="false">Off</command:parameterValue> <command:parameterValue required="false" variableLength="false">Reset</command:parameterValue> <command:parameterValue required="false" variableLength="false">MomentaryPress</command:parameterValue> <command:parameterValue required="false" variableLength="false">PressAndHold</command:parameterValue> <command:parameterValue required="false" variableLength="false">ColdBoot</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuxCycle</command:parameterValue> <command:parameterValue required="false" variableLength="false">NMI</command:parameterValue> <command:parameterValue required="false" variableLength="false">GracefulShutdown</command:parameterValue> <command:parameterValue required="false" variableLength="false">PushPowerButton</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Power</maml:name> <maml:description> <maml:para>The power state of the server. The supported values are On, Off, Reset, MomentaryPress, PressAndHold, ColdBoot,AuxCycle, NMI, GracefulShutdown and PushPowerButton.</maml:para> <maml:para>WARNING : In case of iLO 5 servers, when AuxCycle is set successfully, the connection is lost.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">On</command:parameterValue> <command:parameterValue required="false" variableLength="false">Off</command:parameterValue> <command:parameterValue required="false" variableLength="false">Reset</command:parameterValue> <command:parameterValue required="false" variableLength="false">MomentaryPress</command:parameterValue> <command:parameterValue required="false" variableLength="false">PressAndHold</command:parameterValue> <command:parameterValue required="false" variableLength="false">ColdBoot</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuxCycle</command:parameterValue> <command:parameterValue required="false" variableLength="false">NMI</command:parameterValue> <command:parameterValue required="false" variableLength="false">GracefulShutdown</command:parameterValue> <command:parameterValue required="false" variableLength="false">PushPowerButton</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOServerPower -Power On</dev:code> <dev:remarks> <maml:para>This cmdlet sets the Server Power on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Set-HPEiLOServerPower -Connection $connection -Power On</dev:code> <dev:remarks> <maml:para>This cmdlet sets the Server Power on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOServerPower</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>Set-HPEiLOServerPowerRestoreSetting</command:name> <maml:description> <maml:para>Sets the automatic power-on and power-on-delay settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOServerPowerRestoreSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOServerPowerRestoreSetting cmdlet sets the automatic power-on and power-on-delay settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOServerPowerRestoreSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AutoPower</maml:name> <maml:description> <maml:para>Sets the AutoPower value. The supported values are : • Yes - Enable automatic power on with a minimum delay (Not supported on iLO 5) • No - APO Restore Last Power State (Not supported on iLO 5) • On - APO Always Power On • Off - APO Always Remain Off • Restore - APO Restore Last Power State</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">On</command:parameterValue> <command:parameterValue required="false" variableLength="false">Off</command:parameterValue> <command:parameterValue required="false" variableLength="false">Restore</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerOnDelay</maml:name> <maml:description> <maml:para>Sets the power on Delay value. The supported values are: • Minimum (Not supported on iLO 4) • 15Sec • 30Sec • 45Sec • 60Sec • RandomUpTo120Sec</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Minimum</command:parameterValue> <command:parameterValue required="false" variableLength="false">15Sec</command:parameterValue> <command:parameterValue required="false" variableLength="false">30Sec</command:parameterValue> <command:parameterValue required="false" variableLength="false">45Sec</command:parameterValue> <command:parameterValue required="false" variableLength="false">60Sec</command:parameterValue> <command:parameterValue required="false" variableLength="false">RandomUpTo120Sec</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AutoPower</maml:name> <maml:description> <maml:para>Sets the AutoPower value. The supported values are : • Yes - Enable automatic power on with a minimum delay (Not supported on iLO 5) • No - APO Restore Last Power State (Not supported on iLO 5) • On - APO Always Power On • Off - APO Always Remain Off • Restore - APO Restore Last Power State</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">On</command:parameterValue> <command:parameterValue required="false" variableLength="false">Off</command:parameterValue> <command:parameterValue required="false" variableLength="false">Restore</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerOnDelay</maml:name> <maml:description> <maml:para>Sets the power on Delay value. The supported values are: • Minimum (Not supported on iLO 4) • 15Sec • 30Sec • 45Sec • 60Sec • RandomUpTo120Sec</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Minimum</command:parameterValue> <command:parameterValue required="false" variableLength="false">15Sec</command:parameterValue> <command:parameterValue required="false" variableLength="false">30Sec</command:parameterValue> <command:parameterValue required="false" variableLength="false">45Sec</command:parameterValue> <command:parameterValue required="false" variableLength="false">60Sec</command:parameterValue> <command:parameterValue required="false" variableLength="false">RandomUpTo120Sec</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOServerPowerRestoreSetting -AutoPower On -PowerOnDelay 30Sec</dev:code> <dev:remarks> <maml:para>This cmdlet sets the PowerRestoreSetting and PowerAutoOn on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Set-HPEiLOServerPowerRestoreSetting -Connection $connection -AutoPower On -PowerOnDelay 30Sec</dev:code> <dev:remarks> <maml:para>This cmdlet sets the PowerRestoreSetting and PowerAutoOn on iLO 4 and iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOServerPowerRestoreSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Set-HPEiLOServicePort</command:name> <maml:description> <maml:para>Sets the service port detail.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOServicePort</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOServicePort sets the service port detail. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOServicePort</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLOServicePortEnabled</maml:name> <maml:description> <maml:para>Indicates whether the iLO Service Port is enabled or not. Supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>USBFlashDriveEnabled</maml:name> <maml:description> <maml:para>Indicates whether the USB Flash Drive is enabled or not. Supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MassStorageAuthenticationRequired</maml:name> <maml:description> <maml:para>Indicates whether mass storage authentication is required or not. Supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>USBEthernetAdaptersEnabled</maml:name> <maml:description> <maml:para>Indicates whether the USB Ethernet Adapters are enabled or not. Supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iLOServicePortEnabled</maml:name> <maml:description> <maml:para>Indicates whether the iLO Service Port is enabled or not. Supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>USBFlashDriveEnabled</maml:name> <maml:description> <maml:para>Indicates whether the USB Flash Drive is enabled or not. Supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MassStorageAuthenticationRequired</maml:name> <maml:description> <maml:para>Indicates whether mass storage authentication is required or not. Supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>USBEthernetAdaptersEnabled</maml:name> <maml:description> <maml:para>Indicates whether the USB Ethernet Adapters are enabled or not. Supported values are Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOServicePort -iLOServicePortEnabled Yes -USBFlashDriveEnabled Yes -MassStorageAuthenticationRequired No -USBEthernetAdaptersEnabled Yes</dev:code> <dev:remarks> <maml:para>This cmdlet sets Service port detail on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEiLOServicePort -Connection $connection -iLOServicePortEnabled Yes -USBFlashDriveEnabled Yes -MassStorageAuthenticationRequired No -USBEthernetAdaptersEnabled Yes</dev:code> <dev:remarks> <maml:para>This cmdlet sets iLO Service port on iLO 5 with an array of connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOServicePort</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>Set-HPEiLOSMHFQDN</command:name> <maml:description> <maml:para>Sets the fully qualified domain name for SMH and allows it to be placed at a different FQDN or IP address.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOSMHFQDN</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOSMHFQDN cmdlet allows you to place the system management homepage at a separate FQDN or IP address from the server. This cmdlet is supported only on iLO 4 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOSMHFQDN</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SMHFQDN</maml:name> <maml:description> <maml:para>Specifies the SMH FQDN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SMHFQDN</maml:name> <maml:description> <maml:para>Specifies the SMH FQDN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOSMHFQDN -SMHFQDN abc.example.com</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SMH FQDN on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Set-HPEiLOSMHFQDN -Connection $connection -SMHFQDN abc.example.com</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SMH FQDN on iLO 4 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSMHFQDN</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>Set-HPEiLOSNMPAlertDestination</command:name> <maml:description> <maml:para>Modifies the SNMP alert destination.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOSNMPAlertDestination</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOSNMPAlertDestination cmdlet modifies the SNMP alert destination.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOSNMPAlertDestination</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>The unique identifier ID for each Alert destination.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertDestination</maml:name> <maml:description> <maml:para>The IP address or FQDN of remote management system that receive SNMP alerts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertProtocol</maml:name> <maml:description> <maml:para>Indicates the SNMP protocol associated with the AlertDestination. Supported values are SNMPv1trap, SNMPv3trap, and SNMPv3Inform. This parameter is supported only on iLO 5 server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SNMPv1Trap</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3Trap</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3Inform</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TrapCommunity</maml:name> <maml:description> <maml:para>The configured SNMPv1 trap community string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TrapCommunityVersion</maml:name> <maml:description> <maml:para>The trap community version for the trap community mentioned. This cmdlet is supported only on iLO 4 server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPv3User</maml:name> <maml:description> <maml:para>Provides the SNMPv3 security name associated with SNMPv3trap or SNMPv3Inform set on SNMPAlertProtocol. This parameter is supported only on iLO 5 server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>The unique identifier ID for each Alert destination.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertDestination</maml:name> <maml:description> <maml:para>The IP address or FQDN of remote management system that receive SNMP alerts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertProtocol</maml:name> <maml:description> <maml:para>Indicates the SNMP protocol associated with the AlertDestination. Supported values are SNMPv1trap, SNMPv3trap, and SNMPv3Inform. This parameter is supported only on iLO 5 server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SNMPv1Trap</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3Trap</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3Inform</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TrapCommunity</maml:name> <maml:description> <maml:para>The configured SNMPv1 trap community string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TrapCommunityVersion</maml:name> <maml:description> <maml:para>The trap community version for the trap community mentioned. This cmdlet is supported only on iLO 4 server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPv3User</maml:name> <maml:description> <maml:para>Provides the SNMPv3 security name associated with SNMPv3trap or SNMPv3Inform set on SNMPAlertProtocol. This parameter is supported only on iLO 5 server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.Int32[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOSNMPAlertDestination -ID 2 -AlertDestination 2.2.2.2 -TrapCommunity 1.1.1.1 -TrapCommunityVersion v1</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMP alert destination on iLO 4 with connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOSNMPAlertDestination -ID 2 -AlertDestination 2.2.2.2 -AlertProtocol SNMPv3trap -TrapCommunity 1.1.1.1 -SNMPv3User admin</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMP alert destination on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Set-HPEiLOSNMPAlertDestination -Connection $connection -ID 2 -AlertDestination 2.2.2.2 -TrapCommunity 1.1.1.1</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMP alert destination on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSNMPAlertDestination</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOSNMPAlertDestination</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOSNMPAlertDestination</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>Set-HPEiLOSNMPAlertSetting</command:name> <maml:description> <maml:para>Sets the SNMP alert setting.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOSNMPAlertSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOSNMPAlertSetting sets the SNMP alert setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOSNMPAlertSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertEnabled</maml:name> <maml:description> <maml:para>The alert conditions that the management processor detects independently of the host operating system can be sent to specified SNMP alert destinations. Supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TrapSourceIdentifier</maml:name> <maml:description> <maml:para>Determines the host name that is used in the SNMP-defined sysName variable when the management processor generates SNMP traps. Supported values are iLOHostname and OSHostname.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">iLOHostname</command:parameterValue> <command:parameterValue required="false" variableLength="false">OSHostname</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ColdStartTrapBroadcast</maml:name> <maml:description> <maml:para>If there are any component in health status array(HSA) Trap are in degraded or failed condition then HSA trap will be sent periodically till the component status becomes ok or fine condition. This setting is disabled by default. Supported values are Disabled, Daily, Weekly, and Monthly.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPv1Trap</maml:name> <maml:description> <maml:para>Sets whether SNMPv1 traps are sent. Valid values are Enabled and Disabled. In case of iLO 5, this parameter is not supported from 1.20 firmware onwards.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OSTrap</maml:name> <maml:description> <maml:para>Determines if the user is allowed to receive SNMP traps that are generated by the operating system. The possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebAgentIPAddress</maml:name> <maml:description> <maml:para>Specifies the address for the Web-enabled agents. The value for this element has a maximum length of 50 characters. It can be any valid IP address. If an empty string is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PeriodicHSATrapConfiguration</maml:name> <maml:description> <maml:para>If enabled, the Cold Start Trap will be enabled. The Cold Start Trap is broadcast to a subnet broadcast address if there are no trap destinations configured in the SNMP Alert Destination(s) boxes. The supported values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Daily</command:parameterValue> <command:parameterValue required="false" variableLength="false">Weekly</command:parameterValue> <command:parameterValue required="false" variableLength="false">Monthly</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AlertEnabled</maml:name> <maml:description> <maml:para>The alert conditions that the management processor detects independently of the host operating system can be sent to specified SNMP alert destinations. Supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TrapSourceIdentifier</maml:name> <maml:description> <maml:para>Determines the host name that is used in the SNMP-defined sysName variable when the management processor generates SNMP traps. Supported values are iLOHostname and OSHostname.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">iLOHostname</command:parameterValue> <command:parameterValue required="false" variableLength="false">OSHostname</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ColdStartTrapBroadcast</maml:name> <maml:description> <maml:para>If there are any component in health status array(HSA) Trap are in degraded or failed condition then HSA trap will be sent periodically till the component status becomes ok or fine condition. This setting is disabled by default. Supported values are Disabled, Daily, Weekly, and Monthly.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPv1Trap</maml:name> <maml:description> <maml:para>Sets whether SNMPv1 traps are sent. Valid values are Enabled and Disabled. In case of iLO 5, this parameter is not supported from 1.20 firmware onwards.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OSTrap</maml:name> <maml:description> <maml:para>Determines if the user is allowed to receive SNMP traps that are generated by the operating system. The possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WebAgentIPAddress</maml:name> <maml:description> <maml:para>Specifies the address for the Web-enabled agents. The value for this element has a maximum length of 50 characters. It can be any valid IP address. If an empty string is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PeriodicHSATrapConfiguration</maml:name> <maml:description> <maml:para>If enabled, the Cold Start Trap will be enabled. The Cold Start Trap is broadcast to a subnet broadcast address if there are no trap destinations configured in the SNMP Alert Destination(s) boxes. The supported values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Daily</command:parameterValue> <command:parameterValue required="false" variableLength="false">Weekly</command:parameterValue> <command:parameterValue required="false" variableLength="false">Monthly</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOSNMPAlertSetting -AlertEnabled Yes -TrapSourceIdentifier iLOHostname -OSTrap Enabled</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMP alert setting on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOSNMPAlertSetting -AlertEnabled Yes -SNMPv1Trap Enabled -ColdStartTrapBroadcast Enabled -PeriodicHSATrapConfiguration Monthly</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMP alert setting on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Set-HPEiLOSNMPAlertSetting -Connection $connection -AlertEnabled Yes -PeriodicHSATrapConfiguration Monthly</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMP alert setting on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSNMPAlertSetting</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>Set-HPEiLOSNMPPowerAlertThreshold</command:name> <maml:description> <maml:para>Sets the power alert threshold value for the iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOSNMPPowerAlertThreshold</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set-HPEiLOPowerAlertThreshold cmdlet sets the power alert threshold for iLO devices. It also sets the type of alert and duration of sample time. You must purchase the iLO Advanced license to enable this feature. For iLO 4 servers, all the three parameters are mandatory.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOSNMPPowerAlertThreshold</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerAlertType</maml:name> <maml:description> <maml:para>Specifies the type of power alert. Valid values are: • Disabled - No power alerts are set. If you select Disabled, the values for Threshold and Duration do not matter. • Peak - Represents the half-second average power reading during the sample. • Average - Represents the mean power reading during the sample.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Average</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Peak</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerAlertThreshold</maml:name> <maml:description> <maml:para>Sets the alert threshold, in Watts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerAlertDuration</maml:name> <maml:description> <maml:para>Sets the length of the sample time, in minutes, starting at 5. Duration will always be in 5 minute intervals up to 240 minutes maximum. Any positive integer can be used, but it will be rounded off to the nearest 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerAlertType</maml:name> <maml:description> <maml:para>Specifies the type of power alert. Valid values are: • Disabled - No power alerts are set. If you select Disabled, the values for Threshold and Duration do not matter. • Peak - Represents the half-second average power reading during the sample. • Average - Represents the mean power reading during the sample.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Average</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Peak</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerAlertThreshold</maml:name> <maml:description> <maml:para>Sets the alert threshold, in Watts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PowerAlertDuration</maml:name> <maml:description> <maml:para>Sets the length of the sample time, in minutes, starting at 5. Duration will always be in 5 minute intervals up to 240 minutes maximum. Any positive integer can be used, but it will be rounded off to the nearest 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOSNMPPowerAlertThreshold -PowerAlertType Average -PowerAlertThreshold 300 -PowerAlertDuration 10</dev:code> <dev:remarks> <maml:para>This cmdlet sets the power alert threshold type, value and duration on iLO 4 or iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Set-HPEiLOSNMPPowerAlertThreshold -Connection $connection -PowerAlertType Average -PowerAlertThreshold 300 -PowerAlertDuration 10</dev:code> <dev:remarks> <maml:para>This cmdlet sets the power alert threshold type, value and duration on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSNMPPowerAlertThreshold</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>Set-HPEiLOSNMPSetting</command:name> <maml:description> <maml:para>Sets the SNMP setting</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOSNMPSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOSNMPSetting sets the SNMP setting</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOSNMPSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPConnectedVia</maml:name> <maml:description> <maml:para>Specifies the SNMP connection to the iLO. Supported values are AgentlessManagement, SNMPPass-Through. SNMPConnectedVia must be set to AgentlessManagement in order to set SystemLocation, SystemContact, SystemRole, SystemRoleDetail, ReadCommunity1, ReadCommunity2 and ReadCommunity3. This parameter is supported only on iLO 4 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AgentlessManagement</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPPass-Through</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemLocation</maml:name> <maml:description> <maml:para>The string of up to 49 characters that specifies the physical location of the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemContact</maml:name> <maml:description> <maml:para>The string of up to 49 characters that specifies the system administrator or server owner. The string can include a name, email address, or phone number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRole</maml:name> <maml:description> <maml:para>The string of up to 64 characters that describes the server role or function.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRoleDetail</maml:name> <maml:description> <maml:para>The string of up to 512 characters that describes specific tasks that the server might perform.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReadCommunity1</maml:name> <maml:description> <maml:para>Configures the SNMP read-only community 1 string. Values can include a community string, optionally followed by an IP address or FQDN. A string of up to 49 characters is allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReadCommunity2</maml:name> <maml:description> <maml:para>Configures the SNMP read-only community 2 string. Values can include a community string, optionally followed by an IP address or FQDN. A string of up to 49 characters is allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReadCommunity3</maml:name> <maml:description> <maml:para>Configures the SNMP read-only community 3 string. Values can include a community string, optionally followed by an IP address or FQDN. A string of up to 49 characters is allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPConnectedVia</maml:name> <maml:description> <maml:para>Specifies the SNMP connection to the iLO. Supported values are AgentlessManagement, SNMPPass-Through. SNMPConnectedVia must be set to AgentlessManagement in order to set SystemLocation, SystemContact, SystemRole, SystemRoleDetail, ReadCommunity1, ReadCommunity2 and ReadCommunity3. This parameter is supported only on iLO 4 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AgentlessManagement</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPPass-Through</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemLocation</maml:name> <maml:description> <maml:para>The string of up to 49 characters that specifies the physical location of the server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemContact</maml:name> <maml:description> <maml:para>The string of up to 49 characters that specifies the system administrator or server owner. The string can include a name, email address, or phone number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRole</maml:name> <maml:description> <maml:para>The string of up to 64 characters that describes the server role or function.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRoleDetail</maml:name> <maml:description> <maml:para>The string of up to 512 characters that describes specific tasks that the server might perform.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReadCommunity1</maml:name> <maml:description> <maml:para>Configures the SNMP read-only community 1 string. Values can include a community string, optionally followed by an IP address or FQDN. A string of up to 49 characters is allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReadCommunity2</maml:name> <maml:description> <maml:para>Configures the SNMP read-only community 2 string. Values can include a community string, optionally followed by an IP address or FQDN. A string of up to 49 characters is allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ReadCommunity3</maml:name> <maml:description> <maml:para>Configures the SNMP read-only community 3 string. Values can include a community string, optionally followed by an IP address or FQDN. A string of up to 49 characters is allowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOSNMPSetting -SNMPConnectedVia AgentlessManagement -SystemLocation 1.1.1.1 -SystemContact admin -SystemRole LabAdmin -SystemRoleDetail testsnmp</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMP setting on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOSNMPSetting -ReadCommunity1 3.3.3.3 -ReadCommunity2 1.1.1.1 -ReadCommunity3 2.2.2.2</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMP setting on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Set-HPEiLOSNMPSetting -Connection $connection -SystemLocation 1.1.1.1 -SystemContact admin -SystemRole LabAdmin -SystemRoleDetail testsnmp</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMP setting on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSNMPSetting</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>Set-HPEiLOSNMPv3Setting</command:name> <maml:description> <maml:para>Sets the SNMPv3 setting</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOSNMPv3Setting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOSNMPv3Setting cmdlet sets the SNMPv3 setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOSNMPv3Setting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPv3EngineID</maml:name> <maml:description> <maml:para>The SNMPv3 Engine ID is the unique identifier of an SNMP engine that belongs to an SNMP agent entity. This value must be a hexadecimal string with an even number of 6 to 32 characters, excluding the first two characters, 0x (for example, 0x01020304abcdef).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPv3InformRetryAttempt</maml:name> <maml:description> <maml:para>Specifies the number of retries to be used in SNMPv3 inform. Supported values are 0-5. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPv3InformRetryIntervalSeconds</maml:name> <maml:description> <maml:para>Specifies the interval in seconds between SNMPv3 inform retries. Supported values are 5-120. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPv3EngineID</maml:name> <maml:description> <maml:para>The SNMPv3 Engine ID is the unique identifier of an SNMP engine that belongs to an SNMP agent entity. This value must be a hexadecimal string with an even number of 6 to 32 characters, excluding the first two characters, 0x (for example, 0x01020304abcdef).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPv3InformRetryAttempt</maml:name> <maml:description> <maml:para>Specifies the number of retries to be used in SNMPv3 inform. Supported values are 0-5. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNMPv3InformRetryIntervalSeconds</maml:name> <maml:description> <maml:para>Specifies the interval in seconds between SNMPv3 inform retries. Supported values are 5-120. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.Int32[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOSNMPv3Setting -SNMPv3EngineID 0x01020304abcdef</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMPv3setting on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOSNMPv3Setting -SNMPv3EngineID 0x01020304abcdef -SNMPv3InformRetryAttempt 5 -SNMPv3InformRetryIntervalSeconds 100</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMPv3setting on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Set-HPEiLOSNMPv3Setting -Connection $connection -SNMPv3EngineID 0x01020304abcdef</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMPv3setting on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSNMPv3Setting</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>Set-HPEiLOSNMPv3User</command:name> <maml:description> <maml:para>Sets the SNMPv3User details.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOSNMPv3User</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOSNMPv3User cmdlet sets the SNPv3User details</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOSNMPv3User</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>The unique identifier ID for each Alert destination. The supported values for iLO 4 are 1,2,3. The supported values for iLO 5 are 1-8.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SecurityName</maml:name> <maml:description> <maml:para>Provides the SNMPv3 security name associated with SNMPv3trap or SNMPv3Inform set on SNMPAlertProtocol. This parameter is supported only on iLO 5 server. The maximum allowable length is 32.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationProtocol</maml:name> <maml:description> <maml:para>Sets the message digest algorithm to use for encoding the authorization passphrase. The message digest is calculated over an appropriate portion of an SNMP message, and is included as part of the message sent to the recipient. Supported values are MD5 and SHA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MD5</command:parameterValue> <command:parameterValue required="false" variableLength="false">SHA</command:parameterValue> <command:parameterValue required="false" variableLength="false">SHA256</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationPassphrase</maml:name> <maml:description> <maml:para>Sets the passphrase to use for sign operations. Enter a value of 8 to 49 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PrivacyProtocol</maml:name> <maml:description> <maml:para>Sets the encryption algorithm to use for encoding the privacy passphrase. A portion of an SNMP message is encrypted before transmission. Supported values are AES and DES.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DES</command:parameterValue> <command:parameterValue required="false" variableLength="false">AES</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PrivacyPassphrase</maml:name> <maml:description> <maml:para>Sets the passphrase to use for encrypt operations. Enter a value between 8 to 49 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserEngineID</maml:name> <maml:description> <maml:para>The UserEngineID is combined with the SecurityName to create a SNMPv3 user for each manager. It is only used for creating remote accounts used with INFORM messages. If this property is not set then INFORM message will be sent with default or iLO configured engine ID. This value must be a hexadecimal string with an even number of 10 to 64 characters, excluding the first two characters, 0x (for example, 0x01020304abcdef). Supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ID</maml:name> <maml:description> <maml:para>The unique identifier ID for each Alert destination. The supported values for iLO 4 are 1,2,3. The supported values for iLO 5 are 1-8.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SecurityName</maml:name> <maml:description> <maml:para>Provides the SNMPv3 security name associated with SNMPv3trap or SNMPv3Inform set on SNMPAlertProtocol. This parameter is supported only on iLO 5 server. The maximum allowable length is 32.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationProtocol</maml:name> <maml:description> <maml:para>Sets the message digest algorithm to use for encoding the authorization passphrase. The message digest is calculated over an appropriate portion of an SNMP message, and is included as part of the message sent to the recipient. Supported values are MD5 and SHA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MD5</command:parameterValue> <command:parameterValue required="false" variableLength="false">SHA</command:parameterValue> <command:parameterValue required="false" variableLength="false">SHA256</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AuthenticationPassphrase</maml:name> <maml:description> <maml:para>Sets the passphrase to use for sign operations. Enter a value of 8 to 49 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PrivacyProtocol</maml:name> <maml:description> <maml:para>Sets the encryption algorithm to use for encoding the privacy passphrase. A portion of an SNMP message is encrypted before transmission. Supported values are AES and DES.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DES</command:parameterValue> <command:parameterValue required="false" variableLength="false">AES</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PrivacyPassphrase</maml:name> <maml:description> <maml:para>Sets the passphrase to use for encrypt operations. Enter a value between 8 to 49 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserEngineID</maml:name> <maml:description> <maml:para>The UserEngineID is combined with the SecurityName to create a SNMPv3 user for each manager. It is only used for creating remote accounts used with INFORM messages. If this property is not set then INFORM message will be sent with default or iLO configured engine ID. This value must be a hexadecimal string with an even number of 10 to 64 characters, excluding the first two characters, 0x (for example, 0x01020304abcdef). Supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.Int32[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOSNMPv3User -ID 2 -SecurityName admin -AuthenticationProtocol MD5 -AuthenticationPassphrase admin123 -PrivacyProtocol AES -PrivacyPassphrase admin123</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMPv3User on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> ,$connection | Set-HPEiLOSNMPv3User -ID 2 -SecurityName testsnmp -UserEngineID 0x01020304abcdef -AuthenticationProtocol MD5 -AuthenticationPassphrase admin123 -PrivacyProtocol AES -PrivacyPassphrase admin123</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMPv3User on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\> Set-HPEiLOSNMPv3User -Connection $connection -ID 2 -SecurityName admin -AuthenticationProtocol MD5 -AuthenticationPassphrase admin123 -PrivacyProtocol AES -PrivacyPassphrase admin123</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNMPv3User on iLO 4 and iLO 5 with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSNMPv3User</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOSNMPv3User</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOSNMPv3User</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>Set-HPEiLOSNTPSetting</command:name> <maml:description> <maml:para>Sets the SNTP setting</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOSNTPSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOSNTPSetting cmdlet sets the SNTP settings of the server.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOSNTPSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>InterfaceType specifies the type of network connection present in the manager. The possible values are Dedicated and Shared. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dedicated</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shared</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4NTPServer</maml:name> <maml:description> <maml:para>Determines whether iLO has to get the SNTP time servers and time zone from the DHCPv4 server or whether the user enters that information manually. The possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6NTPServer</maml:name> <maml:description> <maml:para>Determines whether iLO has to get the SNTP time servers and time zone from the DHCPv6 server or whether the user enters that information manually. The possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PropagateTimetoHost</maml:name> <maml:description> <maml:para>Determines whether iLO sets the system host time to match the iLO time. Valid values are Enabled to enable this feature or Disabled to disable this feature. If enabled, the propagation time set occurs whenever the iLO is cold-booted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNTPServer</maml:name> <maml:description> <maml:para>Specifies the IP address of an IPv4 or IPv6 SNTP server or the FQDN of an SNTPserver. The FQDN must adhere to the DNS standard, For example, time.nist.gov. The iLO firmware contacts tPrimary Time for the UTC time. If iLO is unable to contact Primary Time server, it attempts to contact the Secondary Time Server. This parameter is only relevant if DHCPv4NTPServer and DHCPv6NTPServer are set to Disabled. If an empty string is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Timezone</maml:name> <maml:description> <maml:para>Specifies the current time zone from the Olson database. The text of the time zone name must be entered exactly as it appears in the SNTP Settings time zone list box, (minus the GMT offset). America/Anchorage or Europe/Zurich are two examples of a valid time zone.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>InterfaceType</maml:name> <maml:description> <maml:para>InterfaceType specifies the type of network connection present in the manager. The possible values are Dedicated and Shared. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Dedicated</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shared</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4NTPServer</maml:name> <maml:description> <maml:para>Determines whether iLO has to get the SNTP time servers and time zone from the DHCPv4 server or whether the user enters that information manually. The possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv6NTPServer</maml:name> <maml:description> <maml:para>Determines whether iLO has to get the SNTP time servers and time zone from the DHCPv6 server or whether the user enters that information manually. The possible values are Enabled and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PropagateTimetoHost</maml:name> <maml:description> <maml:para>Determines whether iLO sets the system host time to match the iLO time. Valid values are Enabled to enable this feature or Disabled to disable this feature. If enabled, the propagation time set occurs whenever the iLO is cold-booted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SNTPServer</maml:name> <maml:description> <maml:para>Specifies the IP address of an IPv4 or IPv6 SNTP server or the FQDN of an SNTPserver. The FQDN must adhere to the DNS standard, For example, time.nist.gov. The iLO firmware contacts tPrimary Time for the UTC time. If iLO is unable to contact Primary Time server, it attempts to contact the Secondary Time Server. This parameter is only relevant if DHCPv4NTPServer and DHCPv6NTPServer are set to Disabled. If an empty string is entered, the current value is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[][]</command:parameterValue> <dev:type> <maml:name>String[][]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Timezone</maml:name> <maml:description> <maml:para>Specifies the current time zone from the Olson database. The text of the time zone name must be entered exactly as it appears in the SNTP Settings time zone list box, (minus the GMT offset). America/Anchorage or Europe/Zurich are two examples of a valid time zone.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.String[][] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> $sntp = ,@("1.1.1.1","2.2.2.2") PS C:\> ,$connection | Set-HPEiLOSNTPSetting -DHCPv4NTPServer Disabled -DHCPv6NTPServer Disabled -PropagateTimetoHost Enabled -Timezone America/Anchorage -SNTPServer $sntp</dev:code> <dev:remarks> <maml:para>This example sets the SNTP setting on iLO 4 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> $sntp = ,@("1.1.1.1","2.2.2.2") PS C:\> ,$connection | Set-HPEiLOSNTPSetting -InterfaceType Dedicated -DHCPv4NTPServer Disabled -DHCPv6NTPServer Disabled -PropagateTimetoHost Enabled -Timezone America/Anchorage -SNTPServer $sntp</dev:code> <dev:remarks> <maml:para>This example sets the SNTP setting on iLO 5 with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $sntp = ,@("1.1.1.1","2.2.2.2") PS C:\> Set-HPEiLOSNTPSetting -Connection $connection -DHCPv4NTPServer Disabled -DHCPv6NTPServer Disabled -PropagateTimetoHost Enabled -Timezone America/Anchorage -SNTPServer $sntp</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SNTP setting on iLO 4 and iLO 5 with an array of connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSNTPSetting</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>Set-HPEiLOSSOSetting</command:name> <maml:description> <maml:para>Modifies the SSO settings for the iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOSSOSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOSSOSetting cmdlet modifies the SSO settings for iLO.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOSSOSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TrustMode</maml:name> <maml:description> <maml:para>Sets the Single Sign-On trust mode. The current setting is unchanged if this setting is omitted from the script. Accepted values are: • TrustNone - Disables HPE SIM SSO on this processor. • TrustbyCertificate - Accepts only SSO requests authenticated using a certificate. • TrustbyName - Trusts SSO requests from the named HPE SIM server. • TrustAll - Accepts any SSO request from the network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">TrustNone</command:parameterValue> <command:parameterValue required="false" variableLength="false">TrustAll</command:parameterValue> <command:parameterValue required="false" variableLength="false">TrustbyName</command:parameterValue> <command:parameterValue required="false" variableLength="false">TrustbyCertificate</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleUserConfigPrivilege</maml:name> <maml:description> <maml:para>Allows login for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleRemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Grants access to remote console resources for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleVirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Grants access to virtual media resources for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleLoginPrivilege</maml:name> <maml:description> <maml:para>Allows local user account modification for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleVirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Grants access to power and reset controls for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleiLOConfigPrivilege</maml:name> <maml:description> <maml:para>Allows iLO settings modification for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleHostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host BIOS settings modification for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only in iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleHostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host NIC settings modification for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only in iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleHostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host Storage settings modification for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleSystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Allows System Recovery settings modification for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleUserConfigPrivilege</maml:name> <maml:description> <maml:para>Allows login for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleRemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Grants access to remote console resources for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleVirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Grants access to virtual media resources for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleLoginPrivilege</maml:name> <maml:description> <maml:para>Allows local user account modification for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleVirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Grants access to power and reset controls for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleiLOConfigPrivilege</maml:name> <maml:description> <maml:para>Allows iLO settings modification for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleHostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host BIOS settings modification for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleHostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host NIC settings modification for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only in iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleHostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host Storage settings modification for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleSystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Allows System Recovery settings modification for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleUserConfigPrivilege</maml:name> <maml:description> <maml:para>Allows login for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleRemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Grants access to remote console resources for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleVirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Grants access to virtual media resources for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleLoginPrivilege</maml:name> <maml:description> <maml:para>Allows local user account modification for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleVirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Grants access to power and reset controls for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleiLOConfigPrivilege</maml:name> <maml:description> <maml:para>Allows iLO settings modification for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleHostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host BIOS settings modification for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleHostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host NIC settings modification for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleHostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host Storage settings modification for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleSystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Allows System Recovery settings modification for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TrustMode</maml:name> <maml:description> <maml:para>Sets the Single Sign-On trust mode. The current setting is unchanged if this setting is omitted from the script. Accepted values are: • TrustNone - Disables HPE SIM SSO on this processor. • TrustbyCertificate - Accepts only SSO requests authenticated using a certificate. • TrustbyName - Trusts SSO requests from the named HPE SIM server. • TrustAll - Accepts any SSO request from the network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">TrustNone</command:parameterValue> <command:parameterValue required="false" variableLength="false">TrustAll</command:parameterValue> <command:parameterValue required="false" variableLength="false">TrustbyName</command:parameterValue> <command:parameterValue required="false" variableLength="false">TrustbyCertificate</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleUserConfigPrivilege</maml:name> <maml:description> <maml:para>Allows login for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleRemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Grants access to remote console resources for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleVirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Grants access to virtual media resources for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleLoginPrivilege</maml:name> <maml:description> <maml:para>Allows local user account modification for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleVirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Grants access to power and reset controls for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleiLOConfigPrivilege</maml:name> <maml:description> <maml:para>Allows iLO settings modification for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleHostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host BIOS settings modification for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only in iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleHostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host NIC settings modification for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only in iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleHostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host Storage settings modification for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserRoleSystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Allows System Recovery settings modification for the User role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleUserConfigPrivilege</maml:name> <maml:description> <maml:para>Allows login for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleRemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Grants access to remote console resources for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleVirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Grants access to virtual media resources for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleLoginPrivilege</maml:name> <maml:description> <maml:para>Allows local user account modification for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleVirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Grants access to power and reset controls for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleiLOConfigPrivilege</maml:name> <maml:description> <maml:para>Allows iLO settings modification for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleHostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host BIOS settings modification for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleHostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host NIC settings modification for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only in iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleHostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host Storage settings modification for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperatorRoleSystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Allows System Recovery settings modification for the Operator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleUserConfigPrivilege</maml:name> <maml:description> <maml:para>Allows login for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleRemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Grants access to remote console resources for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleVirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Grants access to virtual media resources for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleLoginPrivilege</maml:name> <maml:description> <maml:para>Allows local user account modification for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleVirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Grants access to power and reset controls for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleiLOConfigPrivilege</maml:name> <maml:description> <maml:para>Allows iLO settings modification for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleHostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host BIOS settings modification for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleHostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host NIC settings modification for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleHostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Allows Host Storage settings modification for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AdministratorRoleSystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Allows System Recovery settings modification for the Administrator role. If this privilege is omitted, the current value is unchanged. The privilege assignment is Boolean and can be set to Yes or No. This parameter is supported only on iLO 5 servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOSSOSetting -TrustMode All -UserRoleUserConfigPrivilege Yes -UserRoleRemoteConsolePrivilege No -UserRoleVirtualMediaPrivilege yes -UserRoleLoginPrivilege yes -UserRoleVirtualPowerAndResetPrivilege No -UserRoleiLOConfigPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet sets the TrustMode and UserRole privileges for iLO 4, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOSSOSetting -OperatorUserConfigPrivilege Yes -OperatorRemoteConsolePrivilege No -OperatorVirtualMediaPrivilege yes -OperatorLoginPrivilege yes -OperatorVirtualPowerAndResetPrivilege No -OperatoriLOConfigPrivilege Yes -AdministratorUserConfigPrivilege Yes -AdministratorRemoteConsolePrivilege No -AdministratorVirtualMediaPrivilege yes -AdministratorLoginPrivilege yes -AdministratorVirtualPowerAndResetPrivilege No -AdministratoriLOConfigPrivilege Yes</dev:code> <dev:remarks> <maml:para>This cmdlet sets the Operator and Adminstrator role for iLO 4, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> Set-HPEiLOSSOSetting -Connection $connection -UserRoleHostBIOSConfigPrivilege Yes -UserRoleHostNICConfigPrivilege Yes -UserRoleHostStorageConfigPrivilege Yes -OperatorRoleHostBIOSConfigPrivilege Yes -OperatorRoleHostNICConfigPrivilege No -OperatorRoleHostStorageConfigPrivilege No</dev:code> <dev:remarks> <maml:para>This cmdlet sets the SSO setting for iLO 5, in which the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEiLOSSOSetting -Connection $connection -TrustMode All -UserRoleUserConfigPrivilege Yes -UserRoleRemoteConsolePrivilege No -UserRoleVirtualMediaPrivilege yes -UserRoleLoginPrivilege yes -UserRoleVirtualPowerAndResetPrivilege No -UserRoleiLOConfigPrivilege Yes</dev:code> <dev:remarks> <maml:para>This comand is used to set the TrustMode and Operator role privileges for iLO 4 and iLO 5, in which an array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOSSOSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOSSORecord</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEiLOSSORecord</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>Set-HPEiLOUIDStatus</command:name> <maml:description> <maml:para>Toggles the UID on the host server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOUIDStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOUIDStatus cmdlet toggles the UID on the host server in which the iLO is executing. The Unit ID(UID) light will be flashing if the server is engaged in an activity that can not or should not be interrupted (such as updating iLO firmware or an active Remote Console session). This script will not change the status of a flashing Unit ID light until the activity causing the flashing status is completed.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOUIDStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="UIDControl"> <maml:name>IndicatorLED</maml:name> <maml:description> <maml:para>Toggles the UID on the host server. Aliases : UIDControl</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Lit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Off</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="UIDControl"> <maml:name>IndicatorLED</maml:name> <maml:description> <maml:para>Toggles the UID on the host server. Aliases : UIDControl</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Lit</command:parameterValue> <command:parameterValue required="false" variableLength="false">Off</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[] System.String</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOUIDStatus -IndicatorLED Lit</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of IndicatorLED of iLO 4 or iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEiLOUIDStatus -Connection $connection -IndicatorLED Lit</dev:code> <dev:remarks> <maml:para>This cmdlet sets the IndicatorLED of iLO 4 and iLO 5, in which an array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOUIDStatus</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>Set-HPEiLOUser</command:name> <maml:description> <maml:para>Modifies the existing local user account present in iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOUser cmdlet modifies a local user account existing on the iLO. The NewUsername and NewLoginName parameters must not have values that exist in the current user database. The user must have Administator User Accounts privilege to modify existing users. This cmdlet has the following parameters:</maml:para> <maml:para>• LoginName • NewUsername • NewLoginName • NewPassword • UserConfigPrivilege • RemoteConsolePrivilege • VirtualMediaPrivilege • iLOConfigPrivilege • VirtualPowerAndResetPrivilege • LoginPrivilege (available only on Gen10 servers) • HostBIOSConfigPrivilege (available only on Gen10 servers) • HostNICConfigPrivilege (available only on Gen10 servers) • HostStorageConfigPrivilege (available only on Gen10 servers) • SystemRecoveryConfigPrivilege (available only on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>LoginName is the new modified loginname used to gain access to the respective iLO. This parameter is not case sensitive and must not be left blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewUsername</maml:name> <maml:description> <maml:para>NewUsername specifies the new modified username. This parameter can be a combination of any printable characters up to a maximum length of 39 characters. This parameter is not case sensitive and must not be blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewLoginName</maml:name> <maml:description> <maml:para>NewLoginName specifies the new modified login name. This parameter can be a combination of any printable characters up to a maximum length of 39 characters. This parameter is not case sensitive and must not be blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>NewPassword is the new password associated with the user. This parameter is case sensitive and can be a combination of any printable characters. The length is user defined and can be a minimum of zero characters and a maximum of 39 characters. The minimum length is defined in the iLO Global Settings and has a default value of eight characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to add, edit, and delete local management processor user accounts. A user with this privilege can change privileges for all users. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoteConsPriv"> <maml:name>RemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to remotely access the host system Remote Console, including video, keyboard, and mouse control. The supported values are Yes and No. Aliases : RemoteConsPrivilege</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that gives the user permission to access the virtual media functionality. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ConfigiLOPriv"> <maml:name>iLOConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure iLO Settings. The supported values are Yes and No. Aliases : ConfigiLOPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure Host BIOS Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure Host NIC Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure Host Storage Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to log in to management processor. All local accounts have the login privilege. This privilege is added automatically if it is not specified. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Yes</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to manage the critical recovery firmware images on iLO Drive. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ResetServerPriv"> <maml:name>VirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables enables a user to power-cycle or reset the host system. These activities interrupt system availability. A user with this privilege can diagnose the system by using the Generate NMI to System button. The supported values are Yes and No. Aliases : ResetServerPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginName</maml:name> <maml:description> <maml:para>LoginName is the new modified loginname used to gain access to the respective iLO. This parameter is not case sensitive and must not be left blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewUsername</maml:name> <maml:description> <maml:para>NewUsername specifies the new modified username. This parameter can be a combination of any printable characters up to a maximum length of 39 characters. This parameter is not case sensitive and must not be blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewLoginName</maml:name> <maml:description> <maml:para>NewLoginName specifies the new modified login name. This parameter can be a combination of any printable characters up to a maximum length of 39 characters. This parameter is not case sensitive and must not be blank.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>NewPassword is the new password associated with the user. This parameter is case sensitive and can be a combination of any printable characters. The length is user defined and can be a minimum of zero characters and a maximum of 39 characters. The minimum length is defined in the iLO Global Settings and has a default value of eight characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UserConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to add, edit, and delete local management processor user accounts. A user with this privilege can change privileges for all users. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RemoteConsPriv"> <maml:name>RemoteConsolePrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to remotely access the host system Remote Console, including video, keyboard, and mouse control. The supported values are Yes and No. Aliases : RemoteConsPrivilege</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualMediaPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that gives the user permission to access the virtual media functionality. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ConfigiLOPriv"> <maml:name>iLOConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure iLO Settings. The supported values are Yes and No. Aliases : ConfigiLOPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostBIOSConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure Host BIOS Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostNICConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure Host NIC Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HostStorageConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to configure Host Storage Settings. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LoginPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to log in to management processor. All local accounts have the login privilege. This privilege is added automatically if it is not specified. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Yes</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SystemRecoveryConfigPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables a user to manage the critical recovery firmware images on iLO Drive. The supported values are Yes and No.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="ResetServerPriv"> <maml:name>VirtualPowerAndResetPrivilege</maml:name> <maml:description> <maml:para>Specifies a boolean parameter that enables enables a user to power-cycle or reset the host system. These activities interrupt system availability. A user with this privilege can diagnose the system by using the Generate NMI to System button. The supported values are Yes and No. Aliases : ResetServerPriv</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> Set-HPEiLOUser -Connection $connection -LoginName admin -NewUsername testadmin -NewLoginName testadmin -NewPassword abcd1234</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of NewUsername, NewLoginName, and NewPassword for the corresponding LoginName of iLO 4 or iLO 5, in which the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOUser -LoginName admin -RemoteConsolePrivilege Yes -UserConfigPrivilege Yes -iLOConfigPrivilege No -VirtualMediaPrivilege No</dev:code> <dev:remarks> <maml:para>This cmdlet shows the usage of cmdlet to set the privileges for the given LoginName in iLO 4 or iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Set-HPEiLOUser -LoginName admin -HostBIOSConfigPrivilege yes -HostNICConfigPrivilege no -HostStorageConfigPrivilege No -LoginPrivilege yes</dev:code> <dev:remarks> <maml:para>This cmdlet shows the usage of cmdlet to set the privileges for the given LoginName for iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEiLOUser -Connection $connection -LoginName admin -UserConfigPrivilege Yes -ResetServerPrivilege No</dev:code> <dev:remarks> <maml:para>This cmdlet sets the boolean value of privileges for the given LoginName of iLO 4 and iLO 5, in which an array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEiLOUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOUser</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>Set-HPEiLOVirtualMediaStatus</command:name> <maml:description> <maml:para>Sets the virtual media drive status.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEiLOVirtualMediaStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEiLOVirtualMediaStatus cmdlet sets the virtual media drive status. All the parameters in the command are optional. You must purchase the iLO Advanced license to enable this feature. You must have Virtual Media privilege to execute This cmdlet. The cmdlet has the following parameters:</maml:para> <maml:para>• Device • VMBootOption • VMWriteProtect (Supported only on iLO 4 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEiLOVirtualMediaStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VMBootOption</maml:name> <maml:description> <maml:para>Specifies the boot option parameter for the Virtual Media. The possible values are BootAlways, BootOnce, or NoBoot. These values control how the Virtual Media device behaves during the boot phase of the server. Setting these values does not affect the current state of the Virtual Media device. These settings only take effect if the Virtual Media device is connected at server boot. BootAlways sets theVMBootOption to BootAlways. The Virtual Media device is always connected during server boot. BootOnNextReset sets VMBootOption to BootOnce. The Virtual Media device is connected during the next server boot, but on any subsequent server boots, it does not connect. The BootOnNextReset option is intended to boot one time to the Virtual Media device, use that device while the server is running, and then not have the Virtual Media device available on subsequent server reboots. After the server has booted once with the Virtual Media device connected, on the subsequent server reboot, the Virtual Media device does not connect and the following Virtual Media device settings reset to their default values: • BootOption = NoBoot • ImageInserted = No NoBoot sets VMBootOption to NoBoot. The Virtual Media device is not connected during the next server boot. After the server has booted, the Virtual Media device does not connect and the following Virtual Media device settings reset to their default values: • BootOption = NoBoot • ImageInserted = No In addition to VMBootOption, Connect and Disconnect are possible values. The Connect and Disconnect settings can be used to control the Virtual Media devices in the same way that they are controlled in the Virtual Media applet. Whenever the Connect or Disconnect parameters are set, the Virtual Media device immediately connects to the server or disconnects from the server. Connect sets VMBootOption to Connect. The Virtual Media device is immediately connected to the server. Setting VMBootOption to Connect is equivalent to clicking the device Connect button on the Virtual Media Applet. After setting VMBootOption to Connect, the Get-HPEiLOVirtualMediaStatus command shows VMBootOption as BootAlways. This is by design and indicates that the Virtual Media device is connected like the Virtual Media device in the applet, which is always connected during all server boots. Disconnect sets VMBootOption to Disconnect. The Virtual Media device is immediately disconnected from the server. Setting VMBootOption to Disconnect is equivalent to clicking the device Disconnect button on the VirtualMedia Applet. In addition, setting the VMBootOption to Disconnect is equivalent to issuing the Dismount-HPEiLOVirtualMedia command. When the VMBootOption is set to Disconnect, the Virtual Media device does not connect and the following Virtual Media device settings are reset to their default values: • BootOption = NoBoot • ImageInserted = No In case of iLO 5 servers, BootOnNextReset and NoBoot are the only supported values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Connect</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disconnect</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootAlways</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootOnNextReset</command:parameterValue> <command:parameterValue required="false" variableLength="false">NoBoot</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Specifies the Virtual Media device target. The possible values are Floppy, CD, USBStick, and DVD.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD</command:parameterValue> <command:parameterValue required="false" variableLength="false">Floppy</command:parameterValue> <command:parameterValue required="false" variableLength="false">USBStick</command:parameterValue> <command:parameterValue required="false" variableLength="false">DVD</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VMWriteProtect</maml:name> <maml:description> <maml:para>Sets the write protect flag value for the Virtual Floppy. The possible values are Enabled to enable Virtual Media write protect or Disabled to disable Virtual Media write protect. This parameter is not supported in iLO 5 servers. This parameter is applicable only for the device Floppy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VMBootOption</maml:name> <maml:description> <maml:para>Specifies the boot option parameter for the Virtual Media. The possible values are BootAlways, BootOnce, or NoBoot. These values control how the Virtual Media device behaves during the boot phase of the server. Setting these values does not affect the current state of the Virtual Media device. These settings only take effect if the Virtual Media device is connected at server boot. BootAlways sets theVMBootOption to BootAlways. The Virtual Media device is always connected during server boot. BootOnNextReset sets VMBootOption to BootOnce. The Virtual Media device is connected during the next server boot, but on any subsequent server boots, it does not connect. The BootOnNextReset option is intended to boot one time to the Virtual Media device, use that device while the server is running, and then not have the Virtual Media device available on subsequent server reboots. After the server has booted once with the Virtual Media device connected, on the subsequent server reboot, the Virtual Media device does not connect and the following Virtual Media device settings reset to their default values: • BootOption = NoBoot • ImageInserted = No NoBoot sets VMBootOption to NoBoot. The Virtual Media device is not connected during the next server boot. After the server has booted, the Virtual Media device does not connect and the following Virtual Media device settings reset to their default values: • BootOption = NoBoot • ImageInserted = No In addition to VMBootOption, Connect and Disconnect are possible values. The Connect and Disconnect settings can be used to control the Virtual Media devices in the same way that they are controlled in the Virtual Media applet. Whenever the Connect or Disconnect parameters are set, the Virtual Media device immediately connects to the server or disconnects from the server. Connect sets VMBootOption to Connect. The Virtual Media device is immediately connected to the server. Setting VMBootOption to Connect is equivalent to clicking the device Connect button on the Virtual Media Applet. After setting VMBootOption to Connect, the Get-HPEiLOVirtualMediaStatus command shows VMBootOption as BootAlways. This is by design and indicates that the Virtual Media device is connected like the Virtual Media device in the applet, which is always connected during all server boots. Disconnect sets VMBootOption to Disconnect. The Virtual Media device is immediately disconnected from the server. Setting VMBootOption to Disconnect is equivalent to clicking the device Disconnect button on the VirtualMedia Applet. In addition, setting the VMBootOption to Disconnect is equivalent to issuing the Dismount-HPEiLOVirtualMedia command. When the VMBootOption is set to Disconnect, the Virtual Media device does not connect and the following Virtual Media device settings are reset to their default values: • BootOption = NoBoot • ImageInserted = No In case of iLO 5 servers, BootOnNextReset and NoBoot are the only supported values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Connect</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disconnect</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootAlways</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootOnNextReset</command:parameterValue> <command:parameterValue required="false" variableLength="false">NoBoot</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>Specifies the Virtual Media device target. The possible values are Floppy, CD, USBStick, and DVD.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD</command:parameterValue> <command:parameterValue required="false" variableLength="false">Floppy</command:parameterValue> <command:parameterValue required="false" variableLength="false">USBStick</command:parameterValue> <command:parameterValue required="false" variableLength="false">DVD</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VMWriteProtect</maml:name> <maml:description> <maml:para>Sets the write protect flag value for the Virtual Floppy. The possible values are Enabled to enable Virtual Media write protect or Disabled to disable Virtual Media write protect. This parameter is not supported in iLO 5 servers. This parameter is applicable only for the device Floppy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</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.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\ > ,$connection | Set-HPEiLOVirtualMediaStatus -Device Floppy -VMWriteProtect Enabled -VMBootOption BootAlways</dev:code> <dev:remarks> <maml:para>This cmdlet sets the Virtual Media settings of iLO 4, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\ > ,$connection | Set-HPEiLOVirtualMediaStatus -Device CD -VMBootOption BootOnNextReset</dev:code> <dev:remarks> <maml:para>This cmdlet sets the Virtual Media settings of iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\ > $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\ > Set-HPEiLOVirtualMediaStatus -Connection $connection -VMBootOption BootAlways,BootOnNextReset,Disconnect -Device CD,Floppy,CD</dev:code> <dev:remarks> <maml:para>This cmdlet sets the Virtual Media settings of iLO 4 and iLO 5, in which the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOVirtualMediaStatus</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Mount-HPEiLOVirtualMedia</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>Start-HPEiLOCertificateSigningRequest</command:name> <maml:description> <maml:para>Starts the certificate signing request generation in iLO.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>HPEiLOCertificateSigningRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-HPEiLOCertificateSigningRequest cmdlet starts the certificate signing request generation in iLO.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Start-HPEiLOCertificateSigningRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state in which the company or organization that owns the iLO subsystem is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Country</maml:name> <maml:description> <maml:para>Specifies the country code for the country in which the company or organization that owns the iLO subsystem is located. The country code input should be only two characters and in capital letters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Locality"> <maml:name>City</maml:name> <maml:description> <maml:para>Specifies the city or locality in which the company or organization that owns the iLO subsystem is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Specifies the name of the company or organization that owns the iLO subsystem.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The unit within the company or organization that owns the iLO subsystem</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>The FQDN of the iLO subsystem.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeiLOIP</maml:name> <maml:description> <maml:para>Includes the iLO IP along with the certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state in which the company or organization that owns the iLO subsystem is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Country</maml:name> <maml:description> <maml:para>Specifies the country code for the country in which the company or organization that owns the iLO subsystem is located. The country code input should be only two characters and in capital letters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Locality"> <maml:name>City</maml:name> <maml:description> <maml:para>Specifies the city or locality in which the company or organization that owns the iLO subsystem is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Specifies the name of the company or organization that owns the iLO subsystem.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The unit within the company or organization that owns the iLO subsystem</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CommonName</maml:name> <maml:description> <maml:para>The FQDN of the iLO subsystem.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeiLOIP</maml:name> <maml:description> <maml:para>Includes the iLO IP along with the certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The cmdlet returns Status and StatusInfo as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $output = ,$connection | Start-HPEiLOCertificateSigningRequest -State QWERTY -Country AB -City Dummy -Organization XYZ -OrganizationalUnit 1234ABC -CommonName common PS C:\> $output | fl IP : 10.20.30.40 Hostname : abcd.com Status : INFORMATION StatusInfo : HPE.iLO.Response.StatusInfo PS C:\> $output.StatusInfo | fl Category : General Message : GeneratingCertificate AffectedAttribute :</dev:code> <dev:remarks> <maml:para>This cmdlet starts the certificate signing request on iLO 4, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> $output = ,$connection | Start-HPEiLOCertificateSigningRequest -State QWERTY -Country AB -City Dummy -Organization XYZ -OrganizationalUnit 1234ABC -CommonName common -IncludeiLOIP PS C:\> $output | fl IP : 10.20.30.40 Hostname : abcd.com Status : INFORMATION StatusInfo : HPE.iLO.Response.StatusInfo PS C:\> $output.StatusInfo | fl Category : General Message : GeneratingCertificate AffectedAttribute :</dev:code> <dev:remarks> <maml:para>This cmdlet starts the certificate signing request on iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\ > $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> $output = Start-HPEiLOCertificateSigningRequest -Connection $connection -State QWERTY -Country AB -City Dummy -Organization XYZ -OrganizationalUnit 1234ABC -CommonName common</dev:code> <dev:remarks> <maml:para>This cmdlet starts the certificate signing request on iLO 4 and iLO 5, in which an array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOCertificateSigningRequest</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>Start-HPEiLOChassisPowerCalibrationConfiguration</command:name> <maml:description> <maml:para>Starts Apollo chassis power calibration configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>HPEiLOChassisPowerCalibrationConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlets starts the power calibration configuration and once calibration is completed user can invoke Get-HPEiLOChassisPowerCalibrationData to get the calibration data.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Start-HPEiLOChassisPowerCalibrationConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ActionType</maml:name> <maml:description> <maml:para>Specifies the action type listed in the set values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Start</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stop</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EEPROMSaveEnabled</maml:name> <maml:description> <maml:para>To save the calibration data to EEPROM or not.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Seconds</maml:name> <maml:description> <maml:para>The calibration time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AllZone</maml:name> <maml:description> <maml:para>If All Zones is set to 'true', the ZoneNumber will be discarded. Chassis manager will calibrate for all zones and derive the minimum and maximum power limit setpoints which is available in PowerLimit settings. If All Zones is set to 'false', the ZoneNumber will be take effect. Chassis manager will calibrate for specific zone and derive the throttle peak power data from 0% - 100% which is available in Calibration settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ZoneNumber</maml:name> <maml:description> <maml:para>The zone number either on the entire chassis or specific zone. Value - 0 for entire chassis, other number is for specific zone.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ActionType</maml:name> <maml:description> <maml:para>Specifies the action type listed in the set values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Start</command:parameterValue> <command:parameterValue required="false" variableLength="false">Stop</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EEPROMSaveEnabled</maml:name> <maml:description> <maml:para>To save the calibration data to EEPROM or not.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Seconds</maml:name> <maml:description> <maml:para>The calibration time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AllZone</maml:name> <maml:description> <maml:para>If All Zones is set to 'true', the ZoneNumber will be discarded. Chassis manager will calibrate for all zones and derive the minimum and maximum power limit setpoints which is available in PowerLimit settings. If All Zones is set to 'false', the ZoneNumber will be take effect. Chassis manager will calibrate for specific zone and derive the throttle peak power data from 0% - 100% which is available in Calibration settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" variableLength="false">No</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ZoneNumber</maml:name> <maml:description> <maml:para>The zone number either on the entire chassis or specific zone. Value - 0 for entire chassis, other number is for specific zone.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.UInt32[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Starts calibration configuration based on the settings specified</maml:para> </maml:introduction> <dev:code>$con = Connect-HPEiLO 192.168.10.28 admin admin123 -DisableCertificateAuthentication -Verbose PS C:\Windows\system32> $out = $con | Start-HPEiLOChassisPowerCalibrationConfiguration -ActionType Start -EEPROMSaveEnabled Yes -Seconds 70 -AllZone No -ZoneNumber 2 -Verbose PS C:\Windows\system32> $out</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOChassisPowerCalibrationData</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</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>Start-HPEiLODirectorySettingTest</command:name> <maml:description> <maml:para>Starts the Directory Setting test.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>HPEiLODirectorySettingTest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Start-HPEiLODirectorySettingTest cmdlet starts the Directory Setting test with active directory administrator user credentials and lists all privileges of users. This cmdlet is supported both on iLO 4 and iLO5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet" default="true"> <!--NAME: UsernamePasswordSet--> <!--TAG: DEFAULT--> <maml:name>Start-HPEiLODirectorySettingTest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ADAdminUsername</maml:name> <maml:description> <maml:para>Specifies the active directory administrator username for all the iLOs or a list of usernames for each iLO in the input iLO list. It can be a single string or it can be a collection of usernames in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ADAdminPassword</maml:name> <maml:description> <maml:para>Specifies the active directory administrator Password for all the iLOs or a list of passwords for each iLO in the input iLO list. It can be a single string or it can be a collection of passwords in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TestUsername</maml:name> <maml:description> <maml:para>Specifies the active directory test username for all the iLOs or a list of usernames for each iLO in the input iLO list. It can be a single string or it can be a collection of usernames in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TestUserPassword</maml:name> <maml:description> <maml:para>Specifies the active directory test Password for all the iLOs or a list of passwords for each iLO in the input iLO list. It can be a single string or it can be a collection of passwords in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Start-HPEiLODirectorySettingTest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ADAdminCredential</maml:name> <maml:description> <maml:para>This object is based on the username and password to log onto the administrator account of the active directory server. ADAdminCredential should not be used alongside ADAdminUsername/ADAdminPassword.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TestUserCredential</maml:name> <maml:description> <maml:para>This object is based on the username and password to log on to the test user account of the active directory server. TestUserCredential should not be used alongside TestUsername/TestUserPassword.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ADAdminUsername</maml:name> <maml:description> <maml:para>Specifies the active directory administrator username for all the iLOs or a list of usernames for each iLO in the input iLO list. It can be a single string or it can be a collection of usernames in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ADAdminPassword</maml:name> <maml:description> <maml:para>Specifies the active directory administrator Password for all the iLOs or a list of passwords for each iLO in the input iLO list. It can be a single string or it can be a collection of passwords in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TestUsername</maml:name> <maml:description> <maml:para>Specifies the active directory test username for all the iLOs or a list of usernames for each iLO in the input iLO list. It can be a single string or it can be a collection of usernames in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TestUserPassword</maml:name> <maml:description> <maml:para>Specifies the active directory test Password for all the iLOs or a list of passwords for each iLO in the input iLO list. It can be a single string or it can be a collection of passwords in the form of a string array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ADAdminCredential</maml:name> <maml:description> <maml:para>This object is based on the username and password to log onto the administrator account of the active directory server. ADAdminCredential should not be used alongside ADAdminUsername/ADAdminPassword.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TestUserCredential</maml:name> <maml:description> <maml:para>This object is based on the username and password to log on to the test user account of the active directory server. TestUserCredential should not be used alongside TestUsername/TestUserPassword.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential[]</command:parameterValue> <dev:type> <maml:name>PSCredential[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[] System.Management.Automation.PSCredential[]</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>If the cmdlet executes successfully, an object is returned with Status as Information. In case of an error or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Run Get-HPEiLODirectorySettingTestResult cmdlet to get the results.</maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Start-HPEiLODirectorySettingTest -ADAdminUsername admin -ADAdminPassword admin123 -TestUsername admin -TestUserPassword admin123</dev:code> <dev:remarks> <maml:para>This cmdlet starts the Directory setting test on iLO 4, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\ > $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Start-HPEiLODirectorySettingTest -Connection $connection -ADAdminUsername admin -ADAdminPassword admin123 -TestUsername admin -TestUserPassword admin123</dev:code> <dev:remarks> <maml:para>This cmdlet starts the Directory setting test of iLO 4, in which the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\ > $con = Connect-HPEiLO 10.20.30.10 -Username admin -Password admin123 -DisableCertificateAuthentication PS C:\ > $s = $con | Start-HPEiLODirectorySettingTest</dev:code> <dev:remarks> <maml:para>This cmdlet starts the Directory setting test on iLO5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-HPEiLODirectorySettingTest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLODirectorySettingTestResult</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>Stop-HPEiLODirectorySettingTest</command:name> <maml:description> <maml:para>Stops the Directory Setting Test.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>HPEiLODirectorySettingTest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Stop-HPEiLODirectorySettingTest cmdlet stops the Directory Setting test. The user is expected to start the test using Start-HPEiLODirectorySettingTest before executing this cmdlet. This cmdlet is supported on iLO 4 and iLO5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Stop-HPEiLODirectorySettingTest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Stop-HPEiLODirectorySettingTest</dev:code> <dev:remarks> <maml:para>This cmdlet stops the Directory setting test on iLO 4, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Stop-HPEiLODirectorySettingTest -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet stops the Directory setting test of iLO 4, in which the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.41 -Username admin -Password admin123 PS C:\> $connection | Stop-HPEiLODirectorySettingTest</dev:code> <dev:remarks> <maml:para>This cmdlet stops the Directory setting test on iLO5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-HPEiLODirectorySettingTest</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLODirectorySettingTestResult</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>Test-HPEiLOConnection</command:name> <maml:description> <maml:para>The Test-HPEiLOConnection cmdlet checks if the connection to the target is valid.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Test</command:verb> <command:noun>HPEiLOConnection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-HPEiLOConnection cmdlet checks if the connection to the target is valid.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet" default="true"> <!--NAME: UsernamePasswordSet--> <!--TAG: DEFAULT--> <maml:name>Test-HPEiLOConnection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>HPE.iLO.Response.TestConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Test-HPEiLOConnection IP : 10.20.30.40 Hostname : abc.com IsConnected : True TestConnectionDetail : {HPE.Framework.Connector.Common.TestConnectionStatus} StatusMessage : OK</dev:code> <dev:remarks> <maml:para>This cmdlet tests the connection of iLO 4 or iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\ > $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Test-HPEiLOConnection -Connection $connection IP : 10.20.30.1 Hostname : gen8pos.com IsConnected : True TestConnectionDetail : {HPE.Framework.Connector.Common.TestConnectionStatus} StatusMessage : OK IP : 10.20.30.2 Hostname : gen9pos.com IsConnected : True TestConnectionDetail : {HPE.Framework.Connector.Common.TestConnectionStatus} StatusMessage : OK IP : 10.20.30.3 Hostname : gen10pos.com IsConnected :True TestConnectionDetail : {HPE.Framework.Connector.Common.TestConnectionStatus} StatusMessage : OK</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5, in which an array of iLO connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Disconnect-HPEiLO PS C:\> $out = ,$connection | Test-HPEiLOConnection PS C:\> $out IP : 10.20.30.50 Hostname : gen10pos.com IsConnected : False TestConnectionDetail : {HPE.Framework.Connector.Common.TestConnectionStatus} StatusMessage : OK PS C:\> $out.TestConnectionDetail | fl ConnectionType : Redfish IsConnected : False StatusMessage : Connection session is invalid.</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output of the cmdlet when connection object to iLO is disconnected and Test-HPEiLOConnection cmdlet is executed post that in iLO 4 or iLO 5, in which the Connection object is passed as pipeline object.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEiLO</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>Test-HPEiLOESKMConnection</command:name> <maml:description> <maml:para>Validates the ESKM connection of the iLO</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Test</command:verb> <command:noun>HPEiLOESKMConnection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-HPEiLOESKMConnection cmdlet validates the ESKM connection of the iLO. This cmdlet is supported only on iLO 5 servers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Test-HPEiLOESKMConnection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Test-HPEiLOESKMConnection PS C:\> $out | fl IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : HPE.iLO.Response.StatusInfo PS C:\> $out.StatusInfo | fl Category : General Message : PrimarySecondaryESKMServersAccessible AffectedAttribute :</dev:code> <dev:remarks> <maml:para>This cmdlet tests the ESKM connection of iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40,10.20.30.41 -Username admin -Password admin123 PS C:\> Test-HPEiLOESKMConnection -Connection $connection PS C:\> $out | fl IP : 10.20.30.40 Hostname : abcd.com Status : OK StatusInfo : HPE.iLO.Response.StatusInfo IP : 10.20.30.41 Hostname : xyz.example.com Status : OK StatusInfo : HPE.iLO.Response.StatusInfo</dev:code> <dev:remarks> <maml:para>This cmdlet tests the ESKM connection of iLO 5, in which an array of connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLOESKMSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOESKMSetting</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>Unregister-HPEiLORemoteSupportSetting</command:name> <maml:description> <maml:para>Disables Insight Remote Support functionality and unregisters the server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Unregister</command:verb> <command:noun>HPEiLORemoteSupportSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Unregister-HPEiLORemoteSupportSetting cmdlet disables Insight Remote Support functionality and unregisters the server. This cmdlet is used to unregister ERS and IRS setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Unregister-HPEiLORemoteSupportSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1 -Username admin -Password admin123 PS C:\> ,$connection | Unregister-HPEiLORemoteSupportSetting</dev:code> <dev:remarks> <maml:para>This example shows output on iLO 4 or iLO 5 server with the connection object passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Unregister-HPEiLORemoteSupportSetting -Connection $connection</dev:code> <dev:remarks> <maml:para>This cmdlet shows the output on iLO 4 and iLO 5 with an array of connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-HPEiLORemoteSupportSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLORemoteSupportSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEiLORemoteSupportSetting</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>Update-HPEiLOFirmware</command:name> <maml:description> <maml:para>Updates the specified firmware image to iLO and starts the update process.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Update</command:verb> <command:noun>HPEiLOFirmware</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Update-HPEiLOFirmware cmdlet copies the specified firmware image to iLO and starts the update process. The types of firmware that can be uploaded are: • iLO (.bin) • ROM firmware (.full or .flash) • CPLD (.vme) • Power PIC (.hex)</maml:para> <maml:para>You must have the Configure iLO Settings privilege to execute this cmdlet for iLO firmware upgrade. When you execute the command to update the firmware, the command verifies the TPM configuration status of option ROM measuring. If it is enabled, the cmdlet returns the same warning message as stated in the web interface. To enable the firmware update to continue, you must execute the command with the TPMEnabled parameter.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Update-HPEiLOFirmware</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the full path of the firmware upgrade file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TPMEnabled</maml:name> <maml:description> <maml:para>SwitchParameter to continue the firmware update, when TPM (ROM measuring) switch is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRepository</maml:name> <maml:description> <maml:para>If set to true, the firmware file is added to the iLO repository. This parameter is supported only on iLO 5 server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UploadTimeout</maml:name> <maml:description> <maml:para>The timeout value for uploading the firmware file. In case of Gen8/Gen9 servers, the default timeout value is 600 seconds. In case of Gen10 servers, the default timeout value is 180 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to iLO. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEiLO command using the IP/Hostname and accompanying Username and Password to log in to the iLO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the full path of the firmware upgrade file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TPMEnabled</maml:name> <maml:description> <maml:para>SwitchParameter to continue the firmware update, when TPM (ROM measuring) switch is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateRepository</maml:name> <maml:description> <maml:para>If set to true, the firmware file is added to the iLO repository. This parameter is supported only on iLO 5 server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UploadTimeout</maml:name> <maml:description> <maml:para>The timeout value for uploading the firmware file. In case of Gen8/Gen9 servers, the default timeout value is 600 seconds. In case of Gen10 servers, the default timeout value is 180 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32[]</command:parameterValue> <dev:type> <maml:name>UInt32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawRequest, RawResponse, and Object. Default value is Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawRequest</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawResponse</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Object</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the prompt that asks for a required parameter. Without this parameter, the cmdlet requires you to provide the values of all required parameters that are missing, interactively. Setting this will cause an error for any missing required parameters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</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>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 or warning, Status and StatusInfo will be returned as PSObject.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>WARNING - Updating the iLO firmware will cause the iLO to reboot. This will terminate any connections to the iLO including Remote Console and Virtual Media. Updating other types of firmware might not cause iLO to reboot, but might require a server reboot. The server will not reboot automatically.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Update-HPEiLOFirmware -Location "C:\Users\admin\Desktop\Firmware\ilo4_253.bin" -UploadTimeout 700</dev:code> <dev:remarks> <maml:para>This cmdlet updates the iLO firmware of the iLO 4 or iLO 5, in which the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> ,$connection | Update-HPEiLOFirmware -Location "C:\Users\admin\Desktop\Firmware\ilo4_253.bin" -TPMEnabled -UploadTimeout 700</dev:code> <dev:remarks> <maml:para>This cmdlet updates the iLO firmware of the iLO 4 or iLO 5, in which the TPMEnabled switch is enabled and the connection object is passed as pipeline input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEiLO 10.20.30.40 -Username admin -Password admin123 PS C:\> Update-HPEiLOFirmware -Connection $connection -Location "C:\Users\admin\Desktop\Firmware\P89_2.42_04_25_2017.signed.full" -UploadTimeout 700 -TPMEnabled -UpdateRepository</dev:code> <dev:remarks> <maml:para>This cmdlet updates the firmware of iLO 5, in which the connection object is passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\ > $connection = Connect-HPEiLO 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Update-HPEiLOFirmware -Connection $connection -Location "C:\Users\admin\Desktop\Firmware\ilo4_253.bin" -UploadTimeout 700</dev:code> <dev:remarks> <maml:para>This cmdlet updates the iLO firmware of iLO 4 and iLO 5, in which an array of connection objects is passed as named parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>http://www.hpe.com/servers/powershell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-HPEiLO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEiLOFirmwareInventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2019 v2.3.42--> </helpItems> |