ja-JP/HPEBIOSCmdlets.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2019 v2.3.42--> <!--Generated by: SAPIEN PowerShell HelpWriter 2019 v2.3.42--> <!-- Module: HPEBIOSCmdlets 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-HPEBIOSiSCSIBootAttempt</command:name> <maml:description> <maml:para>The Add-HPEBIOSiSCSIBootAttempt cmdlet adds a BIOS iSCSI boot attempt in the iSCSI source array.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>HPEBIOSiSCSIBootAttempt</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-HPEBIOSiSCSIBootAttempt cmdlet adds a BIOS iSCSI boot attempt in the iSCSI source array. This cmdlet supports only on Gen9 and Gen10 servers. This cmdlet has the following parameters:</maml:para> <maml:para>· iSCSIBootAttemptIndex</maml:para> <maml:para>· iSCSINICSource</maml:para> <maml:para>· iSCSIAttemptName</maml:para> <maml:para>· iSCSIConnection</maml:para> <maml:para>· iSCSIConnectRetry</maml:para> <maml:para>· iSCSIConnectTimeout</maml:para> <maml:para>· iSCSIIPAddressType</maml:para> <maml:para>· iSCSIAuthenticationMethod</maml:para> <maml:para>· iSCSIInitiatorInfoViaDHCP</maml:para> <maml:para>· iSCSIInitiatorIPAddress</maml:para> <maml:para>· iSCSIInitiatorNetmask</maml:para> <maml:para>· iSCSIInitiatorGateway</maml:para> <maml:para>· iSCSITargetInfoViaDHCP</maml:para> <maml:para>· iSCSITargetName</maml:para> <maml:para>· iSCSITargetIPAddress</maml:para> <maml:para>· iSCSILogicalUnitNumber</maml:para> <maml:para>· iSCSITargetTCPPort</maml:para> <maml:para>· iSCSICHAPType</maml:para> <maml:para>· iSCSICHAPUsername</maml:para> <maml:para>· iSCSICHAPSecret</maml:para> <maml:para>· iSCSIReverseCHAPUsername</maml:para> <maml:para>· iSCSIReverseCHAPSecret</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-HPEBIOSiSCSIBootAttempt</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>iSCSIBootAttemptIndex</maml:name> <maml:description> <maml:para>Specifies the iSCSI boot attempt source array index which has iSCSIAttemptInstance=0. Possible values range between 1 and 4.</maml:para> <maml:para>Note: · You can use the Get-HPEBIOSiSCSIBootAttempt cmdlet to know about iSCSIAttemptInstance details in the iSCSI source array. · You can either use the unused iSCSI source array index which has iSCSIAttemptInstance=0 or delete the existing index using the Remove-HPEBIOSiSCSIBootAttemptc cmdlet. · An error is thrown when you specify the array index which is already in use.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSINICSource</maml:name> <maml:description> <maml:para>Specifies the available iSCSI NIC source for the iSCSI connection. Possible values are NICBoot1, NICBoot2, NICBoot3, NICBoot4, NICBoot5, NICBoot6, NICBoot7, NICBoot8, NICBoot9, NICBoot10, NICBoot11, and NICBoot12.</maml:para> <maml:para>Note: · You can use Get-HPEBIOSiSCSINICSource to get the list of available iSCSI NIC sources for the iSCSI connection. · Make sure that the specified NIC source is not in Disabled state. Use Get-HPEBIOSEmbeddedLOMPort cmdlet to get the NIC source state.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NICBoot1</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot2</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot3</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot4</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot5</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot6</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot7</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot8</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot9</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot10</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot11</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot12</command:parameterValue> </command:parameterValueGroup> <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>iSCSIAttemptName</maml:name> <maml:description> <maml:para>Specifies the human readable descriptive name for the iSCSI attempt configuration.</maml:para> </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>iSCSIConnection</maml:name> <maml:description> <maml:para>Enables or Disables iSCSI mode for a selected iSCSI attempt. Possible values are Disabled, Enabled, and EnabledForMPIO.</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">EnabledForMPIO</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>Disabled</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIIPAddressType</maml:name> <maml:description> <maml:para>Specifies an iSCSI IP Address type. If set to Auto, IPv4 is attempted first, followed by IPv6. Possible values are Auto, IPv4, and IPv6.</maml:para> <maml:para>Note: · The iSCSI initiator and target configuration parameters are not considered for iSCSI connection when iSCSIIPAddressType is either Auto or IPv6.</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">IPv4</command:parameterValue> <command:parameterValue required="false" variableLength="false">IPv6</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>IPv4</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIConnectRetry</maml:name> <maml:description> <maml:para>Specifies the number of times to retry the iSCSI connection. Zero means no retries. Possible values range between 0 and16.</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>3</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIConnectTimeout</maml:name> <maml:description> <maml:para>Specifies the iSCSI connection timeout value in milliseconds. Possible values range between 100 and 20000.</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>20000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIInitiatorInfoViaDHCP</maml:name> <maml:description> <maml:para>Specifies the iSCSI initiator DHCP configuration. If enabled, the iSCSI Initiator information is configured from DHCP. Otherwise, the iSCSI initiator information must be statically configured. When providing static values for the Initiator, ensure that Target settings are also configured with static values. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note: · The iSCSIInitiatorIPAddress, iSCSIInitiatorNetmask, and iSCSIInitiatorGateway parameters are not considered for iSCSI connection when iSCSIInitiatorInfoViaDHCP 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>Enabled</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIInitiatorIPAddress</maml:name> <maml:description> <maml:para>Specifies IP Address of the iSCSI Initiator if not configured through DHCP. The Initiator IP Address is always auto-assigned if the IP address type is IPv6. The address must be an IPv4 or IPv6 address, depending on the IP Address Type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0.0.0.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIInitiatorNetmask</maml:name> <maml:description> <maml:para>Specifies the subnet mask of the iSCSI initiator if not configured through DHCP. The address must be an IPv4.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0.0.0.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIInitiatorGateway</maml:name> <maml:description> <maml:para>Specifies gateway address of the iSCSI Initiator if not configured through DHCP. The address must be either an IPv4 address or IPv6 address, depending on the IP Address Type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0.0.0.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSITargetInfoViaDHCP</maml:name> <maml:description> <maml:para>Specifies the iSCSI target DHCP configuration. If enabled, the iSCSI target information are configured from DHCP. Otherwise, the iSCSI target information must be statically configured. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note: · The iSCSITargetName, iSCSITargetIPAddress, iSCSILogicalUnitNumber, and iSCSITargetTCPPort parameters are not considered for iSCSI connection when iSCSITargetInfoViaDHCP 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>Enabled</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSITargetName</maml:name> <maml:description> <maml:para>Specifies the worldwide unique iSCSI Qualified Name (IQN) of this iSCSI target. Only the IQN format is accepted. For example, 'iqn.1991-05.com.microsoft:iscsitarget-iscsidisk-target'. EUI format is not supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSITargetIPAddress</maml:name> <maml:description> <maml:para>Specifies the IP Address of the iSCSI Target if not obtained from DHCP. The address must be an IPv4 address or IPv6 address, depending on the IP Address Type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0.0.0.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSILogicalUnitNumber</maml:name> <maml:description> <maml:para>Specifies the iSCSI target Logical Unit Number (LUN) if not obtained from DHCP. This value must follow the SAM-2 spec. Example: 0001-1234-5678-9ABC. If the number of characters is less than 5, a dash character is not required. Example: 0001. If the LUN is 12345, enter 1234-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>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSITargetTCPPort</maml:name> <maml:description> <maml:para>Specifies the iSCSI Target TCP Port number if not obtained from DHCP.</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>3260</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIAuthenticationMethod</maml:name> <maml:description> <maml:para>Specifies the iSCSI connection authentication method. Possible values are None and CHAP.</maml:para> <maml:para>Note: · The iSCI CHAP and reverse CHAP parameters are not considered for iSCSI connection when iSCSIAuthenticationMethod is None.</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">CHAP</command:parameterValue> </command:parameterValueGroup> <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>iSCSICHAPType</maml:name> <maml:description> <maml:para>Specifies the CHAP authentication type. This is applicable only when the Authentication Method is set to CHAP. Possible values are OneWay and Mutual</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">OneWay</command:parameterValue> <command:parameterValue required="false" variableLength="false">Mutual</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>OneWay</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSICHAPUsername</maml:name> <maml:description> <maml:para>Specifies the user name needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSICHAPSecret</maml:name> <maml:description> <maml:para>Specifies the password needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIReverseCHAPUsername</maml:name> <maml:description> <maml:para>Specifies the user name for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIReverseCHAPSecret</maml:name> <maml:description> <maml:para>Specifies the password needed for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.</maml:para> </maml:description> <command:parameterValue required="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" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>iSCSIBootAttemptIndex</maml:name> <maml:description> <maml:para>Specifies the iSCSI boot attempt source array index which has iSCSIAttemptInstance=0. Possible values range between 1 and 4.</maml:para> <maml:para>Note: · You can use the Get-HPEBIOSiSCSIBootAttempt cmdlet to know about iSCSIAttemptInstance details in the iSCSI source array. · You can either use the unused iSCSI source array index which has iSCSIAttemptInstance=0 or delete the existing index using the Remove-HPEBIOSiSCSIBootAttemptc cmdlet. · An error is thrown when you specify the array index which is already in use.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSINICSource</maml:name> <maml:description> <maml:para>Specifies the available iSCSI NIC source for the iSCSI connection. Possible values are NICBoot1, NICBoot2, NICBoot3, NICBoot4, NICBoot5, NICBoot6, NICBoot7, NICBoot8, NICBoot9, NICBoot10, NICBoot11, and NICBoot12.</maml:para> <maml:para>Note: · You can use Get-HPEBIOSiSCSINICSource to get the list of available iSCSI NIC sources for the iSCSI connection. · Make sure that the specified NIC source is not in Disabled state. Use Get-HPEBIOSEmbeddedLOMPort cmdlet to get the NIC source state.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NICBoot1</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot2</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot3</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot4</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot5</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot6</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot7</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot8</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot9</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot10</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot11</command:parameterValue> <command:parameterValue required="false" variableLength="false">NICBoot12</command:parameterValue> </command:parameterValueGroup> <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>iSCSIAttemptName</maml:name> <maml:description> <maml:para>Specifies the human readable descriptive name for the iSCSI attempt configuration.</maml:para> </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>iSCSIConnection</maml:name> <maml:description> <maml:para>Enables or Disables iSCSI mode for a selected iSCSI attempt. Possible values are Disabled, Enabled, and EnabledForMPIO.</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">EnabledForMPIO</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>Disabled</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIIPAddressType</maml:name> <maml:description> <maml:para>Specifies an iSCSI IP Address type. If set to Auto, IPv4 is attempted first, followed by IPv6. Possible values are Auto, IPv4, and IPv6.</maml:para> <maml:para>Note: · The iSCSI initiator and target configuration parameters are not considered for iSCSI connection when iSCSIIPAddressType is either Auto or IPv6.</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">IPv4</command:parameterValue> <command:parameterValue required="false" variableLength="false">IPv6</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>IPv4</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIConnectRetry</maml:name> <maml:description> <maml:para>Specifies the number of times to retry the iSCSI connection. Zero means no retries. Possible values range between 0 and16.</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>3</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIConnectTimeout</maml:name> <maml:description> <maml:para>Specifies the iSCSI connection timeout value in milliseconds. Possible values range between 100 and 20000.</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>20000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIInitiatorInfoViaDHCP</maml:name> <maml:description> <maml:para>Specifies the iSCSI initiator DHCP configuration. If enabled, the iSCSI Initiator information is configured from DHCP. Otherwise, the iSCSI initiator information must be statically configured. When providing static values for the Initiator, ensure that Target settings are also configured with static values. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note: · The iSCSIInitiatorIPAddress, iSCSIInitiatorNetmask, and iSCSIInitiatorGateway parameters are not considered for iSCSI connection when iSCSIInitiatorInfoViaDHCP 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>Enabled</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIInitiatorIPAddress</maml:name> <maml:description> <maml:para>Specifies IP Address of the iSCSI Initiator if not configured through DHCP. The Initiator IP Address is always auto-assigned if the IP address type is IPv6. The address must be an IPv4 or IPv6 address, depending on the IP Address Type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0.0.0.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIInitiatorNetmask</maml:name> <maml:description> <maml:para>Specifies the subnet mask of the iSCSI initiator if not configured through DHCP. The address must be an IPv4.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0.0.0.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIInitiatorGateway</maml:name> <maml:description> <maml:para>Specifies gateway address of the iSCSI Initiator if not configured through DHCP. The address must be either an IPv4 address or IPv6 address, depending on the IP Address Type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0.0.0.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSITargetInfoViaDHCP</maml:name> <maml:description> <maml:para>Specifies the iSCSI target DHCP configuration. If enabled, the iSCSI target information are configured from DHCP. Otherwise, the iSCSI target information must be statically configured. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note: · The iSCSITargetName, iSCSITargetIPAddress, iSCSILogicalUnitNumber, and iSCSITargetTCPPort parameters are not considered for iSCSI connection when iSCSITargetInfoViaDHCP 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>Enabled</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSITargetName</maml:name> <maml:description> <maml:para>Specifies the worldwide unique iSCSI Qualified Name (IQN) of this iSCSI target. Only the IQN format is accepted. For example, 'iqn.1991-05.com.microsoft:iscsitarget-iscsidisk-target'. EUI format is not supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSITargetIPAddress</maml:name> <maml:description> <maml:para>Specifies the IP Address of the iSCSI Target if not obtained from DHCP. The address must be an IPv4 address or IPv6 address, depending on the IP Address Type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0.0.0.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSILogicalUnitNumber</maml:name> <maml:description> <maml:para>Specifies the iSCSI target Logical Unit Number (LUN) if not obtained from DHCP. This value must follow the SAM-2 spec. Example: 0001-1234-5678-9ABC. If the number of characters is less than 5, a dash character is not required. Example: 0001. If the LUN is 12345, enter 1234-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>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSITargetTCPPort</maml:name> <maml:description> <maml:para>Specifies the iSCSI Target TCP Port number if not obtained from DHCP.</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>3260</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIAuthenticationMethod</maml:name> <maml:description> <maml:para>Specifies the iSCSI connection authentication method. Possible values are None and CHAP.</maml:para> <maml:para>Note: · The iSCI CHAP and reverse CHAP parameters are not considered for iSCSI connection when iSCSIAuthenticationMethod is None.</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">CHAP</command:parameterValue> </command:parameterValueGroup> <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>iSCSICHAPType</maml:name> <maml:description> <maml:para>Specifies the CHAP authentication type. This is applicable only when the Authentication Method is set to CHAP. Possible values are OneWay and Mutual</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">OneWay</command:parameterValue> <command:parameterValue required="false" variableLength="false">Mutual</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>OneWay</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSICHAPUsername</maml:name> <maml:description> <maml:para>Specifies the user name needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSICHAPSecret</maml:name> <maml:description> <maml:para>Specifies the password needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIReverseCHAPUsername</maml:name> <maml:description> <maml:para>Specifies the user name for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIReverseCHAPSecret</maml:name> <maml:description> <maml:para>Specifies the password needed for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.</maml:para> </maml:description> <command:parameterValue required="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>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Add-HPEBIOSiSCSIBootAttempt -iSCSIBootAttemptIndex 2 -iSCSINICSource NICBoot1 -iSCSIAttemptName "NICSource1" -iSCSIConnection Enabled -iSCSIIPAddressType Auto</dev:code> <dev:remarks> <maml:para>This example adds an iSCSI boot attempt instance into index 2 of the iSCSI source array on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Add-HPEBIOSiSCSIBootAttempt -Connection $connection -iSCSIBootAttemptIndex 1 -iSCSINICSource NICBoot2</dev:code> <dev:remarks> <maml:para>This example adds an iSCSI boot attempt instance into index 1 of the iSCSI source array on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSiSCSIBootAttempt</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Edit-HPEBIOSiSCSIBootAttempt</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEBIOSiSCSIBootAttempt</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSLog</command:name> <maml:description> <maml:para>The Clear-HPEBIOSLog cmdlet clears any logs created by the HPEBIOSCmdlets module.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEBIOSLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEBIOSLog cmdlet clears any logs created by the HPEBIOSCmdlets module. You are prompted for confirmation unless you specify the Force parameter.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEBIOSLog</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>Specifies the integer as a value and if X value is specified, then X number of logs in the descending order of their age will be cleared (oldest logs will be cleared first). If no parameter is used, all existing logs, including the current log, 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>0</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>Clears all existing logs without prompting for confirmation. By default, Clear-HPEBIOSLog prompts for confirmation before clearing any logs from the module installation folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>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>Specifies the integer as a value and if X value is specified, then X number of logs in the descending order of their age will be cleared (oldest logs will be cleared first). If no parameter is used, all existing logs, including the current log, 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>0</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>Clears all existing logs without prompting for confirmation. By default, Clear-HPEBIOSLog prompts for confirmation before clearing any logs from the module installation folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>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>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>If the cmdlet executes successfully, it does not return anything. In case of an error, the error will be thrown.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Clear-HPEBIOSLog Do you really want to clear all the logs? [Y] Yes [N] No [S] Suspend</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>C:\PS> Clear-HPEBIOSLog -Last 5</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>C:\PS> Clear-HPEBIOSLog -Force</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>Enable-HPEBIOSLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEBIOSLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSTLSCertificateInstallationQueue</command:name> <maml:description> <maml:para>The Clear-HPEBIOSTLSCertificateInstallationQueue cmdlet clears the BIOS TLS certificate installation queue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEBIOSTLSCertificateInstallationQueue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEBIOSTLSCertificateInstallationQueue cmdlet clears the BIOS TLS certificate installation queue. The certificate in the installation queue gets installed during server reboot. This cmdlet supports only on Gen10 servers. Use the Get-HPEBIOSTLSCertificateInstallationQueue cmdlet to get the list of certificates in the installation queue.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEBIOSTLSCertificateInstallationQueue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , 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 (ByValue)" position="0" aliases="conn , 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>HPE.BIOS.Connection[]</maml:name> <maml:uri></maml: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 or System.Management.Automation.PSObject[]</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 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>· While executing the Clear-HPEBIOSTLSCertificateInstallationQueue cmdlet, an error is thrown when the installation queue is 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>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Clear-HPEBIOSTLSCertificateInstallationQueue</dev:code> <dev:remarks> <maml:para>This example clears the TLS certificate installation queue on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Clear-HPEBIOSTLSCertificateInstallationQueue –Connection $connection</dev:code> <dev:remarks> <maml:para>This example clears the TLS certificate installation queue on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Uninstall-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificateInstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificateUninstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEBIOSTLSCertificateUninstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSTLSCertificateUninstallationQueue</command:name> <maml:description> <maml:para>The Clear-HPEBIOSTLSCertificateUninstallationQueue cmdlet clears the BIOS TLS certificate uninstallation queue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEBIOSTLSCertificateUninstallationQueue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEBIOSTLSCertificateUninstallationQueue cmdlet clears the BIOS TLS certificate uninstallation queue. The certificate in the uninstallation queue is uninstalled during server reboot. This cmdlet supports only on Gen10 servers. Use the Get-HPEBIOSTLSCertificateUninstallationQueue cmdlet to get the list of certificates in the uninstallation queue.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEBIOSTLSCertificateUninstallationQueue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , 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 (ByValue)" position="0" aliases="conn , 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>HPE.BIOS.Connection[]</maml:name> <maml:uri></maml: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 or System.Management.Automation.PSObject[]</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 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>· While executing the Clear-HPEBIOSTLSCertificateUninstallationQueue cmdlet, an error is thrown when the uninstallation queue is 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>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Clear-HPEBIOSTLSCertificateUninstallationQueue</dev:code> <dev:remarks> <maml:para>This example clears the TLS certificate uninstallation queue on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Clear-HPEBIOSTLSCertificateUnInstallationQueue –Connection $connection</dev:code> <dev:remarks> <maml:para>This example clears the TLS certificate uninstallation queue on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Uninstall-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificateInstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificateUninstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEBIOSTLSCertificateInstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUserDefault</command:name> <maml:description> <maml:para>The Clear-HPEBIOSUserDefault cmdlet clears the BIOS user default configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>HPEBIOSUserDefault</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Clear-HPEBIOSUserDefault cmdlet clears the current user-defined default settings. Once deleted, these settings can only be restored manually. This cmdlet has the following parameter:</maml:para> <maml:para>· EraseUserDefault</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Clear-HPEBIOSUserDefault</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EraseUserDefault</maml:name> <maml:description> <maml:para>Clears the user default settings when the parameter is provided. Without switch parameter, erase, or clear user, the default is set to No or Cancel.</maml:para> </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" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EraseUserDefault</maml:name> <maml:description> <maml:para>Clears the user default settings when the parameter is provided. Without switch parameter, erase, or clear user, the default is set to No or Cancel.</maml:para> </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>HPE.BIOS.Connection[]</maml:name> <maml:uri></maml: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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Clear-HPEBIOSUserDefault -EraseUserDefault</dev:code> <dev:remarks> <maml:para>This example deletes the saved user default settings on a Gen9 server, or Gen10 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Clear-HPEBIOSUserDefault –Connection $connection -EraseUserDefault</dev:code> <dev:remarks> <maml:para>This example deletes the saved user default settings on Gen9, or Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSUserDefault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-HPEBIOSUserDefault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOS</command:name> <maml:description> <maml:para>The Connect-HPEBIOS cmdlet creates connections to BIOS targets.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>HPEBIOS</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Connect-HPEBIOS cmdlet creates connections to BIOS targets represented by an iLO or server IP. This cmdlet includes the following parameters: · Address - Holds the target IP, either server or iLO IP. · Username - Holds the target server/iLO username. · Password - Holds the target server/iLO password. · Credential - Holds the target PSCredentials. · BIOSAdminPassword (only applicable for Gen9 servers) - Holds the BIOS administrator password, if configured. · Timeout - Holds the HTTPS protocol time out. · XAuthToken- Specifies the session key generated for the iLO via One View or through Redfish API. · DisableCerificateAuthentication - Using this bypasses the server certificate authentication.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet" default="true"> <!--NAME: UsernamePasswordSet--> <!--TAG: DEFAULT--> <maml:name>Connect-HPEBIOS</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</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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.</maml:para> <maml:para>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.</maml:para> <maml:para>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. Used only when the target is iLO. The parameter accepts values in the range 1 through 1800.</maml:para> <maml:para>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>60</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></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 this switch parameter is present, the server certificate authentication is disabled while establishing the Gen9 or Gen10 target connection. If it is not present, server certificate authentication will execute according to the global certificate authentication setting. The default behavior is to authenticate server certificates.</maml:para> <maml:para>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></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CredentialSet"> <!--NAME: CredentialSet--> <maml:name>Connect-HPEBIOS</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</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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.</maml:para> <maml:para>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. Used only when the target is iLO. The parameter accepts values in the range 1 through 1800.</maml:para> <maml:para>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>60</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></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 this switch parameter is present, the server certificate authentication is disabled while establishing the Gen9 or Gen10 target connection. If it is not present, server certificate authentication will execute according to the global certificate authentication setting. The default behavior is to authenticate server certificates.</maml:para> <maml:para>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></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="XAuthTokenSet"> <!--NAME: XAuthTokenSet--> <maml:name>Connect-HPEBIOS</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</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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.</maml:para> <maml:para>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. Used only when the target is iLO. The parameter accepts values in the range 1 through 1800.</maml:para> <maml:para>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>60</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></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 this switch parameter is present, the server certificate authentication is disabled while establishing the Gen9 or Gen10 target connection. If it is not present, server certificate authentication will execute according to the global certificate authentication setting. The default behavior is to authenticate server certificates.</maml:para> <maml:para>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></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</maml:para> </maml:description> <command:parameterValue required="true" variableLength="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.</maml:para> <maml:para>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.</maml:para> <maml:para>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. Used only when the target is iLO. The parameter accepts values in the range 1 through 1800.</maml:para> <maml:para>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>60</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></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 this switch parameter is present, the server certificate authentication is disabled while establishing the Gen9 or Gen10 target connection. If it is not present, server certificate authentication will execute according to the global certificate authentication setting. The default behavior is to authenticate server certificates.</maml:para> <maml:para>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></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.</maml:para> <maml:para>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.</maml:para> <maml:para>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.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>HPE.BIOS.Connection[] or System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>If the cmdlet executes successfully, it returns HPE.BIOS.Connection[].In case of 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></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 C:\PS> $connection = Connect-HPEiLO -IP 10.20.30.30 -Username admin -Password admin123 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 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>onnection using CredentialSet C:\PS> $Credential = Get-Credential; C:\PS> $connection = Connect-HPEiLO -IP 10.20.30.30 -Credential $Credential 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>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 : gen9pos.com Timeout : 30 DisableCertificateAuthentication : True TargetInfo : @{ProductName=ProLiant BL460c Gen9; ServerFamily=ProLiant; ServerGeneration=Gen9; ServerModel=BL460c; 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==}</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 4</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 5</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 BL460 Gen9; ServerFamily=ProLiant; ServerGeneration=Gen9; 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>This example shows the output of the Connect-HPEiLO cmdlet with range of IP address.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 6</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.41,42" -Username username -Password password PS C:\> $connection 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=} 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>This example shows the output of the Connect-HPEBIOS cmdlet with a list of target IP addresses with corresponding user names and passwords as named parameters.</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 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-HPEBIOSConnection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSEmbeddedLOMPort</command:name> <maml:description> <maml:para>The Disable-HPEBIOSEmbeddedLOMPort cmdlet disables the network boot for the installed Network Interface Cards (NIC).</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>HPEBIOSEmbeddedLOMPort</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disable-HPEBIOSEmbeddedLOMPort cmdlet disables the network boot for the installed Network Interface Card (NIC). This cmdlet has the following parameters.</maml:para> <maml:para>· DisableNetworkBoot</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disable-HPEBIOSEmbeddedLOMPort</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>DisableNetworkBoot</maml:name> <maml:description> <maml:para>Disables the network boot of the installed NIC slots (devices listed vary from system to system). Provides NIC device names as the parameter value. Possible values are NICBoot1, NICBoot2, NICBoot3, NICBoot4, NICBoot5, NICBoot6, NICBoot7, NICBoot8, NICBoot9, NICBoot10, NICBoot11, NICBoot12, NICBoot13, NICBoot14, NICBoot15, and NICBoot16.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>DisableNetworkBoot</maml:name> <maml:description> <maml:para>Disables the network boot of the installed NIC slots (devices listed vary from system to system). Provides NIC device names as the parameter value. Possible values are NICBoot1, NICBoot2, NICBoot3, NICBoot4, NICBoot5, NICBoot6, NICBoot7, NICBoot8, NICBoot9, NICBoot10, NICBoot11, NICBoot12, NICBoot13, NICBoot14, NICBoot15, and NICBoot16.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] System.Object</maml:name> <maml:uri></maml: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 or System.Management.Automation.PSObject[]</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 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>· You might need to configure the NIC firmware to activate the boot option.</maml:para> <maml:para>· NICBoot1 to NICBoot12 is supported only on Gen8 and Gen10 servers.</maml:para> <maml:para>· NICBoot1 to NICBoot16 is supported only on Gen9 servers.</maml:para> <maml:para>· The parameter DisableNetworkBoot accepts the string or string[] for a single BIOS connection and the jagged array for a BIOS multi-connection.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $NICBoot = ,("NICBoot3", "NICBoot9", "NICBoot16") PS C:\> $connection | Disable-HPEBIOSEmbeddedLOMPort -DisableNetworkBoot $NICBoot</dev:code> <dev:remarks> <maml:para>This example disables the NICBoot3, NICBoot9, and NICBoot16 on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $NICBoot = ,("NICBoot2", "NICBoot6", "NICBoot10", "NICBoot11") PS C:\> Disable-HPEBIOSEmbeddedLOMPort -Connection $connection -DisableNetworkBoot $NICBoot</dev:code> <dev:remarks> <maml:para>This example disables the NICBoot2, NICBoot6, NICBoot10, and NICBoot11 on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $NICBoot = ,("NICBoot3","NICBoot10") PS C:\> Disable-HPEBIOSEmbeddedLOMPort -Connection $connection -DisableNetworkBoot $NICBoot</dev:code> <dev:remarks> <maml:para>This example disables the NICBoot3 and NICBoot10 for all Gen9 servers with a list of BIOS 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Disable-HPEBIOSEmbeddedLOMPort -Connection $connection -DisableNetworkBoot ("NICBoot4","NICBoot6"),("NICBoot2","NICBoot3")</dev:code> <dev:remarks> <maml:para>This example disables the specified NICBoots on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSEmbeddedLOMPort</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEBIOSEmbeddedLOMPort</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSLog</command:name> <maml:description> <maml:para>The Disable-HPEBIOSLog cmdlet disables the HPEBIOSCmdlets logging for the current PowerShell session.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>HPEBIOSLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disable-HPEBIOSLog cmdlet disables the HPEBIOSCmdlets logging for the current PowerShell session.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disable-HPEBIOSLog</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml: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:\> Disable-HPEBIOSLog Logging disabled for the current session !!!</dev:code> <dev:remarks> <maml:para>This example disables the HPEBIOSCmdlets logging for the current PowerShell session.</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-HPEBIOSLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEBIOSLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSNVDIMMErase</command:name> <maml:description> <maml:para>The Disable-HPEBIOSNVDIMMErase cmdlet disable the BIOS NVDIMM erase.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>HPEBIOSNVDIMMErase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disable-HPEBIOSNVDIMMErase cmdlet disables the BIOS NVDIMM erase. This cmdlet has the following parameters.</maml:para> <maml:para>. DisableNVDIMMErase (available on Gen10 with Intel processor and Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disable-HPEBIOSNVDIMMErase</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>DisableNVDIMMErase</maml:name> <maml:description> <maml:para>Disables NVDIMM erase for specific NVDIMM. Possible values are AllNVDIMM, AllProcessor1NVDIMM, AllProcessor2NVDIMM, AllProcessor3NVDIMM, AllProcessor4NVDIMM, Processor1NVDIMM1, Processor1NVDIMM2, Processor1NVDIMM3, Processor1NVDIMM4, Processor1NVDIMM5, Processor1NVDIMM6, Processor1NVDIMM7, Processor1NVDIMM8, Processor1NVDIMM9, Processor1NVDIMM10, Processor1NVDIMM11, Processor1NVDIMM12, Processor2NVDIMM1, Processor2NVDIMM2, Processor2NVDIMM3, Processor2NVDIMM4, Processor2NVDIMM5, Processor2NVDIMM6, Processor2NVDIMM7, Processor2NVDIMM8, Processor2NVDIMM9, Processor2NVDIMM10, Processor2NVDIMM11, Processor2NVDIMM12, Processor3NVDIMM1, Processor3NVDIMM2, Processor3NVDIMM3, Processor3NVDIMM4, Processor3NVDIMM5, Processor3NVDIMM6, Processor3NVDIMM7, Processor3NVDIMM8, Processor3NVDIMM9, Processor3NVDIMM10, Processor3NVDIMM11, Processor3NVDIMM12, Processor4NVDIMM1, Processor4NVDIMM2, Processor4NVDIMM3, Processor4NVDIMM4, Processor4NVDIMM5, Processor4NVDIMM6, Processor4NVDIMM7, Processor4NVDIMM8, Processor4NVDIMM9, Processor4NVDIMM10, Processor4NVDIMM11 and Processor4NVDIMM12.</maml:para> <maml:para>Note :- use enum [HPE.BIOS.NVDIMMErase] to get all possible 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>DisableNVDIMMErase</maml:name> <maml:description> <maml:para>Disables NVDIMM erase for specific NVDIMM. Possible values are AllNVDIMM, AllProcessor1NVDIMM, AllProcessor2NVDIMM, AllProcessor3NVDIMM, AllProcessor4NVDIMM, Processor1NVDIMM1, Processor1NVDIMM2, Processor1NVDIMM3, Processor1NVDIMM4, Processor1NVDIMM5, Processor1NVDIMM6, Processor1NVDIMM7, Processor1NVDIMM8, Processor1NVDIMM9, Processor1NVDIMM10, Processor1NVDIMM11, Processor1NVDIMM12, Processor2NVDIMM1, Processor2NVDIMM2, Processor2NVDIMM3, Processor2NVDIMM4, Processor2NVDIMM5, Processor2NVDIMM6, Processor2NVDIMM7, Processor2NVDIMM8, Processor2NVDIMM9, Processor2NVDIMM10, Processor2NVDIMM11, Processor2NVDIMM12, Processor3NVDIMM1, Processor3NVDIMM2, Processor3NVDIMM3, Processor3NVDIMM4, Processor3NVDIMM5, Processor3NVDIMM6, Processor3NVDIMM7, Processor3NVDIMM8, Processor3NVDIMM9, Processor3NVDIMM10, Processor3NVDIMM11, Processor3NVDIMM12, Processor4NVDIMM1, Processor4NVDIMM2, Processor4NVDIMM3, Processor4NVDIMM4, Processor4NVDIMM5, Processor4NVDIMM6, Processor4NVDIMM7, Processor4NVDIMM8, Processor4NVDIMM9, Processor4NVDIMM10, Processor4NVDIMM11 and Processor4NVDIMM12.</maml:para> <maml:para>Note :- use enum [HPE.BIOS.NVDIMMErase] to get all possible 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Disable-HPEBIOSNVDIMMErase -DisableNVDIMMErase AllNVDIMM</dev:code> <dev:remarks> <maml:para>This example disables the NVDIMM Erase for 'AllNVDIMM' on a Gen9 or Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $nvdimm = ,("AllProcessor1NVDIMM","AllProcessor2NVDIMM","AllProcessor3NVDIMM","AllProcessor4NVDIMM") PS C:\> $connection | Disable-HPEBIOSNVDIMMErase -DisableNVDIMMErase $nvdimm</dev:code> <dev:remarks> <maml:para>This example disables NVDIMM erase for the specified NVDIMMs on a Gen9 or Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Disable-HPEBIOSNVDIMMErase -Connection $connection -DisableNVDIMMErase Processor1NVDIMM1</dev:code> <dev:remarks> <maml:para>This example disables the NVDIMM erase for 'Processor1NVDIMM1' for Gen9 and Gen10 Intel servers with a list of BIOS 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Disable-HPEBIOSNVDIMMErase -Connection $connection -DisableNVDIMMErase @(@("Processor1NVDIMM2","Processor2NVDIMM5"), @("AllProcessor1NVDIMM","AllProcessor2NVDIMM","AllProcessor3NVDIMM","AllProcessor4NVDIMM"))</dev:code> <dev:remarks> <maml:para>This example disables the NVDIMM erase for the specified NVDIMMs on Gen9 and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSNVDIMMErase</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEBIOSNVDIMMErase</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPCIDeviceOption</command:name> <maml:description> <maml:para>The Disable-HPEBIOSPCIDeviceOption cmdlet disables the embedded and add-in BIOS PCI devices for the target server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>HPEBIOSPCIDeviceOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disable-HPEBIOSPCIDeviceOption cmdlet disables the embedded and add-in PCI devices on the target server. Disabling devices reallocates the resources (memory, I/O, ROM space, and power) that are normally allocated to the device. By default, all devices are enabled. This cmdlet has the following parameters.</maml:para> <maml:para>· DisablePCIDevice (only available on Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disable-HPEBIOSPCIDeviceOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>DisablePCIDevice</maml:name> <maml:description> <maml:para>Disables PCI devices such as embedded LOM port, SATA controller, and PCIe slots. Provide the PCI device names as the parameter value.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>DisablePCIDevice</maml:name> <maml:description> <maml:para>Disables PCI devices such as embedded LOM port, SATA controller, and PCIe slots. Provide the PCI device names as the parameter value.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Disable-HPEBIOSPCIDeviceOption -DisablePCIDevice EmbeddedSATAController1</dev:code> <dev:remarks> <maml:para>This example disables the PCIDevice 'EmbeddedSATAController1' on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $PCIDevice = ,("EmbeddedFlexibleLOM2","EmbeddedSATAController2","PCIeSlot1","PCIeSlot4","PCIeSlot7","PCIeSlot9") PS C:\> $connection | Disable-HPEBIOSPCIDeviceOption -DisablePCIDevice $PCIDevice</dev:code> <dev:remarks> <maml:para>This example disables the specified PCIDevices on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Disable-HPEBIOSPCIDeviceOption -Connection $connection -DisablePCIDevice PCIeSlot2</dev:code> <dev:remarks> <maml:para>This example disables the PCIDevice 'PCIeBoot2' for Gen9 servers with a list of BIOS connection object 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Disable-HPEBIOSPCIDeviceOption -Connection $connection -DisablePCIDevice ("EmbeddedFlexibleLOM1","PCIeBoot1"),("EmbeddedSATAController2","PCIeBoot2","PCIeBoot3")</dev:code> <dev:remarks> <maml:para>This example disables the specified PCIDevices on Gen9 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSPCIDeviceOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEBIOSPCIDeviceOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPCIeSlotNetworkBootOption</command:name> <maml:description> <maml:para>The Disable-HPEBIOSPCIeSlotNetworkBootOption cmdlet disables the embedded and add-in BIOS PCI devices for the target server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>HPEBIOSPCIeSlotNetworkBootOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disable-HPEBIOSPCIeSlotNetworkBootOption cmdlet disables the UEFI PXE boot status for the installed Network Interface Card (NIC) in PCIe slots on the target server. This cmdlet has the following parameters.</maml:para> <maml:para>· DisablePXEBoot</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Disable-HPEBIOSPCIeSlotNetworkBootOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>DisablePXEBoot</maml:name> <maml:description> <maml:para>Disables the UEFI PXE boot of the installed NIC cards in the PCIe slots (devices listed vary from system to system). Provides PCI slot name with NIC boot name as the parameter value. Possible values are Slot1NICBoot1 to Slot1NICBoot8, Slot2NICBoot1 to Slot2NICBoot8, Slot3NICBoot1 to Slot3NICBoot8, Slot4NICBoot1 to Slot4NICBoot8, Slot5NICBoot1 to Slot5NICBoot8, Slot6NICBoot1 to Slot6NICBoot8, Slot7NICBoot1 to Slot7NICBoot4, Slot8NICBoot1 to Slot8NICBoot4, Slot9NICBoot1 to Slot9NICBoot8, Slot10NICBoot1 to Slot10NICBoot8, Slot11NICBoot1 to Slot11NICBoot8, Slot12NICBoot1 to Slot12NICBoot8, Slot13NICBoot1 to Slot13NICBoot8, Slot14NICBoot1 to Slot14NICBoot8, Slot15NICBoot1 to Slot15NICBoot8, Slot16NICBoot1 to Slot16NICBoot8 and Slot21NICBoot1 to Slot21NICBoot8.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>DisablePXEBoot</maml:name> <maml:description> <maml:para>Disables the UEFI PXE boot of the installed NIC cards in the PCIe slots (devices listed vary from system to system). Provides PCI slot name with NIC boot name as the parameter value. Possible values are Slot1NICBoot1 to Slot1NICBoot8, Slot2NICBoot1 to Slot2NICBoot8, Slot3NICBoot1 to Slot3NICBoot8, Slot4NICBoot1 to Slot4NICBoot8, Slot5NICBoot1 to Slot5NICBoot8, Slot6NICBoot1 to Slot6NICBoot8, Slot7NICBoot1 to Slot7NICBoot4, Slot8NICBoot1 to Slot8NICBoot4, Slot9NICBoot1 to Slot9NICBoot8, Slot10NICBoot1 to Slot10NICBoot8, Slot11NICBoot1 to Slot11NICBoot8, Slot12NICBoot1 to Slot12NICBoot8, Slot13NICBoot1 to Slot13NICBoot8, Slot14NICBoot1 to Slot14NICBoot8, Slot15NICBoot1 to Slot15NICBoot8, Slot16NICBoot1 to Slot16NICBoot8 and Slot21NICBoot1 to Slot21NICBoot8.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Disable-HPEBIOSPCIeSlotNetworkBootOption -DisablePXEBoot Slot1NICBoot1</dev:code> <dev:remarks> <maml:para>This example disables the Slot1NICBoot1 on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $PCIeSlot = ,("Slot1NICBoot1","Slot1NICBoot5","Slot2NICBoot1") PS C:\> $connection | Disable-HPEBIOSPCIeSlotNetworkBootOption -DisablePXEBoot $PCIeSlot</dev:code> <dev:remarks> <maml:para>This example disables the specified PCIeSlots on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Disable-HPEBIOSPCIeSlotNetworkBootOption -Connection $connection -DisablePXEBoot Slot2NICBoot4</dev:code> <dev:remarks> <maml:para>This example disables the Slot2NICBoot4 on Gen9 and Gen10 servers with a list of BIOS 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Disable-HPEBIOSPCIeSlotNetworkBootOption -Connection $connection -DisablePXEBoot ("Slot1NICBoot1","Slot2NICBoot3"),("Slot1NICBoot2","Slot2NICBoot1","Slot3NICBoot1")</dev:code> <dev:remarks> <maml:para>This example disables the specified PCIeSlots on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSPCIeSlotNetworkBootOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEBIOSPCIeSlotNetworkBootOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOS</command:name> <maml:description> <maml:para>The Disconnect-HPEBIOS cmdlet closes the connection.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>HPEBIOS</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disconnect-HPEBIOS cmdlet closes the connection and cleans up the resource.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet" default="true"> <!--NAME: UsernamePasswordSet--> <!--TAG: DEFAULT--> <maml:name>Disconnect-HPEBIOS</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>HPE.BIOS.Connection[]</maml:name> <maml:uri></maml: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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> Disconnect-HPEBIOS $connection</dev:code> <dev:remarks> <maml:para>This example disconnects the connection object passed as positional 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-HPEBIOS -IP 10.20.30.1,10.20.30.2,10,20.30.3 -Username admin -Password admin123 PS C:\> $connection | Disconnect-HPEBIOS</dev:code> <dev:remarks> <maml:para>This example disconnects a list of BIOS connection objects passed through a pipeline.</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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-HPEBIOSConnection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Edit-HPEBIOSiSCSIBootAttempt</command:name> <maml:description> <maml:para>The Edit-HPEBIOSiSCSIBootAttempt cmdlet edits an existing iSCSI boot attempt in the iSCSI source array.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Edit</command:verb> <command:noun>HPEBIOSiSCSIBootAttempt</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Edit-HPEBIOSiSCSIBootAttempt cmdlet edits an existing iSCSI boot attempt in the iSCSI source array. This cmdlet has the following parameters:</maml:para> <maml:para>· iSCSIBootAttemptIndex</maml:para> <maml:para>· iSCSINICSource</maml:para> <maml:para>· iSCSIAttemptName</maml:para> <maml:para>· iSCSIConnection</maml:para> <maml:para>· iSCSIConnectRetry</maml:para> <maml:para>· iSCSIConnectTimeout</maml:para> <maml:para>· iSCSIIPAddressType</maml:para> <maml:para>· iSCSIAuthenticationMethod</maml:para> <maml:para>· iSCSIInitiatorInfoViaDHCP</maml:para> <maml:para>· iSCSIInitiatorIPAddress</maml:para> <maml:para>· iSCSIInitiatorNetmask</maml:para> <maml:para>· iSCSIInitiatorGateway</maml:para> <maml:para>· iSCSITargetInfoViaDHCP</maml:para> <maml:para>· iSCSITargetName</maml:para> <maml:para>· iSCSITargetIPAddress</maml:para> <maml:para>· iSCSILogicalUnitNumber</maml:para> <maml:para>· iSCSITargetTCPPort</maml:para> <maml:para>· iSCSICHAPType</maml:para> <maml:para>· iSCSICHAPUsername</maml:para> <maml:para>· iSCSICHAPSecret</maml:para> <maml:para>· iSCSIReverseCHAPUsername</maml:para> <maml:para>· iSCSIReverseCHAPSecret</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Edit-HPEBIOSiSCSIBootAttempt</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>iSCSIBootAttemptIndex</maml:name> <maml:description> <maml:para>Specifies the iSCSI boot attempt source array index which has iSCSIAttemptInstance=0. Possible values range between 1 and 4.</maml:para> <maml:para>Note: · You can use the Get-HPEBIOSiSCSIBootAttempt cmdlet to know the iSCSIAttemptInstance details in the iSCSI source array. · You can either use the unused iSCSI source array index which has iSCSIAttemptInstance=0 or delete the existing index using the Remove-HPEBIOSiSCSIBootAttemptc cmdlet. · An error is thrown when you specify the array index which is already in use.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIAttemptName</maml:name> <maml:description> <maml:para>Specifies the human readable descriptive name for the iSCSI attempt configuration.</maml:para> </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>iSCSIConnection</maml:name> <maml:description> <maml:para>Enables or Disables iSCSI mode for a selected iSCSI attempt. Possible values are Disabled, Enabled, and EnabledForMPIO.</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">EnabledForMPIO</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIIPAddressType</maml:name> <maml:description> <maml:para>Specifies an iSCSI IP Address type. If set to Auto, IPv4 is attempted first, followed by IPv6. Possible values are Auto, IPv4, and IPv6.</maml:para> <maml:para>Note: · The iSCSI initiator and target configuration parameters are not considered for iSCSI connection when iSCSIIPAddressType is either Auto or IPv6.</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">IPv4</command:parameterValue> <command:parameterValue required="false" variableLength="false">IPv6</command:parameterValue> </command:parameterValueGroup> <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>iSCSIConnectRetry</maml:name> <maml:description> <maml:para>Specifies the number of times to retry the iSCSI connection. Zero means no retries. Possible values range between 0 and 16.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIConnectTimeout</maml:name> <maml:description> <maml:para>Specifies the iSCSI connection timeout value in milliseconds. Possible values range between 100 and 20000.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIInitiatorInfoViaDHCP</maml:name> <maml:description> <maml:para>Specifies the iSCSI initiator DHCP configuration. If enabled, the iSCSI Initiator information is configured from DHCP. Otherwise, the iSCSI initiator information must be statically configured. When providing static values for the initiator, ensure that Target settings are also configured with static values. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note: · The iSCSIInitiatorIPAddress, iSCSIInitiatorNetmask, and iSCSIInitiatorGateway parameters are not considered for iSCSI connection when iSCSIInitiatorInfoViaDHCP 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIInitiatorIPAddress</maml:name> <maml:description> <maml:para>Specifies IP Address of the iSCSI initiator if not configured through DHCP. The Initiator IP Address is always auto-assigned if the IP address type is IPv6. The address must be an IPv4 address or IPv6 address, depending on the IP Address Type.</maml:para> </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>iSCSIInitiatorNetmask</maml:name> <maml:description> <maml:para>Specifies the subnet mask of the iSCSI initiator, if not configured through DHCP. The address must be an IPv4.</maml:para> </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>iSCSIInitiatorGateway</maml:name> <maml:description> <maml:para>Specifies the gateway address of the iSCSI initiator if not configured through DHCP. The address must be an IPv4 address or IPv6 address, depending on the IP Address Type.</maml:para> </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>iSCSITargetInfoViaDHCP</maml:name> <maml:description> <maml:para>Specifies the iSCSI target DHCP configuration. If enabled, the iSCSI target information are configured from DHCP. Otherwise, the iSCSI target information must be statically configured. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note: · The iSCSITargetName, iSCSITargetIPAddress, iSCSILogicalUnitNumber, and iSCSITargetTCPPort parameters are not considered for iSCSI connection when iSCSITargetInfoViaDHCP 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSITargetName</maml:name> <maml:description> <maml:para>Specifies the worldwide unique iSCSI Qualified Name (IQN) of this iSCSI target. Only the IQN format is accepted. For example, 'iqn.1991-05.com.microsoft:iscsitarget-iscsidisk-target'. EUI format is not supported.</maml:para> </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>iSCSITargetIPAddress</maml:name> <maml:description> <maml:para>Specifies IP Address of the iSCSI Target, if not obtained from DHCP. The address must be an IPv4 address or IPv6 address, depending on the IP Address Type.</maml:para> </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>iSCSILogicalUnitNumber</maml:name> <maml:description> <maml:para>Specifies the iSCSI target Logical Unit Number (LUN), if not obtained from DHCP. This value must follow the SAM-2 spec. Example: 0001-1234-5678-9ABC. If the number of characters is less than 5, a dash character is not required. Example: 0001. If the LUN number is 12345, input 1234-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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSITargetTCPPort</maml:name> <maml:description> <maml:para>Specifies the iSCSI Target TCP Port number if not obtained from DHCP.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIAuthenticationMethod</maml:name> <maml:description> <maml:para>Specifies the iSCSI connection authentication method. Possible values are None and CHAP.</maml:para> <maml:para>Note: · The iSCI CHAP and reverse CHAP parameters are not considered for iSCSI connection when iSCSIAuthenticationMethod is None.</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">CHAP</command:parameterValue> </command:parameterValueGroup> <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>iSCSICHAPType</maml:name> <maml:description> <maml:para>Specifies the CHAP authentication type. This is applicable only when the Authentication Method is set to CHAP. Possible values are OneWay and Mutual.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">OneWay</command:parameterValue> <command:parameterValue required="false" variableLength="false">Mutual</command:parameterValue> </command:parameterValueGroup> <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>iSCSICHAPUsername</maml:name> <maml:description> <maml:para>Specifies the user name needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.</maml:para> </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>iSCSICHAPSecret</maml:name> <maml:description> <maml:para>Specifies the password needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.</maml:para> </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>iSCSIReverseCHAPUsername</maml:name> <maml:description> <maml:para>Specifies the user name for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.</maml:para> </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>iSCSIReverseCHAPSecret</maml:name> <maml:description> <maml:para>Specifies the password needed for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>iSCSIBootAttemptIndex</maml:name> <maml:description> <maml:para>Specifies the iSCSI boot attempt source array index which has iSCSIAttemptInstance=0. Possible values range between 1 and 4.</maml:para> <maml:para>Note: · You can use the Get-HPEBIOSiSCSIBootAttempt cmdlet to know the iSCSIAttemptInstance details in the iSCSI source array. · You can either use the unused iSCSI source array index which has iSCSIAttemptInstance=0 or delete the existing index using the Remove-HPEBIOSiSCSIBootAttemptc cmdlet. · An error is thrown when you specify the array index which is already in use.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIAttemptName</maml:name> <maml:description> <maml:para>Specifies the human readable descriptive name for the iSCSI attempt configuration.</maml:para> </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>iSCSIConnection</maml:name> <maml:description> <maml:para>Enables or Disables iSCSI mode for a selected iSCSI attempt. Possible values are Disabled, Enabled, and EnabledForMPIO.</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">EnabledForMPIO</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIIPAddressType</maml:name> <maml:description> <maml:para>Specifies an iSCSI IP Address type. If set to Auto, IPv4 is attempted first, followed by IPv6. Possible values are Auto, IPv4, and IPv6.</maml:para> <maml:para>Note: · The iSCSI initiator and target configuration parameters are not considered for iSCSI connection when iSCSIIPAddressType is either Auto or IPv6.</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">IPv4</command:parameterValue> <command:parameterValue required="false" variableLength="false">IPv6</command:parameterValue> </command:parameterValueGroup> <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>iSCSIConnectRetry</maml:name> <maml:description> <maml:para>Specifies the number of times to retry the iSCSI connection. Zero means no retries. Possible values range between 0 and 16.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIConnectTimeout</maml:name> <maml:description> <maml:para>Specifies the iSCSI connection timeout value in milliseconds. Possible values range between 100 and 20000.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIInitiatorInfoViaDHCP</maml:name> <maml:description> <maml:para>Specifies the iSCSI initiator DHCP configuration. If enabled, the iSCSI Initiator information is configured from DHCP. Otherwise, the iSCSI initiator information must be statically configured. When providing static values for the initiator, ensure that Target settings are also configured with static values. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note: · The iSCSIInitiatorIPAddress, iSCSIInitiatorNetmask, and iSCSIInitiatorGateway parameters are not considered for iSCSI connection when iSCSIInitiatorInfoViaDHCP 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIInitiatorIPAddress</maml:name> <maml:description> <maml:para>Specifies IP Address of the iSCSI initiator if not configured through DHCP. The Initiator IP Address is always auto-assigned if the IP address type is IPv6. The address must be an IPv4 address or IPv6 address, depending on the IP Address Type.</maml:para> </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>iSCSIInitiatorNetmask</maml:name> <maml:description> <maml:para>Specifies the subnet mask of the iSCSI initiator, if not configured through DHCP. The address must be an IPv4.</maml:para> </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>iSCSIInitiatorGateway</maml:name> <maml:description> <maml:para>Specifies the gateway address of the iSCSI initiator if not configured through DHCP. The address must be an IPv4 address or IPv6 address, depending on the IP Address Type.</maml:para> </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>iSCSITargetInfoViaDHCP</maml:name> <maml:description> <maml:para>Specifies the iSCSI target DHCP configuration. If enabled, the iSCSI target information are configured from DHCP. Otherwise, the iSCSI target information must be statically configured. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note: · The iSCSITargetName, iSCSITargetIPAddress, iSCSILogicalUnitNumber, and iSCSITargetTCPPort parameters are not considered for iSCSI connection when iSCSITargetInfoViaDHCP 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSITargetName</maml:name> <maml:description> <maml:para>Specifies the worldwide unique iSCSI Qualified Name (IQN) of this iSCSI target. Only the IQN format is accepted. For example, 'iqn.1991-05.com.microsoft:iscsitarget-iscsidisk-target'. EUI format is not supported.</maml:para> </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>iSCSITargetIPAddress</maml:name> <maml:description> <maml:para>Specifies IP Address of the iSCSI Target, if not obtained from DHCP. The address must be an IPv4 address or IPv6 address, depending on the IP Address Type.</maml:para> </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>iSCSILogicalUnitNumber</maml:name> <maml:description> <maml:para>Specifies the iSCSI target Logical Unit Number (LUN), if not obtained from DHCP. This value must follow the SAM-2 spec. Example: 0001-1234-5678-9ABC. If the number of characters is less than 5, a dash character is not required. Example: 0001. If the LUN number is 12345, input 1234-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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSITargetTCPPort</maml:name> <maml:description> <maml:para>Specifies the iSCSI Target TCP Port number if not obtained from DHCP.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>iSCSIAuthenticationMethod</maml:name> <maml:description> <maml:para>Specifies the iSCSI connection authentication method. Possible values are None and CHAP.</maml:para> <maml:para>Note: · The iSCI CHAP and reverse CHAP parameters are not considered for iSCSI connection when iSCSIAuthenticationMethod is None.</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">CHAP</command:parameterValue> </command:parameterValueGroup> <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>iSCSICHAPType</maml:name> <maml:description> <maml:para>Specifies the CHAP authentication type. This is applicable only when the Authentication Method is set to CHAP. Possible values are OneWay and Mutual.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">OneWay</command:parameterValue> <command:parameterValue required="false" variableLength="false">Mutual</command:parameterValue> </command:parameterValueGroup> <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>iSCSICHAPUsername</maml:name> <maml:description> <maml:para>Specifies the user name needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.</maml:para> </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>iSCSICHAPSecret</maml:name> <maml:description> <maml:para>Specifies the password needed for CHAP authentication. This is applicable only when the Authentication Method is set to CHAP.</maml:para> </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>iSCSIReverseCHAPUsername</maml:name> <maml:description> <maml:para>Specifies the user name for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.</maml:para> </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>iSCSIReverseCHAPSecret</maml:name> <maml:description> <maml:para>Specifies the password needed for reverse CHAP authentication (from the target to the initiator). This is applicable only when the Authentication Method is set to CHAP, and the CHAP Type is set to Mutual.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Edit-HPEBIOSiSCSIBootAttempt -iSCSIBootAttemptIndex 2 -iSCSIAttemptName "iSCSISource1" -iSCSIConnection EnabledForMPIO -iSCSIIPAddressType IPv6</dev:code> <dev:remarks> <maml:para>This example edits an existing iSCSI boot attempt instance of index 2 on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Edit-HPEBIOSiSCSIBootAttempt -Connection $connection -iSCSIBootAttemptIndex 1 -iSCSIConnection Enabled -iSCSIIPAddressType Auto</dev:code> <dev:remarks> <maml:para>This example edits an existing iSCSI boot attempt instance of index 1 on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSiSCSIBootAttempt</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEBIOSiSCSIBootAttempt</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEBIOSiSCSIBootAttempt</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSEmbeddedLOMPort</command:name> <maml:description> <maml:para>The Enable-HPEBIOSEmbeddedLOMPort cmdlet enables the network boot for the installed Network Interface Cards (NIC).</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>HPEBIOSEmbeddedLOMPort</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Enable-HPEBIOSEmbeddedLOMPort cmdlet enables the network boot for the installed Network Interface Card (NIC). This cmdlet has the following parameter:</maml:para> <maml:para>· EnableNetworkBoot</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Enable-HPEBIOSEmbeddedLOMPort</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EnableNetworkBoot</maml:name> <maml:description> <maml:para>Enables the network boot of the installed NIC slots (devices listed vary from system to system). Provides NIC device names as the parameter value. Possible values are NICBoot1, NICBoot2, NICBoot3, NICBoot4, NICBoot5, NICBoot6, NICBoot7, NICBoot8, NICBoot9, NICBoot10, NICBoot11, NICBoot12, NICBoot13, NICBoot14, NICBoot15, and NICBoot16.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EnableNetworkBoot</maml:name> <maml:description> <maml:para>Enables the network boot of the installed NIC slots (devices listed vary from system to system). Provides NIC device names as the parameter value. Possible values are NICBoot1, NICBoot2, NICBoot3, NICBoot4, NICBoot5, NICBoot6, NICBoot7, NICBoot8, NICBoot9, NICBoot10, NICBoot11, NICBoot12, NICBoot13, NICBoot14, NICBoot15, and NICBoot16.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] System.Object</maml:name> <maml:uri></maml: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 or System.Management.Automation.PSObject[]</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 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>· You might need to configure the NIC firmware to activate the boot option.</maml:para> <maml:para>· NICBoot1 to NICBoot12 is supported only on Gen10 servers.</maml:para> <maml:para>· NICBoot1 to NICBoot16 is supported only on Gen9 servers.</maml:para> <maml:para>· The parameter EnableNetworkBoot accepts the string or string[] for single BIOS connection and the jagged array for BIOS multi-connection.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $NICBoot = ,("NICBoot3", "NICBoot9", "NICBoot16") PS C:\> $connection | Enable-HPEBIOSEmbeddedLOMPort -EnableNetworkBoot $NICBoot</dev:code> <dev:remarks> <maml:para>This example enables the NICBoot3, NICBoot9 and NICBoot16 on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $NICBoot = ,("NICBoot2", "NICBoot6", "NICBoot10", "NICBoot11") PS C:\> Enable-HPEBIOSEmbeddedLOMPort -Connection $connection -EnableNetworkBoot $NICBoot</dev:code> <dev:remarks> <maml:para>This example enables the NICBoot2, NICBoot6, NICBoot10 and NICBoot11 on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $NICBoot = ,("NICBoot3","NICBoot10") PS C:\> Enable-HPEBIOSEmbeddedLOMPort -Connection $connection -EnableNetworkBoot $NICBoot</dev:code> <dev:remarks> <maml:para>This example enables the NICBoot3 and NICBoot10 for all Gen9 servers with a list of BIOS 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Enable-HPEBIOSEmbeddedLOMPort -Connection $connection -EnableNetworkBoot ("NICBoot4","NICBoot6"),("NICBoot2","NICBoot3")</dev:code> <dev:remarks> <maml:para>This example enables the specified NICBoots on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSEmbeddedLOMPort</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEBIOSEmbeddedLOMPort</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSLog</command:name> <maml:description> <maml:para>The Enable-HPEBIOSLog cmdlet enables the HPEBIOSCmdlets logging for the current PowerShell session.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>HPEBIOSLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Enable-HPEBIOSLog cmdlet enables the HPEBIOSCmdlets logging for the current PowerShell session. By default, logging is disabled and must be enabled explicitly.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Enable-HPEBIOSLog</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml: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:\> Enable-HPEBIOSLog Logging enabled for the current session !!!</dev:code> <dev:remarks> <maml:para>This example enables HPEBIOSCmdlets logging for the current PowerShell session.</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-HPEBIOSLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEBIOSLog</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSNVDIMMErase</command:name> <maml:description> <maml:para>The Enable-HPEBIOSNVDIMMErase cmdlet enables the BIOS NVDIMM erase.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>HPEBIOSNVDIMMErase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Enable-HPEBIOSNVDIMMErase cmdlet enables the BIOS NVDIMM erase. This cmdlet has the following parameter:</maml:para> <maml:para>. EnableNVDIMMErase (available on Gen10 with Intel processor and Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Enable-HPEBIOSNVDIMMErase</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EnableNVDIMMErase</maml:name> <maml:description> <maml:para>Enables NVDIMM erase for specific NVDIMM. Possible values are AllNVDIMM, AllProcessor1NVDIMM, AllProcessor2NVDIMM, AllProcessor3NVDIMM, AllProcessor4NVDIMM, Processor1NVDIMM1, Processor1NVDIMM2, Processor1NVDIMM3, Processor1NVDIMM4, Processor1NVDIMM5, Processor1NVDIMM6, Processor1NVDIMM7, Processor1NVDIMM8, Processor1NVDIMM9, Processor1NVDIMM10, Processor1NVDIMM11, Processor1NVDIMM12, Processor2NVDIMM1, Processor2NVDIMM2, Processor2NVDIMM3, Processor2NVDIMM4, Processor2NVDIMM5, Processor2NVDIMM6, Processor2NVDIMM7, Processor2NVDIMM8, Processor2NVDIMM9, Processor2NVDIMM10, Processor2NVDIMM11, Processor2NVDIMM12, Processor3NVDIMM1, Processor3NVDIMM2, Processor3NVDIMM3, Processor3NVDIMM4, Processor3NVDIMM5, Processor3NVDIMM6, Processor3NVDIMM7, Processor3NVDIMM8, Processor3NVDIMM9, Processor3NVDIMM10, Processor3NVDIMM11, Processor3NVDIMM12, Processor4NVDIMM1, Processor4NVDIMM2, Processor4NVDIMM3, Processor4NVDIMM4, Processor4NVDIMM5, Processor4NVDIMM6, Processor4NVDIMM7, Processor4NVDIMM8, Processor4NVDIMM9, Processor4NVDIMM10, Processor4NVDIMM11 and Processor4NVDIMM12.</maml:para> <maml:para>Note :- use enum [HPE.BIOS.NVDIMMErase] to get all possible 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EnableNVDIMMErase</maml:name> <maml:description> <maml:para>Enables NVDIMM erase for specific NVDIMM. Possible values are AllNVDIMM, AllProcessor1NVDIMM, AllProcessor2NVDIMM, AllProcessor3NVDIMM, AllProcessor4NVDIMM, Processor1NVDIMM1, Processor1NVDIMM2, Processor1NVDIMM3, Processor1NVDIMM4, Processor1NVDIMM5, Processor1NVDIMM6, Processor1NVDIMM7, Processor1NVDIMM8, Processor1NVDIMM9, Processor1NVDIMM10, Processor1NVDIMM11, Processor1NVDIMM12, Processor2NVDIMM1, Processor2NVDIMM2, Processor2NVDIMM3, Processor2NVDIMM4, Processor2NVDIMM5, Processor2NVDIMM6, Processor2NVDIMM7, Processor2NVDIMM8, Processor2NVDIMM9, Processor2NVDIMM10, Processor2NVDIMM11, Processor2NVDIMM12, Processor3NVDIMM1, Processor3NVDIMM2, Processor3NVDIMM3, Processor3NVDIMM4, Processor3NVDIMM5, Processor3NVDIMM6, Processor3NVDIMM7, Processor3NVDIMM8, Processor3NVDIMM9, Processor3NVDIMM10, Processor3NVDIMM11, Processor3NVDIMM12, Processor4NVDIMM1, Processor4NVDIMM2, Processor4NVDIMM3, Processor4NVDIMM4, Processor4NVDIMM5, Processor4NVDIMM6, Processor4NVDIMM7, Processor4NVDIMM8, Processor4NVDIMM9, Processor4NVDIMM10, Processor4NVDIMM11 and Processor4NVDIMM12.</maml:para> <maml:para>Note :- use enum [HPE.BIOS.NVDIMMErase] to get all possible 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Enable-HPEBIOSNVDIMMErase -EnableNVDIMMErase AllNVDIMM</dev:code> <dev:remarks> <maml:para>This example enables the NVDIMM Erase for 'AllNVDIMM' on a Gen9 or Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $nvdimm = ,@("AllProcessor1NVDIMM","AllProcessor2NVDIMM","AllProcessor3NVDIMM","AllProcessor4NVDIMM") PS C:\> $connection | Enable-HPEBIOSNVDIMMErase -EnableNVDIMMErase $nvdimm</dev:code> <dev:remarks> <maml:para>This example enables NVDIMM erase for the specified NVDIMMs on a Gen9 or Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Enable-HPEBIOSNVDIMMErase -Connection $connection -EnableNVDIMMErase Processor1NVDIMM1</dev:code> <dev:remarks> <maml:para>This example enables the NVDIMM erase for 'Processor1NVDIMM1' for Gen9 and Gen10 Intel servers with a list of BIOS connection object 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Enable-HPEBIOSNVDIMMErase -Connection $connection -EnableNVDIMMErase @(@("Processor1NVDIMM2","Processor2NVDIMM5"), @("AllProcessor1NVDIMM","AllProcessor2NVDIMM","AllProcessor3NVDIMM","AllProcessor4NVDIMM"))</dev:code> <dev:remarks> <maml:para>This example enables the NVDIMM erase for the specified NVDIMMs on Gen9 and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSNVDIMMErase</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEBIOSNVDIMMErase</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPCIDeviceOption</command:name> <maml:description> <maml:para>The Enable-HPEBIOSPCIDeviceOption cmdlet enables the embedded and add-in BIOS PCI devices for the target server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>HPEBIOSPCIDeviceOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Enable-HPEBIOSPCIDeviceOption cmdlet enables the embedded and add-in PCI devices on the target server. Disabling devices reallocates the resources (memory, I/O, ROM space, and power) that are normally allocated to the device. By default, all devices are enabled. This cmdlet has the following parameters.</maml:para> <maml:para>· EnablePCIDevice (only available on Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Enable-HPEBIOSPCIDeviceOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EnablePCIDevice</maml:name> <maml:description> <maml:para>Enables PCI devices such as embedded LOM port, SATA controller, and PCIe slots. Provide the PCI device names as the parameter value.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EnablePCIDevice</maml:name> <maml:description> <maml:para>Enables PCI devices such as embedded LOM port, SATA controller, and PCIe slots. Provide the PCI device names as the parameter value.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Enable-HPEBIOSPCIDeviceOption -EnablePCIDevice EmbeddedSATAController1</dev:code> <dev:remarks> <maml:para>This example enables the PCIDevice 'EmbeddedSATAController1' on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $PCIDevice = ,("EmbeddedFlexibleLOM2","EmbeddedSATAController2","PCIeSlot1","PCIeSlot4","PCIeSlot7","PCIeSlot9") PS C:\> $connection | Enable-HPEBIOSPCIDeviceOption -EnablePCIDevice $PCIDevice</dev:code> <dev:remarks> <maml:para>This example enables the specified PCIDevices on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Enable-HPEBIOSPCIDeviceOption -Connection $connection -EnablePCIDevice PCIeSlot2</dev:code> <dev:remarks> <maml:para>This example enables the PCIDevice 'PCIeBoot2' for Gen9 servers with a list of BIOS connection object 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Enable-HPEBIOSPCIDeviceOption -Connection $connection -EnablePCIDevice ("EmbeddedFlexibleLOM1","PCIeBoot1"),("EmbeddedSATAController2","PCIeBoot2","PCIeBoot3")</dev:code> <dev:remarks> <maml:para>This example enables the specified PCIDevices on Gen9 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSPCIDeviceOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEBIOSPCIDeviceOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPCIeSlotNetworkBootOption</command:name> <maml:description> <maml:para>The Enable-HPEBIOSPCIeSlotNetworkBootOption cmdlet enables the embedded and add-in BIOS PCI devices for the target server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>HPEBIOSPCIeSlotNetworkBootOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Enable-HPEBIOSPCIeSlotNetworkBootOption cmdlet enables the UEFI PXE boot status for the installed Network Interface Card (NIC) in PCIe slots on the target server. This cmdlet has the following parameter:</maml:para> <maml:para>· EnablePXEBoot</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Enable-HPEBIOSPCIeSlotNetworkBootOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EnablePXEBoot</maml:name> <maml:description> <maml:para>Enables the UEFI PXE boot of the installed NIC cards in the PCIe slots (devices listed vary from system to system). Provides PCI slot name with NIC boot name as the parameter value. Possible values are Slot1NICBoot1 to Slot1NICBoot8, Slot2NICBoot1 to Slot2NICBoot8, Slot3NICBoot1 to Slot3NICBoot8, Slot4NICBoot1 to Slot4NICBoot8, Slot5NICBoot1 to Slot5NICBoot8, Slot6NICBoot1 to Slot6NICBoot8, Slot7NICBoot1 to Slot7NICBoot4, Slot8NICBoot1 to Slot8NICBoot4, Slot9NICBoot1 to Slot9NICBoot8, Slot10NICBoot1 to Slot10NICBoot8, Slot11NICBoot1 to Slot11NICBoot8, Slot12NICBoot1 to Slot12NICBoot8, Slot13NICBoot1 to Slot13NICBoot8, Slot14NICBoot1 to Slot14NICBoot8, Slot15NICBoot1 to Slot15NICBoot8, Slot16NICBoot1 to Slot16NICBoot8, and Slot21NICBoot1 to Slot21NICBoot8.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EnablePXEBoot</maml:name> <maml:description> <maml:para>Enables the UEFI PXE boot of the installed NIC cards in the PCIe slots (devices listed vary from system to system). Provides PCI slot name with NIC boot name as the parameter value. Possible values are Slot1NICBoot1 to Slot1NICBoot8, Slot2NICBoot1 to Slot2NICBoot8, Slot3NICBoot1 to Slot3NICBoot8, Slot4NICBoot1 to Slot4NICBoot8, Slot5NICBoot1 to Slot5NICBoot8, Slot6NICBoot1 to Slot6NICBoot8, Slot7NICBoot1 to Slot7NICBoot4, Slot8NICBoot1 to Slot8NICBoot4, Slot9NICBoot1 to Slot9NICBoot8, Slot10NICBoot1 to Slot10NICBoot8, Slot11NICBoot1 to Slot11NICBoot8, Slot12NICBoot1 to Slot12NICBoot8, Slot13NICBoot1 to Slot13NICBoot8, Slot14NICBoot1 to Slot14NICBoot8, Slot15NICBoot1 to Slot15NICBoot8, Slot16NICBoot1 to Slot16NICBoot8, and Slot21NICBoot1 to Slot21NICBoot8.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Enable-HPEBIOSPCIeSlotNetworkBootOption -EnablePXEBoot Slot1NICBoot1</dev:code> <dev:remarks> <maml:para>This example enables the Slot1NICBoot1 on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $PCIeSlot = ,("Slot1NICBoot1","Slot1NICBoot5","Slot2NICBoot1") PS C:\> $connection | Enable-HPEBIOSPCIeSlotNetworkBootOption -EnablePXEBoot $PCIeSlot</dev:code> <dev:remarks> <maml:para>This example enables the specified PCIeSlots on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Enable-HPEBIOSPCIeSlotNetworkBootOption -Connection $connection -EnablePXEBoot Slot2NICBoot4</dev:code> <dev:remarks> <maml:para>This example enables the Slot2NICBoot4 on Gen9 and Gen10 servers with a list of BIOS connection object 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Enable-HPEBIOSPCIeSlotNetworkBootOption -Connection $connection -EnablePXEBoot ("Slot1NICBoot1","Slot2NICBoot3"),("Slot1NICBoot2","Slot2NICBoot1","Slot3NICBoot1")</dev:code> <dev:remarks> <maml:para>This example enables the specified PCIeSlots on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSPCIeSlotNetworkBootOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEBIOSPCIeSlotNetworkBootOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSACPI_SLIT</command:name> <maml:description> <maml:para>The Get-HPEBIOSACPI_SLIT cmdlet gets BIOS ACPI SLIT Preferences information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSACPI_SLIT</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSACPI_SLIT cmdlets gets the BIOS ACPI SLIT preference information as follows:</maml:para> <maml:para>· SystemLocalityInformationTable - Gets the current System Locality Information Table preference setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSACPI_SLIT</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSACPI_SLIT | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK SystemLocalityInformationTable : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSACPI_SLIT -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK SystemLocalityInformationTable : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSACPI_SLIT -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK SystemLocalityInformationTable : Disabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK SystemLocalityInformationTable : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSACPI_SLIT</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdminInfo</command:name> <maml:description> <maml:para>The Get-HPEBIOSAdminInfo cmdlet gets reference information for the server administrator.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSAdminInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSAdminInfo cmdlet gets the following contact information for the server administrator:</maml:para> <maml:para>· AdminName - Gets the server administrator’s name.</maml:para> <maml:para>· AdminPhoneNumber - Gets the server administrator’s phone number.</maml:para> <maml:para>· AdminOtherInfo - Gets additional information related to the server administrator.</maml:para> <maml:para>· AdminEmailAddress - Gets the server administrator’s email address.</maml:para> <maml:para></maml:para> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSAdminInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSAdminInfo | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK AdminName : HPE Admin AdminPhoneNumber : 9999999999 AdminOtherInfo : HPE Gen9 server AdminEmailAddress : xyz@hpe.com</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSAdminInfo -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK AdminName : HPE Admin AdminPhoneNumber : 9988800000 AdminOtherInfo : HPE Gen10 server AdminEmailAddress : xyz@hpe.com</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSAdminInfo -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK AdminName : HPE Admin AdminPhoneNumber : 9999999999 AdminOtherInfo : HPE Gen9 server AdminEmailAddress : xyz@hpe.com IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK AdminName : HPE Admin AdminPhoneNumber : 9988800000 AdminOtherInfo : HPE Gen10 server AdminEmailAddress : xyz@hpe.com</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSAdminInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdvancedDebugOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSAdvancedDebugOption cmdlet gets the BIOS advanced debug option.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSAdvancedDebugOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSAdvancedDebugOption cmdlet gets the BIOS advanced debug option as follows:</maml:para> <maml:para>. AdvancedCrashDumpMode (only available on Gen10 servers) - Gets current status of advanced crash dump mode.</maml:para> <maml:para>. PostBootProgress (only available on Gen10 servers) - Gets current status of Verbose boot progress.</maml:para> <maml:para>. UEFISerialDebugMessageLevel (only available on Gen10 servers) - Gets current status of UEFI Serial Debug Message Level.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSAdvancedDebugOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSAdvancedDebugOption | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK AdvancedCrashDumpMode : Disabled PostBootProgress : Disabled UEFISerialDebugMessageLevel : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSAdvancedDebugOption -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK AdvancedCrashDumpMode : Disabled PostBootProgress : Disabled UEFISerialDebugMessageLevel : Disabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK AdvancedCrashDumpMode : Enabled PostBootProgress : All UEFISerialDebugMessageLevel : ErrorsOnly</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSAdvancedDebugOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdvancedMemoryProtection</command:name> <maml:description> <maml:para>The Get-HPEBIOSAdvancedMemoryProtection cmdlet gets the advanced memory protection configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSAdvancedMemoryProtection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSAdvancedMemoryProtection cmdlet gets the advanced memory protection configuration as follows:</maml:para> <maml:para>· AdvancedMemoryProtection (available on Gen10 with Intel processors and Gen9 servers) - Gets the current advanced memory protection beyond ECC (error checking and correcting) setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSAdvancedMemoryProtection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSAdvancedMemoryProtection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK AdvancedMemoryProtection : MirroredMemoryAdvancedECCSupport</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSAdvancedMemoryProtection -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK AdvancedMemoryProtection : FastFaultTolerantA3DCSupport</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSAdvancedMemoryProtection -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK AdvancedMemoryProtection : MirroredMemoryAdvancedECCSupport IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK AdvancedMemoryProtection : FastFaultTolerantA3DCSupport</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSAdvancedMemoryProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdvancedPCIConfiguration</command:name> <maml:description> <maml:para>The Get-HPEBIOSAdvancedPCIConfiguration cmdlet gets the advanced PCI configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSAdvancedPCIConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSAdvancedPCIConfiguration cmdlet gets the advanced PCI configuration as follows:</maml:para> <maml:para>· PCIeDeviceIsolationSupport (only available on Gen10 servers with Intel processors) - Gets the current status of PCIe device isolation support.</maml:para> <maml:para>· PCIeSlotToProcessorMapping (only available on Gen10 servers with Intel processors) - Gets the current status of PCIe to Processor mapping configuration.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSAdvancedPCIConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSAdvancedPCIConfiguration | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK PCIeDeviceIsolationSupport : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSAdvancedPCIConfiguration -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK PCIeDeviceIsolationSupport : Enabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK PCIeSlotToProcessorMapping : X4GPUConfiguration</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSPCIDeviceConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdvancedPerformanceTuningOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSAdvancedPerformanceTuningOption cmdlet gets the BIOS advanced performance tuning options.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSAdvancedPerformanceTuningOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSAdvancedPerformanceTuningOption cmdlet obtains the current settings of advanced performance tuning features as follows:</maml:para> <maml:para>· IntelPerformanceMonitoringSupport (available on Gen10 with Intel processor and Gen9 servers) - Gets current status of Intel Performance Monitoring Toolkit support to certain chipset devices.</maml:para> <maml:para>· IONonPostedPrefetching (available on Gen10 with Intel processor and Gen9 servers) - Gets current status of I/O non-posted pre-fetch function.</maml:para> <maml:para>· NUMAGroupSizeOptimization (available on Gen10 and Gen9 servers) - Gets current status of logical processors in a NUMA (Non-Uniform Memory Access) node.</maml:para> <maml:para>· EnergyEfficientTurbo (only available on Gen10 servers with Intel processors) - Gets current status of energy efficiency based policy setting.</maml:para> <maml:para>· LocalRemoteThreshold (only available on Gen10 servers with Intel processors) - Gets current status of local or remote threshold setting.</maml:para> <maml:para>· ProcessorJitterControl (only available on Gen10 servers with Intel processors) - Gets current status of processor jitter control setting to manage processor frequency.</maml:para> <maml:para>· ProcessorJitterControlFrequency (only available on Gen10 servers with Intel processors) - Gets current status of processor jitter control frequency setting.</maml:para> <maml:para>· ProcessorJitterControlOptimization (only available on Gen10 servers with Intel processors) - Gets current status of processor jitter control optimization setting.</maml:para> <maml:para>· SubNUMAClustering (only available on Gen10 servers with Intel processors) - Gets current status of Sub-NUMA clustering option.</maml:para> <maml:para>· UncoreFrequencyScaling (only available on Gen10 servers with Intel processors) - Gets current status of frequency scaling processor's internal busses.</maml:para> <maml:para>· LLCDeadLineAllocation (only available on Gen10 servers with Intel processors) - Gets current status of deadlines allocation in LLC (Last Level Cache).</maml:para> <maml:para>· StaleAtoS (only available on Gen10 servers with Intel processors) - Gets current status of stale A to S directory optimization settings.</maml:para> <maml:para>· CoreBoosting (only available on Gen10 servers with Intel processors) - Gets current status of Core Boosting technology settings.</maml:para> <maml:para>· HPCOptimizationMode (only available on Gen8 servers with AMD processors) - Gets current status of high-performance computing environment.</maml:para> <maml:para>· CStateEfficiencyMode (only available on Gen10 servers with AMD processors) - Gets the current state of C-State Efficiency Mode.</maml:para> <maml:para>· DataFabricCStateEnable (only available on Gen10 servers with AMD processors) - Gets the current status of Data Fabric C-State.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSAdvancedPerformanceTuningOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSAdvancedPerformanceTuningOption | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK IntelPerformanceMonitoringSupport : Enabled IONonPostedPrefetching : Enabled NUMAGroupSizeOptimization : Clustered</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSAdvancedPerformanceTuningOption | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK NUMAGroupSizeOptimization : Flat</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 AMD server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSAdvancedPerformanceTuningOption -Connection $connection | fl IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK NUMAGroupSizeOptimization : Flat EnergyEfficientTurbo : Enabled IONonPostedPrefetching : Enabled IntelPerformanceMonitoringSupport : Disabled LLCDeadLineAllocation : Enabled LocalRemoteThreshold : Auto ProcessorJitterControl : Disabled ProcessorJitterControlFrequency : 0 ProcessorJitterControlOptimization : ZeroLatency StaleAtoS : Disabled SubNUMAClustering : Disabled UncoreFrequencyScaling : Auto</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSAdvancedPerformanceTuningOption -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK IntelPerformanceMonitoringSupport : Disabled IONonPostedPrefetching : Disabled NUMAGroupSizeOptimization : Flat IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK NUMAGroupSizeOptimization : Flat DataFabricCStateEnable : Auto CStateEfficiencyMode : Enabled IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK CoreBoosting : Disabled NUMAGroupSizeOptimization : Clustered EnergyEfficientTurbo : Disabled IONonPostedPrefetching : Enabled IntelPerformanceMonitoringSupport : Enabled LLCDeadLineAllocation : Enabled LocalRemoteThreshold : Auto ProcessorJitterControl : Auto-tuned ProcessorJitterControlFrequency : 100 ProcessorJitterControlOptimization : OptimizedForThroughput StaleAtoS : Enabled SubNUMAClustering : Disabled UncoreFrequencyScaling : Auto</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, Gen10 AMD, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSAdvancedPerformanceTuningOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdvancedSecurityOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSAdvancedSecurityOption cmdlet gets the BIOS advanced security configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSAdvancedSecurityOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSAdvancedSecurityOption cmdlet gets the BIOS advanced security configuration. as follows:</maml:para> <maml:para>· TPM_FIPSModeSwitch (only available on Gen10 servers) - Gets the status of the TPM mode switch.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSAdvancedSecurityOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSAdvancedSecurityOption | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK TPM_FIPSModeSwitch : RegularMode</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSAdvancedSecurityOption -Connection $connection | fl IP : 10.20.30.1 Hostname : abc.domain.com Status : OK TPM_FIPSModeSwitch : NoAction IP : 10.20.30.2 Hostname : abc.domain.com Status : OK TPM_FIPSModeSwitch : FIPSMode</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 server with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSAdvancedSecurityOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdvancedSystemROMOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSAdvancedSystemROMOption cmdlet gets BIOS advanced system ROM options.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSAdvancedSystemROMOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSAdvancedSystemROMOption cmdlet gets BIOS advanced system ROM options as follows:</maml:para> <maml:para>· ConsistentDeviceNaming - On supported operating systems, controls how NIC ports are named based on their locations in the system.</maml:para> <maml:para>· HighPrecisionEventTimerACPISupport (only available on Gen10 servers) - Specifies the high precision event timer (HPET) table and device object in ACPI.</maml:para> <maml:para>· MixedPowerSupplyReporting (available on Gen9 and Gen10 servers) - Identifies whether the server logs messages when a mixed-supply configuration is present.</maml:para> <maml:para>· NMIDebugButton (available on Gen9 servers) - Specifies whether the debug functionality is enabled or disabled.</maml:para> <maml:para>· PCIBusPaddingOption (available on Gen8 and Gen9 servers) - Specifies whether the default PCI bus setting where each expansion slot is provided an extra PCI bus number is enabled or disabled. By default, the system ROM will pad one PCI bus per bridge to not affect current bus numbering schemes.</maml:para> <maml:para>· ROMSelection - Toggles the server ROM between the current ROM and the backup ROM. This option is supported only on servers with redundant ROMs.</maml:para> <maml:para>· VirtualInstallDisk - Controls the Virtual Install Disk. The Virtual Install Disk may contain drivers specific to this server that an OS may use during installation.</maml:para> <maml:para>· LogUEFIDebugMessage (only available on Gen10 servers) - Controls the debug message logging into memory.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSAdvancedSystemROMOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSAdvancedSystemROMOption | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ROMSelection : UseCurrentROM ConsistentDeviceNaming : Disabled VirtualInstallDisk : Enabled MixedPowerSupplyReporting : Enabled NMIDebugButton : Enabled PCIBusPaddingOption : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSAdvancedSystemROMOption -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK ROMSelection : UseCurrentROM ConsistentDeviceNaming : CDNSupportForLOMsAndSlots VirtualInstallDisk : Enabled MixedPowerSupplyReporting : Enabled HighPrecisionEventTimerACPISupport : Enabled LogUEFIDebugMessage : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSAdvancedSystemROMOption -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ROMSelection : SwitchToBackupROM ConsistentDeviceNaming : Disabled VirtualInstallDisk : Disabled MixedPowerSupplyReporting : Enabled NMIDebugButton : Enabled PCIBusPaddingOption : Enabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK ROMSelection : SwitchToBackupROM ConsistentDeviceNaming : CDNSupportForLOMsOnly VirtualInstallDisk : Disabled MixedPowerSupplyReporting : Disabled HighPrecisionEventTimerACPISupport : Disabled LogUEFIDebugMessage : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 server with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSAdvancedSystemROMOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSBootBrowserConfiguration</command:name> <maml:description> <maml:para>The Get-HPEBIOSBootBrowserConfiguration cmdlet gets the BIOS boot browser settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSBootBrowserConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSBootBrowserConfiguration cmdlet gets the BIOS boot browser settings as follows:</maml:para> <maml:para>· BootBrowserSelection (only available on Gen10 with Intel processor servers) - Get the current settings of boot browser selection.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSBootBrowserConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSBootBrowserConfiguration | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK BootBrowserSelection : Text</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSBootBrowserConfiguration -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK BootBrowserSelection : Auto IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK BootBrowserSelection : GUI</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSBootBrowserConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSBootMode</command:name> <maml:description> <maml:para>The Get-HPEBIOSBootMode cmdlet gets the BIOS Boot Mode configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSBootMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSBootMode cmdlet gets the boot mode configuration as follows:</maml:para> <maml:para>· BootMode - Gets the current boot mode for the system that support UEFI Boot Mode.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSBootMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSBootMode | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK BootMode : UEFIMode</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSBootMode -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK BootMode : LegacyBIOSMode</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSBootMode -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK BootMode : UEFIMode IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK BootMode : LegacyBIOSMode</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSBootMode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSBootOrderPolicy</command:name> <maml:description> <maml:para>The Get-HPEBIOSBootOrderPolicy cmdlet gets the BIOS UEFI Boot Order Policy.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSBootOrderPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSBootOrderPolicy cmdlet gets the BIOS UEFI Boot Order Policy as follows:</maml:para> <maml:para>· BootOrderPolicy (available on Gen9 and Gen10 servers) - Gets the current Boot Order Policy setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSBootOrderPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSBootOrderPolicy | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK BootOrderPolicy : AttemptOnce</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSBootOrderPolicy -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK BootOrderPolicy : RetryIndefinitely</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSBootOrderPolicy -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK BootOrderPolicy : AttemptOnce IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK BootOrderPolicy : ResetAfterFailed</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSBootOrderPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSBootTimeMemoryOptimization</command:name> <maml:description> <maml:para>The Get-HPEBIOSBootTimeMemoryOptimization cmdlet gets the BIOS boot time memory optimization settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSBootTimeMemoryOptimization</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSBootTimeMemoryOptimization cmdlet gets the BIOS boot time memory optimization options as follows:</maml:para> <maml:para>· ExtendedMemoryTest - Gets the current memory validation setting during the memory initialization process.</maml:para> <maml:para>· MemoryFastTraining (available on Gen10 with Intel processors and Gen9 servers) - Gets the current full memory training settings on server reboots.</maml:para> <maml:para>· MemoryClearOnWarmReset (only available on Gen10 servers with Intel processors) - Gets the current memory clear setting on warm reset.</maml:para> <maml:para>· PostDiscoveryMode (only available on Gen10 servers) - Gets the current UEFI post discovery mode settings on system reboots.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSBootTimeMemoryOptimization</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSBootTimeMemoryOptimization | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK ExtendedMemoryTest : Disabled MemoryFastTraining : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSBootTimeMemoryOptimization | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ExtendedMemoryTest : Disabled PostDiscoveryMode : Auto</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 AMD server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSBootTimeMemoryOptimization -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK ExtendedMemoryTest : Enabled MemoryFastTraining : Enabled MemoryClearOnWarmReset : Enabled PostDiscoveryMode : ForceFullDiscovery</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with connection object 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-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSBootTimeMemoryOptimization -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK ExtendedMemoryTest : Disabled MemoryFastTraining : Enabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ExtendedMemoryTest : Enabled PostDiscoveryMode : ForceFastDiscovery IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK ExtendedMemoryTest : Disabled MemoryFastTraining : Disabled MemoryClearOnWarmReset : Disabled PostDiscoveryMode : Auto</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, Gen10 AMD and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSBootTimeMemoryOptimization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSCmdletInfo</command:name> <maml:description> <maml:para>The Get-HPEBIOSCmdletInfo gets the list of cmdlets which are supported on the target server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSCmdletInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSCmdletInfo gets the list of cmdlets that are supported on the target server as follows:</maml:para> <maml:para>· CmdletInfo - Gets the collection of supported cmdlet name along with parameter and its value.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSCmdletInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , 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 (ByValue)" position="0" aliases="conn , 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>HPE.BIOS.Connection[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>· The parameter value will be empty if the parameter accepts integer or string value. · Due to design complexity, the parameter value for Get/Set-HPEBIOSPCIDeviceConfiguration cmdlets 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>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $result = $connection | Get-HPEBIOSCmdletInfo PS C:\> $result | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK CmdletInfo : {[Get-HPEBIOSAdminInfo, System.Collections.Generic.Dictionary`2[System.String,System.Object]], [Set-HPEBIOSAdminInfo, System.Collections.Generic.Dictionary`2[System.String,System.Object]], [Get-HPEBIOSAdvancedMemoryProtection, System.Collections.Generic.Dictionary`2[System.String,System.Object]], [Set-HPEBIOSAdvancedMemoryProtection, System.Collections.Generic.Dictionary`2[System.String,System.Object]]...} PS C:\> $result.CmdletInfo['Set-HPEBIOSAdvancedSystemROMOption'] | fl Key : Connection Value : {} Key : ROMSelection Value : {UseCurrentROM, SwitchToBackupROM} Key : ConsistentDeviceNaming Value : {CDNSupportForLOMsOnly, Disabled} Key : VirtualInstallDisk Value : {Enabled, Disabled} Key : MixedPowerSupplyReporting Value : {Enabled, Disabled} Key : NMIDebugButton Value : {Enabled, Disabled} Key : PCIBusPaddingOption Value : {Enabled, Disabled} PS C:\> $result.CmdletInfo['Get-HPEBIOSAdvancedSystemROMOption'] | fl Key : Connection Value : {} Key : OutputType Value : {PSObject, RawText}</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> $result = Get-HPEBIOSCmdletInfo -Connection $connection PS C:\> $result | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK CmdletInfo : {[Get-HPEBIOSAdminInfo, System.Collections.Generic.Dictionary`2[System.String,System.Object]], [Set-HPEBIOSAdminInfo, System.Collections.Generic.Dictionary`2[System.String,System.Object]], [Get-HPEBIOSAdvancedMemoryProtection, System.Collections.Generic.Dictionary`2[System.String,System.Object]], [Set-HPEBIOSAdvancedMemoryProtection, System.Collections.Generic.Dictionary`2[System.String,System.Object]]...} IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK CmdletInfo : {[Get-HPEBIOSAdminInfo, System.Collections.Generic.Dictionary`2[System.String,System.Object]], [Set-HPEBIOSAdminInfo, System.Collections.Generic.Dictionary`2[System.String,System.Object]], [Get-HPEBIOSAdvancedMemoryProtection, System.Collections.Generic.Dictionary`2[System.String,System.Object]], [Set-HPEBIOSAdvancedMemoryProtection, System.Collections.Generic.Dictionary`2[System.String,System.Object]]...} IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK CmdletInfo : {[Get-HPEBIOSAdminInfo, System.Collections.Generic.Dictionary`2[System.String,System.Object]], [Set-HPEBIOSAdminInfo, System.Collections.Generic.Dictionary`2[System.String,System.Object]], [Get-HPEBIOSAdvancedMemoryProtection, System.Collections.Generic.Dictionary`2[System.String,System.Object]], [Set-HPEBIOSAdvancedMemoryProtection, System.Collections.Generic.Dictionary`2[System.String,System.Object]]...}</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen8, Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSCurrentSecureBootState</command:name> <maml:description> <maml:para>The Get-HPEBIOSCurrentSecureBootState gets the current state of BIOS secure boot.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSCurrentSecureBootState</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSCurrentSecureBootState gets the current state of BIOS secure boot as follows:</maml:para> <maml:para>· CurrentSecureBootState - Gets the current state of secure boot setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSCurrentSecureBootState</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSCurrentSecureBootState | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK CurrentSecureBootState : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSCurrentSecureBootState -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK CurrentSecureBootState : Enabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK CurrentSecureBootState : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSCustomPostMessage</command:name> <maml:description> <maml:para>The Get-HPEBIOSCustomPostMessage cmdlet gets the BIOS custom post message.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSCustomPostMessage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSCustomPostMessage cmdlet gets the BIOS custom post message as follows:</maml:para> <maml:para>· CustomPostMessage - Gets the current custom post message.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSCustomPostMessage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSCustomPostMessage | fl IP : 10.20.30.2 Hostname : abc2.domain.local Status : OK CustomPostMessage : Custom Post Message For Gen9</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSCustomPostMessage -Connection $con10 | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK CustomPostMessage : Custom Post Message For Gen10</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSCustomPostMessage -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK CustomPostMessage : Custom Post Message For Gen9 IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK CustomPostMessage : Custom Post Message For Gen10</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSCustomPostMessage</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSDateTimeOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSDateTimeOption cmdlet obtains the BIOS date and time settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSDateTimeOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSDateTimeOption cmdlet gets the BIOS date and time settings.</maml:para> <maml:para>· DaylightSavingTime - Gets the current daylight-saving time (DST) setting.</maml:para> <maml:para>· TimeFormat - Gets the current time format setting.</maml:para> <maml:para>· TimeZone - Gets the current time zone setting.</maml:para> <maml:para>· HourFormat (available on Gen10 Plus AMD processor servers only) - Gets the current hour format setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSDateTimeOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSDateTimeOption IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK DaylightSavingTime : Enabled TimeFormat : UTC TimeZone : UTCP530</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSDateTimeOption -Connection $connection IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK DaylightSavingTime : Disabled TimeFormat : Local TimeZone : Unspecified</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSDateTimeOption -Connection $connection IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK DaylightSavingTime : Enabled TimeFormat : UTC TimeZone : UTCM12 IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK DaylightSavingTime : Disabled TimeFormat : Local TimeZone : Unspecified HourFormat : 12Hours</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSDateTimeOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSEmbeddedDiagnostic</command:name> <maml:description> <maml:para>The Get-HPEBIOSEmbeddedDiagnostic cmdlet obtains the embedded diagnostics settings for the BIOS.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSEmbeddedDiagnostic</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSEmbeddedDiagnostic cmdlet obtains the embedded diagnostics settings and the mode in which the diagnostic information is viewed. Enabling the embedded diagnostics option allows the user to launch the diagnostics screen and view system health and other information.</maml:para> <maml:para>· EmbeddedDiagnostic (available on Gen9 and Gen10 servers) - Gets the current status of embedded diagnostics setting.</maml:para> <maml:para>· EmbeddedDiagnosticMode (available on Gen10 with Intel processors and Gen9 servers) - Gets the current status of embedded diagnostics mode.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSEmbeddedDiagnostic</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSEmbeddedDiagnostic | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK EmbeddedDiagnostic : Enabled EmbeddedDiagnosticMode : Auto</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSEmbeddedDiagnostic | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EmbeddedDiagnostic : Enabled EmbeddedDiagnosticMode : TextConsole</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 AMD server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSEmbeddedDiagnostic -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK EmbeddedDiagnostic : Enabled EmbeddedDiagnosticMode : TextConsole</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with connection object 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSEmbeddedDiagnostic -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK EmbeddedDiagnostic : Disabled EmbeddedDiagnosticMode : Auto IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EmbeddedDiagnostic : Enabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK EmbeddedDiagnostic : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, Gen10 AMD, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSEmbeddedDiagnostic</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSEmbeddedLOMPort</command:name> <maml:description> <maml:para>The Get-HPEBIOSEmbeddedLOMPort cmdlet obtains the network boot status for the installed Network Interface Card (NIC).</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSEmbeddedLOMPort</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSEmbeddedLOMPort cmdlet gets the network boot status for all the installed Network Interface Cards.</maml:para> <maml:para>· EnableNetworkBoot - Gets the list of enabled NIC slots for network boot.</maml:para> <maml:para>· DisableNetworkBoot - Gets the list of disabled NIC slots for network boot.</maml:para> <maml:para>NOTE: NICBoot listed under StatusInfo->AffectedAttribute are not installed/available on the target server when StatusInfo->Category=PropertySupportability.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSEmbeddedLOMPort</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.PSObject[].</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>· You may need to configure the NIC firmware to activate the boot option.</maml:para> <maml:para>· Gen8 and Gen10 support NICBoot1 to NICBoot12, and Gen9 supports NICBoot1 to NICBoot16.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSEmbeddedLOMPort | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EnableNetworkBoot : {NICBoot3, NICBoot5, NICBoot7, NICBoot9} DisableNetworkBoot : {NICBoot1, NICBoot2, NICBoot4, NICBoot6, NICBoot8, NICBoot10, NICBoot11, NICBoot12, NICBoot13, NICBoot14, NICBoot15, NICBoot16}</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSEmbeddedLOMPort -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK EnableNetworkBoot : {NICBoot2, NICBoot4, NICBoot6, NICBoot9} DisableNetworkBoot : {NICBoot1, NICBoot3, NICBoot5, NICBoot7, NICBoot8, NICBoot10, NICBoot11, NICBoot12}</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSEmbeddedLOMPort -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EnableNetworkBoot : {NICBoot3, NICBoot5, NICBoot7, NICBoot9} DisableNetworkBoot : {NICBoot1, NICBoot2, NICBoot4, NICBoot6, NICBoot8, NICBoot10, NICBoot11, NICBoot12, NICBoot13, NICBoot14, NICBoot15, NICBoot16} IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK EnableNetworkBoot : {NICBoot2, NICBoot4, NICBoot6, NICBoot9} DisableNetworkBoot : {NICBoot1, NICBoot3, NICBoot5, NICBoot7, NICBoot8, NICBoot10, NICBoot11, NICBoot12}</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEBIOSEmbeddedLOMPort</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEBIOSEmbeddedLOMPort</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSEmbeddedUEFIShell</command:name> <maml:description> <maml:para>The Get-HPEBIOSEmbeddedUEFIShell cmdlet gets BIOS embedded UEFI shell information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSEmbeddedUEFIShell</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Embedded UEFI Shell is a pre-boot command line environment for scripting and running UEFI applications, including UEFI boot loaders. This feature is supported only in UEFI Boot Mode.</maml:para> <maml:para>· EmbeddedUEFIShell - Specifies whether embedded UEFI option is enabled or disabled.</maml:para> <maml:para>· AddEmbeddedUEFIShellToBootOrder - Specifies whether embedded UEFI is added as an entry into the UEFI Boot Order list.</maml:para> <maml:para>· UEFIShellScriptAutoStart - Specifies whether automatic execution of the Embedded UEFI Shell startup script is enabled or disabled during shell startup.</maml:para> <maml:para>· ShellAutoStartScriptLocation - Gets the location of the Embedded UEFI Shell startup script.</maml:para> <maml:para>· NetworkLocationForShellAutoStartScript - Gets the network URL location of the Embedded UEFI Shell startup script.</maml:para> <maml:para>· UEFIShellScriptVerification (only available on Gen10 servers) - Gets the embedded UEFI shell script verification setting.</maml:para> <maml:para>· UEFIShellStartupURLFromDHCP (only available on Gen10 servers) - Gets the UEFI shell startup script URL using DHCP.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSEmbeddedUEFIShell</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSEmbeddedUEFIShell | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK EmbeddedUEFIShell : Enabled AddEmbeddedUEFIShellToBootOrder : Disabled UEFIShellScriptAutoStart : Disabled ShellAutoStartScriptLocation : Auto NetworkLocationForShellAutoStartScript : ftp://remotehost/ShellScript.nsh</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSEmbeddedUEFIShell | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EmbeddedUEFIShell : Enabled AddEmbeddedUEFIShellToBootOrder : Enabled UEFIShellScriptAutoStart : Enabled ShellAutoStartScriptLocation : FileSystemOnAttachedMedia NetworkLocationForShellAutoStartScript : ftp://remotehost/ShellScript.nsh UEFIShellScriptVerification : Enabled UEFIShellStartupURLFromDHCP : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSEmbeddedUEFIShell -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK EmbeddedUEFIShell : Enabled AddEmbeddedUEFIShellToBootOrder : Disabled UEFIShellScriptAutoStart : Disabled ShellAutoStartScriptLocation : Auto NetworkLocationForShellAutoStartScript : ftp://remotehost/ShellScript.nsh IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EmbeddedUEFIShell : Enabled AddEmbeddedUEFIShellToBootOrder : Enabled UEFIShellScriptAutoStart : Enabled ShellAutoStartScriptLocation : FileSystemOnAttachedMedia NetworkLocationForShellAutoStartScript : ftp://remotehost/ShellScript.nsh UEFIShellScriptVerification : Enabled UEFIShellStartupURLFromDHCP : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSEmbeddedUEFIShell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSEmbeddedUserPartition</command:name> <maml:description> <maml:para>The Get-HPEBIOSEmbeddedUserPartition cmdlet gets the Embedded User Partition settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSEmbeddedUserPartition</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSEmbeddedUserPartition cmdlet gets the Embedded User Partition status. The Embedded User Partition is a general purpose 1 GB disk partition on non-volatile flash memory that is embedded on the system board.</maml:para> <maml:para>· EmbeddedUserPartition (only available on Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSEmbeddedUserPartition</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSEmbeddedUserPartition | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK EmbeddedUserPartition : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSEmbeddedUserPartition -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK EmbeddedUserPartition : Enabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EmbeddedUserPartition : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSEmbeddedUserPartition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSEMSConsole</command:name> <maml:description> <maml:para>The Get-HPEBIOSEMSConsole cmdlet gets the EMS console configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSEMSConsole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSEMSConsole cmdlet gets the EMS console configuration as follows:</maml:para> <maml:para>· EMSConsole - Gets the current EMS console setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSEMSConsole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSEMSConsole | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EMSConsole : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSEMSConsole -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK EMSConsole : PhysicalSerialPort</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSEMSConsole -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EMSConsole : Disabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK EMSConsole : VirtualSerialPort</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSEMSConsole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSFanOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSFanOption cmdlet gets the BIOS system fan installation and policy configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSFanOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSFanOption cmdlet gets the BIOS system fan installation and policy configurations.</maml:para> <maml:para>· FanInstallationRequirement - Gets the current configuration of server reaction when all the required fans are not installed.</maml:para> <maml:para>· FanFailurePolicy - Gets the current configuration of server reaction when fan fails.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSFanOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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 | Get-HPEBIOSFanOption | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK FanFailurePolicy : Allow FanInstallationRequirement : EnableMessaging</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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 | Get-HPEBIOSFanOption | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK FanFailurePolicy : Shutdown FanInstallationRequirement : DisableMessaging</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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:\> Get-HPEBIOSFanOption -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK FanFailurePolicy : Allow FanInstallationRequirement : EnableMessaging IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK FanFailurePolicy : Shutdown FanInstallationRequirement : DisableMessaging</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSFanOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSIntelNICDMAChannel</command:name> <maml:description> <maml:para>The Get-HPEBIOSIntelNICDMAChannel cmdlet gets the BIOS Intel DMA Channels configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSIntelNICDMAChannel</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSIntelNICDMAChannel cmdlet gets the Intel DMA channel configuration as follows:</maml:para> <maml:para>· IntelNICDMAChannel (available on Gen10 with Intel processors and Gen9 servers) - Gets the current DMA channel settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSIntelNICDMAChannel</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSIntelNICDMAChannel | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK IntelNICDMAChannel : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSIntelNICDMAChannel -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK IntelNICDMAChannel : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSIntelNICDMAChannel -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK IntelNICDMAChannel : Enabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK IntelNICDMAChannel : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSIntelNICDMAChannel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSIntelTurboBoost</command:name> <maml:description> <maml:para>The Get-HPEBIOSIntelTurboBoost cmdlet gets BIOS Intel Turbo Boost information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSIntelTurboBoost</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSIntelTurboBoost cmdlet gets Intel Turbo Boost technology information as follows:</maml:para> <maml:para>· IntelTurboBoost (available on Gen10 with Intel processors and Gen9 servers) - Gets the current setting of Intel Turbo Boost technology.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSIntelTurboBoost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSIntelTurboBoost | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK IntelTurboBoost : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSIntelTurboBoost -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK IntelTurboBoost : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSIntelTurboBoost -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK IntelTurboBoost : Disabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK IntelTurboBoost : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSIntelTurboBoost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSInternalSDCardSlot</command:name> <maml:description> <maml:para>The Get-HPEBIOSInternalSDCardSlot cmdlet gets the BIOS internal Secure Digital (SD) card slot configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSInternalSDCardSlot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSInternalSDCardSlot cmdlet gets the current status (enabled/disabled) of the internal SD card slot.</maml:para> <maml:para>· InternalSDCardSlot - Gets the current internal SD card slot settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSInternalSDCardSlot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSInternalSDCardSlot | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK InternalSDCardSlot : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSInternalSDCardSlot | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK InternalSDCardSlot : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSInternalSDCardSlot -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domian.com Status : OK InternalSDCardSlot : Enabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK InternalSDCardSlot : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSInternalSDCardSlot</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSiSCSIBootAttempt</command:name> <maml:description> <maml:para>The Get-HPEBIOSiSCSIBootAttempt cmdlet gets the BIOS iSCSI Boot attempt instance settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSiSCSIBootAttempt</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSiSCSIBootAttempt cmdlet gets the BIOS iSCSI Boot attempt instance settings as follows:</maml:para> <maml:para>· iSCSIBootAttempt (available on Gen9 and Gen10 servers) - Gets the list of current iSCSI attempt and its index.</maml:para> <maml:para>Each iSCSI boot attempt instance contains the following parameters:</maml:para> <maml:para>· StructuredBootString - This is readonly attribute in iSCSI boot attempt instance</maml:para> <maml:para>· UEFIDevicePath - This is readonly attribute in iSCSI boot attempt instance</maml:para> <maml:para>· iSCSIAttemptInstance - Gets an uniquely identity number for iSCSI attempt within iSCSISources array.</maml:para> <maml:para>· iSCSINICSource - Gets the selected NIC source instance.</maml:para> <maml:para>· iSCSIAttemptName - Gets the human readable descriptive name for the iSCSI attempt configuration.</maml:para> <maml:para>· iSCSIConnection - Gets the iSCSI mode for a selected iSCSI attempt.</maml:para> <maml:para>· iSCSIConnectRetry - Gets the number of connection retry for selected iSCSI attempt.</maml:para> <maml:para>· iSCSIConnectTimeout - Gets the iSCSI connection timeout value in milliseconds for selected iSCSI attempt.</maml:para> <maml:para>· iSCSIIPAddressType - Gets the iSCSI IP address type for selected iSCSI attempt.</maml:para> <maml:para>· iSCSIAuthenticationMethod - Gets the iSCSI authentication method for selected iSCSI attempt.</maml:para> <maml:para>· iSCSIInitiatorInfoViaDHCP - Gets the iSCSI initiator DHCP configuration for selected iSCSI attempt.</maml:para> <maml:para>· iSCSIInitiatorIPAddress - Gets the iSCSI initiator IP address for selected iSCSI attempt.</maml:para> <maml:para>· iSCSIInitiatorNetmask - Gets the iSCSI initiator IP subnet mask for selected iSCSI attempt.</maml:para> <maml:para>· iSCSIInitiatorGateway - Gets the iSCSI initiator IP gateway address for selected iSCSI attempt.</maml:para> <maml:para>· iSCSITargetInfoViaDHCP - Gets the iSCSI target DHCP configuration for selected iSCSI attempt.</maml:para> <maml:para>· iSCSITargetName - Gets the iSCSI target name in IQN format for selected iSCSI attempt.</maml:para> <maml:para>· iSCSITargetIPAddress - Gets the iSCSI target IP address for selected iSCSI attempt.</maml:para> <maml:para>· iSCSILogicalUnitNumber - Gets the iSCSI target logical unit number for selected iSCSI attempt.</maml:para> <maml:para>· iSCSITargetTCPPort - Gets the iSCSI target TCP port number for selected iSCSI attempt.</maml:para> <maml:para>· iSCSICHAPType - Gets the iSCSI CHAP authentication type for selected iSCSI attempt.</maml:para> <maml:para>· iSCSICHAPUsername - Gets the iSCSI CHAP authentication user name for selected iSCSI attempt.</maml:para> <maml:para>· iSCSICHAPSecret - Gets the iSCSI CHAP authentication password for selected iSCSI attempt.</maml:para> <maml:para>· iSCSIReverseCHAPUsername - Gets the iSCSI reverse CHAP authentication user name for selected iSCSI attempt.</maml:para> <maml:para>· iSCSIReverseCHAPSecret - Gets the iSCSI reverse CHAP authentication password for selected iSCSI attempt.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSiSCSIBootAttempt</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.PSObject[].</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>· In Gen9 ad Gen10 servers, it can have maximum 4 iSCSI boot attempt instances. · An iSCSIAttemptInstance with zero indicates that the boot attempt is not assigned in the iSCSISources. array.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $iSCSIBootAttempts= $connection | Get-HPEBIOSiSCSIBootAttempt PS C:\> $iSCSIBootAttempts.iSCSIBootAttempt[0].iSCSIAttempt iSCSIConnectRetry : 3 iSCSIInitiatorIPAddress : 0.0.0.0 iSCSITargetName : iSCSIAttemptName : 1 iSCSIInitiatorInfoViaDHCP : Enabled iSCSIInitiatorNetmask : 0.0.0.0 UEFIDevicePath : iSCSIIPAddressType : IPv4 iSCSITargetTCPPort : 3260 iSCSICHAPType : OneWay iSCSIConnectTimeout : 20000 iSCSITargetInfoViaDHCP : Enabled iSCSINICSource : NICBoot2 iSCSILogicalUnitNumber : 0 iSCSIInitiatorGateway : 0.0.0.0 iSCSIAttemptInstance : 1 iSCSICHAPUsername : iSCSIReverseCHAPSecret : iSCSIAuthenticationMethod : None iSCSIConnection : Disabled iSCSIReverseCHAPUsername : iSCSITargetIPAddress : 0.0.0.0 StructuredBootString : iSCSICHAPSecret :</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $iSCSIBootAttempts = Get-HPEBIOSiSCSIBootAttempt -Connection $connection PS C:\> $iSCSIBootAttempts[0].iSCSIBootAttempt[0].iSCSIAttempt iSCSIConnectRetry : 3 iSCSIInitiatorIPAddress : 0.0.0.0 iSCSITargetName : iSCSIAttemptName : 1 iSCSIInitiatorInfoViaDHCP : Enabled iSCSIInitiatorNetmask : 0.0.0.0 UEFIDevicePath : iSCSIIPAddressType : IPv4 iSCSITargetTCPPort : 3260 iSCSICHAPType : OneWay iSCSIConnectTimeout : 20000 iSCSITargetInfoViaDHCP : Enabled iSCSINICSource : NICBoot2 iSCSILogicalUnitNumber : 0 iSCSIInitiatorGateway : 0.0.0.0 iSCSIAttemptInstance : 1 iSCSICHAPUsername : iSCSIReverseCHAPSecret : iSCSIAuthenticationMethod : None iSCSIConnection : Disabled iSCSIReverseCHAPUsername : iSCSITargetIPAddress : 0.0.0.0 StructuredBootString : iSCSICHAPSecret : PS C:\> $iSCSIBootAttempts[1].iSCSIBootAttempt[0].iSCSIAttempt iSCSIAttemptInstance : 1 iSCSIConnectRetry : 3 iSCSIInitiatorIPAddress : 0.0.0.0 iSCSITargetName : iSCSIReverseCHAPUsername : iSCSIInitiatorInfoViaDHCP : Enabled iSCSIInitiatorNetmask : 0.0.0.0 UEFIDevicePath : iSCSITargetTCPPort : 3260 iSCSICHAPType : OneWay iSCSIConnectTimeout : 20000 iSCSITargetInfoViaDHCP : Enabled iSCSINICSource : NICBoot1 iSCSIIPAddressType : IPv4 iSCSICHAPUsername : iSCSIConnection : Disabled iSCSIAuthenticationMethod : None iSCSIInitiatorGateway : 0.0.0.0 iSCSILogicalUnitNumber : 0 iSCSIReverseCHAPSecret : iSCSITargetIPAddress : 0.0.0.0 iSCSIAttemptName : 1 StructuredBootString : iSCSICHAPSecret :</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEBIOSiSCSIBootAttempt</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Edit-HPEBIOSiSCSIBootAttempt</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-HPEBIOSiSCSIBootAttempt</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSiSCSIInitiatorName</command:name> <maml:description> <maml:para>The Get-HPEBIOSiSCSIInitiatorName cmdlet gets a unique iSCSI Qualified Name (IQN) of the BIOS iSCSI initiator.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSiSCSIInitiatorName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSiSCSIInitiatorName cmdlet gets a unique iSCSI Qualified Name (IQN) of the BIOS iSCSI initiator as follows:</maml:para> <maml:para>· iSCSIInitiatorName - Gets the current iSCSI initiator name.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSiSCSIInitiatorName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.PSObject[].</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSiSCSIInitiatorName | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK iSCSIInitiatorName : iqn.1986-03.com.abc:uefi-XXX-ASD232XXXX</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9/Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSiSCSIInitiatorName -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK iSCSIInitiatorName : iqn.1986-03.com.abc:uefi-XXX-ASD232XXXX IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK iSCSIInitiatorName : iqn.1986-03.com.abc:uefi-XXX-MXX54XXXXX</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSiSCSIInitiatorName</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSiSCSINICSource</command:name> <maml:description> <maml:para>The Get-HPEBIOSiSCSINICSource cmdlet gets the list of BIOS iSCSI NIC source.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSiSCSINICSource</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSiSCSINICSource cmdlet gets the list of BIOS iSCSI NIC source as follows:</maml:para> <maml:para>· iSCSINICSourceList - Gets the current iSCSI NIC source available list.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSiSCSINICSource</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $iSCSINICSource = $connection | Get-HPEBIOSiSCSINICSource PS C:\> $iSCSINICSource.iSCSINICSourceList NICBoot1 NICBoot2 NICBoot3 NICBoot4 NICBoot5 NICBoot6</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9/Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $iSCSINICSource = Get-HPEBIOSiSCSINICSource -Connection $connection PS C:\> $iSCSINICSource[0].iSCSINICSourceList NICBoot1 NICBoot2 NICBoot3 NICBoot4 NICBoot5 NICBoot6 PS C:\> $iSCSINICSource[1].iSCSINICSourceList NICBoot1 NICBoot2</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSLogConfig</command:name> <maml:description> <maml:para>The Get-HPEBIOSLogConfig gets the log configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSLogConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get-HPEBIOSLogConfig cmdlet when executed, will get the log configuration details such as the LogLevel, MaxFileSize and MaxSizeRollBackups. The default value for LogLevel, MaxFileSize and MaxSizeRollBackups is “DEBUG”, 10MB and 5. Logging must be enabled before using this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSLogConfig</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:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> Get-HPEBIOSLogConfig | fl LogLevel : DEBUG MaxFileSize : 10MB MaxSizeRollBackups : 5</dev:code> <dev:remarks> <maml:para>This cmdlets shows the output of Get-HPEBIOSLogConfig with default values.</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-HPEBIOSMaxThreadLimit</command:name> <maml:description> <maml:para>The Set-HPEBIOSMaxThreadLimit cmdlet gets the maximum thread limit of HPEBIOSCmdlets module for the current PowerShell session.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSMaxThreadLimit</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSMaxThreadLimit cmdlet gets the maximum thread limit of HPEBIOSCmdlets module for the current PowerShell session.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSMaxThreadLimit</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.Int32</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-HPEBIOSMaxThreadLimit 256</dev:code> <dev:remarks> <maml:para>This example shows the output of maximum thread limit for the current PowerShell session.</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-HPEBIOSMaxThreadLimit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSMemoryConfiguration</command:name> <maml:description> <maml:para>The Get-HPEBIOSMemoryConfiguration cmdlet gets the BIOS memory configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSMemoryConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSMemoryConfiguration cmdlet gets the BIOS memory configurations as follows:</maml:para> <maml:para>· MemoryPatrolScrubbing (only available on Gen10 servers) - Gets the current memory patrol scrubbing settings for memory error correction.</maml:para> <maml:para>· MemoryRefreshRate (only available on Gen10 servers) - Gets the current refresh rate settings of memory controller.</maml:para> <maml:para>· MemoryMirroringMode (only available on Gen10 servers with Intel processors) - Gets the current memory allocation for mirroring mode.</maml:para> <maml:para>· MemoryRemap (only available on Gen10 servers with Intel processors) - Gets the current configuration of memory remap settings for previously disabled from the system due to failure event.</maml:para> <maml:para>· OpportunisticSelfRefresh (only available on Gen10 servers with Intel processors) - Gets the current self-refresh mode during periods of low memory utilization.</maml:para> <maml:para>· SecureMemoryEncryption (only available on Gen10 servers with AMD processors) - Gets the current secure memory encryption settings.</maml:para> <maml:para>· PeriodicDirectoryRinse (only available on Gen10 Plus servers with AMD processors) - Gets the periodic directory rinse setting.</maml:para> <maml:para>· PatrolScrubDuration (only available on Gen10 Plus servers with AMD processors) - Gets the duration interval of when to run the patrol scrubber if patrol scrub is enabled.</maml:para> <maml:para>· NUMAMemoryDomainsPerSocket (only available on Gen10 Plus servers with AMD processor) - Gets the number of NUMA memory domains per socket.</maml:para> <maml:para>· TransparentSecureMemoryEncryption (only available on Gen10 Plus servers with AMD processor) - Gets the Transparent Secure Memory encryption setting.</maml:para> <maml:para>· LastLevelCacheAsNUMANode (only available on Gen10 Plus servers with AMD processor) - Gets the LLC as NUMA node settings.</maml:para> <maml:para>· MemoryInterleavingMode (only available on Gen10 Plus servers with AMD processor) - Gets the memory interleaving mode settings.</maml:para> <maml:para>· MemoryIntervalSize (only available on Gen10 Plus servers with AMD processor) - Gets the size of the memory interleave.</maml:para> <maml:para>· MemoryPStates (only available on Gen10 Plus servers with AMD processor) - Gets the memory pstate configuration.</maml:para> <maml:para>· CMCI (only available on Gen10 Plus servers with AMD processor) - Gets the CMCI settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSMemoryConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSMemoryConfiguration | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK MemoryPatrolScrubbing : Enabled MemoryRefreshRate : Refreshx1 SecureMemoryEncryption : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 AMD server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSMemoryConfiguration | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK MemoryPatrolScrubbing : Disabled MemoryRefreshRate : Refreshx2 MemoryMirroringMode : PartialMirrorOSConfigured MemoryRemap : AllMemory OpportunisticSelfRefresh : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSMemoryConfiguration -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK MemoryPatrolScrubbing : Enabled MemoryRefreshRate : Refreshx1 SecureMemoryEncryption : Disabled PeriodicDirectoryRinse : Enabled PatrolScrubDuration : 24 NUMAMemoryDomainsPerSocket : Auto TransparentSecureMemoryEncryption : Disabled LastLevelCacheAsNUMANode : Disabled MemoryInterleavingMode : Enabled MemoryIntervalSize : 256 MemoryPStates : Auto CMCI : Disabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK MemoryPatrolScrubbing : Enabled MemoryRefreshRate : Refreshx1 MemoryMirroringMode : Partial10PercentAbove4GB MemoryRemap : NoAction OpportunisticSelfRefresh : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 AMD and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSMemoryConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSMemoryPower</command:name> <maml:description> <maml:para>The Get-HPEBIOSMemoryPower cmdlet gets the current settings of memory related power management.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSMemoryPower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSMemoryPower cmdlet gets the current settings of memory related power management as follows:</maml:para> <maml:para>· MaximumMemoryBusFrequency - Gets the current setting of memory bus frequency.</maml:para> <maml:para>· ChannelInterleaving (Gen10 with Intel processors and Gen9 servers) - Gets the current status of channel interleaving.</maml:para> <maml:para></maml:para> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSMemoryPower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSMemoryPower | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK MaximumMemoryBusFrequency : 1333 ChannelInterleaving : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSMemoryPower -Connection $connection | fl IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK MaximumMemoryBusFrequency : 2133</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 AMD server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.5 -Username admin -Password admin123 PS C:\> Get-HPEBIOSMemoryPower -Connection $connection | fl IP : 10.20.30.5 Hostname : abc5.domain.com Status : OK MaximumMemoryBusFrequency : 2667 ChannelInterleaving : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3,10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSMemoryPower -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK MaximumMemoryBusFrequency : 1333 ChannelInterleaving : Disabled IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK MaximumMemoryBusFrequency : Auto IP : 10.20.30.5 Hostname : abc5.domain.com Status : OK MaximumMemoryBusFrequency : 1867 ChannelInterleaving : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, Gen10 AMD, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSMemoryPower</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSMemoryProximityReportingForIO</command:name> <maml:description> <maml:para>The Get-HPEBIOSMemoryProximityReportingForIO cmdlet gets BIOS Memory Proximity Reporting for I/O information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSMemoryProximityReportingForIO</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSMemoryProximityReportingForIO cmdlet gets BIOS Memory Proximity Reporting for I/O information as follows:</maml:para> <maml:para>· MemoryProximityReportingForIO - Gets the current setting of the proximity relationship between I/O devices and system memory to the operating system.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSMemoryProximityReportingForIO</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSMemoryProximityReportingForIO | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK MemoryProximityReportingForIO : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSMemoryProximityReportingForIO -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK MemoryProximityReportingForIO : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSMemoryProximityReportingForIO -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK MemoryProximityReportingForIO : Disabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK MemoryProximityReportingForIO : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSMemoryProximityReportingForIO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSModuleVersion</command:name> <maml:description> <maml:para>The Get-HPEBIOSModuleVersion cmdlet gets the module details of the installed HPEBIOSCmdlets module.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSModuleVersion</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSModuleVersion cmdlet gets the module details of the installed HPEBIOSCmdlets module. The details include product name, path, description, GUID, product version, download URL, Dot Net version, OS version and supported UI cultures with respective version.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSModuleVersion</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.Management.Automation.PSObject[]</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-HPEBIOSModuleVersion Name : HPEBIOSCmdlets Path : C:\Program Files (x86)\Hewlett Packard Enterprise\PowerShell\Modules\HPEBIOSCmdlets\HPEBIOSCmdlets.dll Description : Scripting Tools for Windows PowerShell : BIOS Cmdlets creates an interface to HPE BIOS ROM-Based Setup Utility (RBSU) or UEFI System Utilities. These cmdlets can be used to configure the BIOS settings on HPE ProLiant servers. GUID : b37fea1c-1be5-42a6-bbc9-a453018b2a0f CurrentUICultureName : en-US CurrentUICultureVersion : 2.2.0.0 CurrentModuleVersion : 2.2.0.0 LatestAvailableModuleVersion : 2.1.0.1 ProductModuleDownloadURL : https://www.hpe.com/servers/powershell PowerShellGalleryModuleDownloadURL : www.powershellgallery.com/packages/HPEBIOSCmdlets/2.1.0.1 DotNetVersion : 4.7.1 DotNetFrameworkDescription : 4.7.02558 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.4.0.0 AvailableUICulture : {@{UICultureName=en-US; UICultureVersion=2.2.0.0}, @{UICultureName=zh-CN; UICultureVersion=2.2.0.0}, @{UICultureName=ja-JP; UICultureVersion=2.2.0.0}} Status : OK StatusInfo :</dev:code> <dev:remarks> <maml:para>This example shows the output of Get-HPEBIOSModuleVersion 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-HPEBIOSModuleVersion</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSNetworkBootOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSNetworkBootOption cmdlet gets the BIOS network boot and pre-boot network settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSNetworkBootOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSNetworkBootOption cmdlet gets the BIOS network boot and pre-boot network settings as follows:</maml:para> <maml:para>· PrebootNetworkEnvironmentPolicy - Gets the current status of UEFI network boot targets policy.</maml:para> <maml:para>· IPv6DHCPUniqueIdentifier - Gets the current status of DHCP Unique identifier (DUID) for IPv6 PXE boot.</maml:para> <maml:para>· NetworkBootRetrySupport - Gets the current status of network boot retry function.</maml:para> <maml:para>· NetworkBootRetryCount (only available on Gen10 servers) - Gets the number of times the system BIOS attempts to boot a network device.</maml:para> <maml:para>· HTTPSupport (only available on Gen10 servers) - Gets the current status of HTTP support for UEFI boot order list.</maml:para> <maml:para>· iSCSIBootPolicy (only available on Gen10 with Intel processor servers) - Gets the current status of iSCSI policy to access the iSCSI targets.</maml:para> <maml:para>· PrebootNetworkInterface - Gets the network interface used for pre-boot network connections.</maml:para> <maml:para>· PrebootNetworkProxy (only available on Gen10 servers) - Gets the pre-boot network proxy settings.</maml:para> <maml:para>· DHCPv4 - Gets the current status of DHCP server pre-boot network IPv4 configuration.</maml:para> <maml:para>· IPv4Address - Gets the static IPv4 address.</maml:para> <maml:para>· IPv4SubnetMask - Gets the static IPv4 subnet mask.</maml:para> <maml:para>· IPv4Gateway - Gets the static IPv4 gateway.</maml:para> <maml:para>· IPv4PrimaryDNS - Gets the IPv4 primary DNS.</maml:para> <maml:para>· IPv4SecondaryDNS - Gets the IPv4 secondary DNS.</maml:para> <maml:para>· IPv6ConfigPolicy (only available on Gen10 servers) - Gets the current status of pre-boot network IPv6 configuration.</maml:para> <maml:para>· IPv6Address (only available on Gen10 servers) - Gets the static IPv6 address.</maml:para> <maml:para>· IPv6Gateway (only available on Gen10 servers) - Gets the static IPv6 gateway.</maml:para> <maml:para>· IPv6PrimaryDNS (only available on Gen10 servers) - Gets the IPv6 primary DNS.</maml:para> <maml:para>· IPv6SecondaryDNS (only available on Gen10 servers) - Gets the IPv6 secondary DNS.</maml:para> <maml:para>· BootFromURL (only available on Gen9 servers) - Gets the network boot URL to a bootable ISO or EFI file.</maml:para> <maml:para>· BootFromURL1 (only available on Gen10 servers) - Gets the network boot URL 1 to a bootable ISO or EFI file.</maml:para> <maml:para>· BootFromURL2 (only available on Gen10 servers) - Gets the network boot URL 2 to a bootable ISO or EFI file.</maml:para> <maml:para>· BootFromURL3 (only available on Gen10 servers) - Gets the network boot URL 3 to a bootable ISO or EFI file.</maml:para> <maml:para>· BootFromURL4 (only available on Gen10 servers) - Gets the network boot URL 4 to a bootable ISO or EFI file.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSNetworkBootOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSNetworkBootOption | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK PrebootNetworkEnvironmentPolicy : IPv4 IPv6DHCPUniqueIdentifer : Auto NetworkBootRetrySupport : Enabled PrebootNetworkInterface : Auto DHCPv4 : Enabled IPv4Address : 192.168.20.10 IPv4SubnetMask : 255.255.255.0 IPv4Gateway : 192.168.20.1 IPv4PrimaryDNS : 10.20.30.40 IPv4SecondaryDNS : 10.20.30.41 BootFromURL : ftp://10.20.30.42/file/image.iso</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSNetworkBootOption | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK PrebootNetworkEnvironmentPolicy : Auto IPv6DHCPUniqueIdentifer : Auto NetworkBootRetrySupport : Enabled NetworkBootRetryCount : 20 HTTPSupport : Auto PrebootNetworkInterface : Auto PrebootNetworkProxy : DHCPv4 : Enabled IPv4Address : 0.0.0.0 IPv4SubnetMask : 0.0.0.0 IPv4Gateway : 0.0.0.0 IPv4PrimaryDNS : 0.0.0.0 IPv4SecondaryDNS : 0.0.0.0 IPv6ConfigPolicy : Automatic IPv6Address : :: IPv6Gateway : :: IPv6PrimaryDNS : :: IPv6SecondaryDNS : :: BootFromURL1 : BootFromURL2 : BootFromURL3 : BootFromURL4 :</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 AMD server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSNetworkBootOption | fl IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK PrebootNetworkEnvironmentPolicy : IPv6 IPv6DHCPUniqueIdentifer : DUID-LLT NetworkBootRetrySupport : Enabled NetworkBootRetryCount : 2 HTTPSupport : Auto iSCSIBootPolicy : SoftwareInitiator PrebootNetworkInterface : Auto PrebootNetworkProxy : http://[FE80::FE15:FFFF:FE00:0000]:1234 DHCPv4 : Enabled IPv4Address : 192.168.20.10 IPv4SubnetMask : 255.255.255.0 IPv4Gateway : 192.168.20.1 IPv4PrimaryDNS : 10.20.30.50 IPv4SecondaryDNS : 10.20.30.51 IPv6ConfigPolicy : Manual IPv6Address : FE80::FE15:00FF:FE97:2D00 IPv6Gateway : FE80::FE15:00FF:FE97:0000 IPv6PrimaryDNS : FE80::FE15:00FF:FE97:2000 IPv6SecondaryDNS : FE80::FE15:00FF:FE97:2001 BootFromURL1 : http://192.168.0.1/file/image.iso BootFromURL2 : http://example.com/file/image.efi BootFromURL3 : http://[1234::1000]/image.iso BootFromURL4 : https://example.com/file/image.efi</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3,10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSNetworkBootOption -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK PrebootNetworkEnvironmentPolicy : IPv4 IPv6DHCPUniqueIdentifer : DUID-LLT NetworkBootRetrySupport : Disabled PrebootNetworkInterface : EmbeddedFlexLOM1 DHCPv4 : Disabled IPv4Address : 192.168.20.10 IPv4SubnetMask : 255.255.255.0 IPv4Gateway : 192.168.20.1 IPv4PrimaryDNS : 10.20.30.40 IPv4SecondaryDNS : 10.20.30.41 BootFromURL : http://example.com/file/image.efi IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK PrebootNetworkEnvironmentPolicy : Auto IPv6DHCPUniqueIdentifer : Auto NetworkBootRetrySupport : Enabled NetworkBootRetryCount : 20 HTTPSupport : Auto PrebootNetworkInterface : Auto PrebootNetworkProxy : DHCPv4 : Enabled IPv4Address : 0.0.0.0 IPv4SubnetMask : 0.0.0.0 IPv4Gateway : 0.0.0.0 IPv4PrimaryDNS : 0.0.0.0 IPv4SecondaryDNS : 0.0.0.0 IPv6ConfigPolicy : Automatic IPv6Address : :: IPv6Gateway : :: IPv6PrimaryDNS : :: IPv6SecondaryDNS : :: BootFromURL1 : BootFromURL2 : BootFromURL3 : BootFromURL4 : IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK PrebootNetworkEnvironmentPolicy : IPv6 IPv6DHCPUniqueIdentifer : DUID-LLT NetworkBootRetrySupport : Enabled NetworkBootRetryCount : 2 HTTPSupport : Auto iSCSIBootPolicy : SoftwareInitiator PrebootNetworkInterface : Auto PrebootNetworkProxy : http://[FE80::FE15:FFFF:FE00:0000]:1234 DHCPv4 : Enabled IPv4Address : 192.168.20.10 IPv4SubnetMask : 255.255.255.0 IPv4Gateway : 192.168.20.1 IPv4PrimaryDNS : 10.20.30.50 IPv4SecondaryDNS : 10.20.30.51 IPv6ConfigPolicy : Manual IPv6Address : FE80::FE15:00FF:FE97:2D00 IPv6Gateway : FE80::FE15:00FF:FE97:0000 IPv6PrimaryDNS : FE80::FE15:00FF:FE97:2000 IPv6SecondaryDNS : FE80::FE15:00FF:FE97:2001 BootFromURL1 : http://192.168.0.1/file/image.iso BootFromURL2 : http://example.com/file/image.efi BootFromURL3 : http://[1234::1000]/image.iso BootFromURL4 : https://example.com/file/image.efi</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, Gen10 AMD, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSNetworkBootOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSNodeInterleaving</command:name> <maml:description> <maml:para>The Get-HPEBIOSNodeInterleaving cmdlet gets BIOS Node Interleaving configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSNodeInterleaving</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSNodeInterleaving cmdlet gets BIOS Node Interleaving configuration as follows:</maml:para> <maml:para>· NodeInterleaving - Gets the current Node Interleaving setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSNodeInterleaving</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSNodeInterleaving | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK NodeInterleaving : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSNodeInterleaving -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK NodeInterleaving : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSNodeInterleaving -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK NodeInterleaving : Disabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK NodeInterleaving : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSNodeInterleaving</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSNVDIMMConfiguration</command:name> <maml:description> <maml:para>The Get-HPEBIOSNVDIMMConfiguration cmdlet gets the BIOS NVDIMM configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSNVDIMMConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSNVDIMMConfiguration cmdlet gets the BIOS NVDIMM configuration as follows:</maml:para> <maml:para>· NVDIMMFunctionality (available on Gen10 with Intel processor and Gen9 servers) - Gets the current state of the NVDIMM support.</maml:para> <maml:para>· NVDIMMMemoryInterleaving (available on Gen10 with Intel processor and Gen9 servers) - Gets the current state of the NVDIMM interleaving.</maml:para> <maml:para>· NVDIMMSanitizePolicy (available on Gen10 with Intel processor and Gen9 servers) - Gets the current state of the NVDIMM sanitize/erase on next reboot policy.</maml:para> <maml:para>· NVDIMMIntegrityChecking (only available on Gen9 servers) - Gets the current state of the NVDIMM integrity data checking when rebooted.</maml:para> <maml:para>· NVDIMMForcedRecovery (only available on Gen9 servers) - Gets the current state of the NVDIMM forced recovery.</maml:para> <maml:para>· NVDIMMOSLabelSupport (only available on Gen10 with Intel processor servers) - Gets the current state of the NVDIMM OS label support.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSNVDIMMConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSNVDIMMConfiguration | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK NVDIMMFunctionality : Enabled NVDIMMMemoryInterleaving : Enabled NVDIMMSanitizePolicy : SanitizeAndRebootSystem NVDIMMIntegrityChecking : Enabled NVDIMMForcedRecovery : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSNVDIMMConfiguration | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK NVDIMMFunctionality : Enabled NVDIMMMemoryInterleaving : Disabled NVDIMMSanitizePolicy : SanitizeToFactoryDefaults NVDIMMOSLabelSupport : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSNVDIMMConfiguration -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK NVDIMMFunctionality : Enabled NVDIMMMemoryInterleaving : Disabled NVDIMMSanitizePolicy : Disabled NVDIMMIntegrityChecking : Disabled NVDIMMForcedRecovery : Disabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK NVDIMMFunctionality : Disabled NVDIMMMemoryInterleaving : Enabled NVDIMMSanitizePolicy : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSNVDIMMConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSNVDIMMErase</command:name> <maml:description> <maml:para>The Get-HPEBIOSNVDIMMErase cmdlet gets the BIOS NVDIMM-N sanitize/erase status.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSNVDIMMErase</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSNVDIMMErase cmdlet gets the BIOS NVDIMM-N sanitize/erase status as follows.</maml:para> <maml:para>. EnableNVDIMMErase (available on Gen10 with Intel processor and Gen9 servers) - List down all the NVDIMM-N and related processors for which NVDIMM erase is enabled.</maml:para> <maml:para>. DisableNVDIMMErase (available on Gen10 with Intel processor and Gen9 servers) - List down all the NVDIMM-N and related processors for which NVDIMM erase is disabled.</maml:para> <maml:para>NOTE: NVDIMM-N listed under StatusInfo->AffectedAttribute are not installed/available on the target server when StatusInfo->Category=PropertySupportability.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSNVDIMMErase</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSNVDIMMErase | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=PropertySupportability; Message=Property(s) listed in AffectedAttribute are not supported on the target server ProLiant DL380 Gen9. For more details about feature supportability, see the cmdlet help or HPE ROM user guide.; AffectedAttribute=System.Collections.Generic.List`1[System.String]} EnableNVDIMMErase : {} DisableNVDIMMErase : {AllNVDIMM, AllProcessor1NVDIMM, Processor1NVDIMM9}</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 or Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSNVDIMMErase -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=PropertySupportability; Message=Property(s) listed in AffectedAttribute are not supported on the target server ProLiant DL380 Gen9. For more details about feature supportability, see the cmdlet help or HPE ROM user guide.; AffectedAttribute=System.Collections.Generic.List`1[System.String]} EnableNVDIMMErase : {} DisableNVDIMMErase : {AllNVDIMM, AllProcessor1NVDIMM, Processor1NVDIMM9} IP : 10.20.30.2 Hostname : abc2.domain.com Status : Warning StatusInfo : @{Category=PropertySupportability; Message=Property(s) listed in AffectedAttribute are not supported on the target server ProLiant DL380 Gen9. For more details about feature supportability, see the cmdlet help or HPE ROM user guide.; AffectedAttribute=System.Collections.Generic.List`1[System.String]} EnableNVDIMMErase : {AllProcessor2NVDIMM, AllProcessor3NVDIMM, Processor1NVDIMM9}} DisableNVDIMMErase : {AllNVDIMM, AllProcessor1NVDIMM}</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEBIOSNVDIMMErase</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEBIOSNVDIMMErase</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPCIDeviceConfiguration</command:name> <maml:description> <maml:para>The Get-HPEBIOSPCIDeviceConfiguration cmdlet gets BIOS PCI device configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSPCIDeviceConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSPCIDeviceConfiguration cmdlet gets the BIOS PCI device configuration as follows:</maml:para> <maml:para>· PCIDevice (only available on Gen10 servers) - List all of the available PCI device configurations on the target server.</maml:para> <maml:para>Each PCIDevice element has following properties:</maml:para> <maml:para>. Name - Name of the PCI Device.</maml:para> <maml:para>. Status - Status of PCI device: enabled or disabled.</maml:para> <maml:para>. Type - Type of PCI device: EmbeddedNIC, EmbeddedSAS, EmbeddedSATA, or PCISlot.</maml:para> <maml:para>. PCIeLinkSpeed - PCIe link speed of PCI device.</maml:para> <maml:para>. PCIePowerManagement - PCIe link power management support of the PCI device.</maml:para> <maml:para>. PCIeOptionROM - Option ROM of the PCI device.</maml:para> <maml:para>. Bifurcation - Bifurcate the selected PCIe slot.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSPCIDeviceConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $pciDeviceConfiguration = $connection | Get-HPEBIOSPCIDeviceConfiguration PS C:\> $pciDeviceConfiguration | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=PropertySupportability; Message=Property(s) listed in AffectedAttribute are not supported on the target server ProLiant DL380 Gen10. For more details about feature supportability, see the cmdlet help or HPE ROM user guide.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]} PCIDevice : {@{Name=EmbeddedSAS1; Status=Enabled; Type=EmbebdedSAS; PCIeLinkSpeed=Auto; PCIePowerManagement=Disabled; PCIeOptionROM=Enabled}, @{Name=EmbeddedNIC; Status=Enabled; Type=EmbeddedNIC; PCIeLinkSpeed=PCIeGeneration1; PCIeOptionROM=Enabled}, @{Name=EmbeddedSATA1; Status=Enabled; Type=EmbeddedSATA; PCIeOptionROM=Enabled}, @{Name=EmbeddedSATA2; Status=Enabled; Type=EmbeddedSATA; PCIeOptionROM=Enabled}} PS C:\> $pciDeviceConfiguration.PCIDevice | fl Name : EmbeddedSAS1 Status : Enabled Type : EmbebdedSAS PCIeLinkSpeed : Auto PCIePowerManagement : Disabled PCIeOptionROM : Enabled Name : EmbeddedNIC Status : Enabled Type : EmbeddedNIC PCIeLinkSpeed : PCIeGeneration1 PCIeOptionROM : Enabled Name : EmbeddedSATA1 Status : Enabled Type : EmbeddedSATA PCIeOptionROM : Enabled Name : EmbeddedSATA2 Status : Enabled Type : EmbeddedSATA PCIeOptionROM : Enabled Name : PCISlot6 Status : Enabled Type : PCI PCIeLinkSpeed : Auto PCIePowerManagement : Disabled PCIeOptionROM : Enabled Bifurcation : Auto Name : PCISlot7 Status : Enabled Type : PCI PCIeLinkSpeed : Auto PCIePowerManagement : Disabled PCIeOptionROM : Enabled Bifurcation : Auto</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS 10.20.30.1,10.20.30.2 admin admin123 -DisableCertificateAuthentication PS C:\> $pciDeviceConfiguration = Get-HPEBIOSPCIDeviceConfiguration -Connection $connection PS C:\> $pciDeviceConfiguration | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=PropertySupportability; Message=Property(s) listed in AffectedAttribute are not supported on the target server ProLiant DL380 Gen10. For more details about feature supportability, see the cmdlet help or HPE ROM user guide.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]} PCIDevice : {@{Name=EmbeddedSAS1; Status=Enabled; Type=EmbebdedSAS; PCIeLinkSpeed=Auto; PCIePowerManagement=Disabled; PCIeOptionROM=Enabled}, @{Name=EmbeddedNIC; Status=Enabled; Type=EmbeddedNIC; PCIeLinkSpeed=PCIeGeneration1; PCIeOptionROM=Enabled}, @{Name=EmbeddedSATA1; Status=Enabled; Type=EmbeddedSATA; PCIeOptionROM=Enabled}, @{Name=EmbeddedSATA2; Status=Enabled; Type=EmbeddedSATA; PCIeOptionROM=Enabled}} IP : 10.20.30.2 Hostname : abc2.domain.com Status : Warning StatusInfo : @{Category=PropertySupportability; Message=Property(s) listed in AffectedAttribute are not supported on the target server ProLiant DL180 Gen10. For more details about feature supportability, see the cmdlet help or HPE ROM user guide.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]} PCIDevice : {@{Name=EmbeddedNIC; Status=Enabled; Type=EmbeddedNIC; PCIeLinkSpeed=Auto; PCIePowerManagement=Disabled; PCIeOptionROM=Disabled}, @{Name=EmbeddedSATA1; Status=Enabled; Type=EmbeddedSATA; PCIeOptionROM=Disabled; PCIePowerManagement=Disabled}, @{Name=EmbeddedSATA2; Status=Enabled; Type=EmbeddedSATA; PCIeOptionROM=Disabled; PCIePowerManagement=Disabled}}</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSPCIDeviceConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPCIDeviceOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSPCIDeviceOption cmdlet gets the status of the embedded and add-in PCI devices.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSPCIDeviceOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSPCIDeviceOption cmdlet gets the status (Enabled/Disabled) for the BIOS PCI devices as follows:</maml:para> <maml:para>· EnablePCIDevice (only available on Gen9 servers) - Gets the list of enabled PCI devices in BIOS.</maml:para> <maml:para>· DisablePCIDevice (only available on Gen9 servers) - Gets the list of disabled PCI devices in BIOS.</maml:para> <maml:para>NOTE: PCIDevice listed under StatusInfo->AffectedAttribute are not installed/available on the target server when StatusInfo->Category=PropertySupportability.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSPCIDeviceOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSPCIDeviceOption | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK EnablePCIDevice : {EmbeddedFlexibleLOM1, EmbeddedSATAController1, EmbeddedSATAController2, PCIeSlot6} DisablePCIDevice : {EmbeddedFlexibleLOM2, PCIeSlot1, PCIeSlot2, PCIeSlot3, PCIeSlot4, PCIeSlot5, PCIeSlot7, PCIeSlot8, PCIeSlot9}</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPCIDeviceOption -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK EnablePCIDevice : {EmbeddedFlexibleLOM1, EmbeddedSATAController1, EmbeddedSATAController2, PCIeSlot6} DisablePCIDevice : {EmbeddedFlexibleLOM2, PCIeSlot1, PCIeSlot2, PCIeSlot3, PCIeSlot4, PCIeSlot5, PCIeSlot7, PCIeSlot8, PCIeSlot9} IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EnablePCIDevice : {EmbeddedFlexibleLOM1, EmbeddedSATAController1, PCIeSlot1, PCIeSlot2, PCIeSlot6} DisablePCIDevice : {EmbeddedFlexibleLOM2, EmbeddedSATAController2, PCIeSlot3, PCIeSlot4, PCIeSlot5, PCIeSlot7, PCIeSlot8, PCIeSlot9}</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEBIOSPCIDeviceOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEBIOSPCIDeviceOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPCIePower</command:name> <maml:description> <maml:para>The Get-HPEBIOSPCIePower cmdlet gets the embedded PCI power configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSPCIePower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSPCIePower cmdlet gets the embedded PCI power configuration as follows:</maml:para> <maml:para>· PCIeExpressECRCSupport (only available on Gen9 servers) - Gets the current configuration of PCI End-to-End CRC (ECRC) policy for all installed PCIe devices.</maml:para> <maml:para>· PCIExpressSupport - Gets the current configuration of PCI-express device speed.</maml:para> <maml:para>· PCIeIOAllocation (only available on Gen9 servers) - Gets the current configuration of PCIe I/O resource allocation.</maml:para> <maml:para>· PCIeResourcePadding (only available on Gen10 with Intel processor servers) - Gets the current configuration of PCIe resource support for NVMe drives.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSPCIePower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSPCIePower | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK PCIeExpressECRCSupport : Enabled PCIExpressSupport : MaximumSupported PCIeIOAllocation : Balanced</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPCIePower -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK PCIExpressSupport : PerPortControl PCIeResourcePadding : Normal</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3,10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPCIePower -Connection $connection | fl IP : 10.20.30.3 Hostname : abc4.domain.com Status : OK PCIExpressSupport : PerPortControl PCIeResourcePadding : Medium IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK PCIExpressSupport : PerPortControl PCIeResourcePadding : Medium</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSPCIePower</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPCIeSlotNetworkBootOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSPCIeSlotNetworkBootOption cmdlet gets the UEFI PXE boot status for Network Interface Cards (NIC) installed in PCIe slots.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSPCIeSlotNetworkBootOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSPCIeSlotNetworkBootOption cmdlet gets the UEFI PXE boot status for all NICs installed in PCIe slots as follows:</maml:para> <maml:para>· EnablePXEBoot (available on Gen9 and Gen10 servers) - Gets the list of enabled PCIe slots for network boot.</maml:para> <maml:para>· DisablePXEBoot (available on Gen9 and Gen10 servers) - Gets the list of disabled PCIe slots for network boot.</maml:para> <maml:para>NOTE: PXEBoot listed under StatusInfo->AffectedAttribute are not installed/available on the target server when StatusInfo->Category=PropertySupportability.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSPCIeSlotNetworkBootOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSPCIeSlotNetworkBootOption | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=PropertySupportability; Message=Property(s) listed in AffectedAttribute are not supported on the target server ProLiant DL20 Gen9. For more details about feature supportability, see the cmdlet help or HPE ROM user guide.; AffectedAttribute=System.Collections.Generic.List`1[System.String]} EnablePXEBoot : {Slot1NICBoot1} DisablePXEBoot : {Slot1NICBoot2}</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPCIeSlotNetworkBootOption -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : Warning StatusInfo : @{Category=PropertySupportability; Message=Property(s) listed in AffectedAttribute are not supported on the target server ProLiant DL380 Gen10. For more details about feature supportability, see the cmdlet help or HPE ROM user guide.; AffectedAttribute=System.Collections.Generic.List`1[System.String]} EnablePXEBoot : {Slot1NICBoot1, Slot1NICBoot2} DisablePXEBoot : {Slot1NICBoot3, Slot1NICBoot4}</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPCIeSlotNetworkBootOption -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=PropertySupportability; Message=Property(s) listed in AffectedAttribute are not supported on the target server ProLiant DL20 Gen9. For more details about feature supportability, see the cmdlet help or HPE ROM user guide.; AffectedAttribute=System.Collections.Generic.List`1[System.String]} EnablePXEBoot : {Slot1NICBoot1} DisablePXEBoot : {Slot1NICBoot2} IP : 10.20.30.2 Hostname : abc2.domain.com Status : Warning StatusInfo : @{Category=PropertySupportability; Message=Property(s) listed in AffectedAttribute are not supported on the target server ProLiant DL380 Gen10. For more details about feature supportability, see the cmdlet help or HPE ROM user guide.; AffectedAttribute=System.Collections.Generic.List`1[System.String]} EnablePXEBoot : {Slot1NICBoot1, Slot1NICBoot2} DisablePXEBoot : {Slot1NICBoot3, Slot1NICBoot4}</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-HPEBIOSPCIeSlotNetworkBootOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-HPEBIOSPCIeSlotNetworkBootOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPersistentMemoryConfiguration</command:name> <maml:description> <maml:para>The Get-HPEBIOSPersistentMemoryConfiguration cmdlet gets the persistent memory configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSPersistentMemoryConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSPersistentMemoryConfiguration cmdlet gets the persistent memory configuration as follows:</maml:para> <maml:para>· PersistentMemoryAddressRangeScrub (only available on Gen10 with Intel processor servers) - Gets the NVDIMM memory address range scrub support settings.</maml:para> <maml:para>· PersistentMemoryBackupPowerPolicy (available on Gen10 with Intel processor and Gen9 servers) - Gets the persistent memory backup power policy to control whether the system waits during system boot for batteries to charge.</maml:para> <maml:para>· PersistentMemoryIntegrityCheck (only available on Gen10 with Intel processor servers) - Gets the persistent memory scan settings during system boot to determine data integrity.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSPersistentMemoryConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSPersistentMemoryConfiguration | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK PersistentMemoryBackupPowerPolicy : WaitForBackupPowerOnBoot</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSPersistentMemoryConfiguration | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK PersistentMemoryBackupPowerPolicy : WaitForBackupPowerOnBoot PersistentMemoryIntegrityCheck : Enabled PersistentMemoryAddressRangeScrub : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPersistentMemoryConfiguration -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK PersistentMemoryBackupPowerPolicy : ContinueBootWithoutBackupPower IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK PersistentMemoryBackupPowerPolicy : WaitForBackupPowerOnBoot PersistentMemoryIntegrityCheck : Disabled PersistentMemoryAddressRangeScrub : Disabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK PersistentMemoryBackupPowerPolicy : ContinueBootWithoutBackupPower PersistentMemoryIntegrityCheck : Disabled PersistentMemoryAddressRangeScrub : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSPersistentMemoryConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPowerCapping</command:name> <maml:description> <maml:para>The Get-HPEBIOSPowerCapping cmdlet gets the configuration of BIOS Dynamic Power Capping functionality.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSPowerCapping</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSPowerCapping cmdlet gets the configuration of BIOS Dynamic Power Capping functionality as follows:</maml:para> <maml:para>· DynamicPowerCappingFunctionality - Gets the current setting of BIOS Dynamic Power Capping functionality.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSPowerCapping</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSPowerCapping | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK DynamicPowerCappingFunctionality : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPowerCapping -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK DynamicPowerCappingFunctionality : Auto</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPowerCapping -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK DynamicPowerCappingFunctionality : Disabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK DynamicPowerCappingFunctionality : Auto</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 server with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSPowerCapping</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPowerProfile</command:name> <maml:description> <maml:para>The Get-HPEBIOSPowerProfile cmdlet gets the BIOS Power Profile configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSPowerProfile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSPowerProfile cmdlet gets the BIOS Power Profile configuration as follows:</maml:para> <maml:para>· PowerProfile (available on Gen9 servers) - Gets the current power profile setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSPowerProfile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSPowerProfile | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK PowerProfile : MinimumPowerUsage</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPowerProfile -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK PowerProfile : MaximumPerformance IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK PowerProfile : Custom</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen8 and Gen9 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSPowerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPowerRegulator</command:name> <maml:description> <maml:para>The Get-HPEBIOSPowerRegulator cmdlet gets the BIOS Power Regulator configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSPowerRegulator</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSPowerRegulator cmdlet gets the BIOS Power Regulator configuration as follows:</maml:para> <maml:para>· PowerRegulator (available on Gen10 with Intel processor, Gen9) - Gets the current power regulator setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSPowerRegulator</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSPowerRegulator | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK PowerRegulator : StaticHighPerformanceMode</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPowerRegulator -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK PowerRegulator : DynamicPowerSavingsMode</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPowerRegulator -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK PowerRegulator : DynamicPowerSavingsMode IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK PowerRegulator : OSControlMode</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSPowerRegulator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPreferredIOOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSPreferredIOOption cmdlet gets the Preferred IO option. The cmdlet is supported only on Gen10 Plus AMD servers.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSPreferredIOOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSPreferredIOOption cmdlet gets the IO options configurations as follows:</maml:para> <maml:para>· IOBus- Gets the bus number of the preferred IO device.</maml:para> <maml:para>· IODevice- Gets the device number of the preferred IO device.</maml:para> <maml:para>· IOFunction - Gets the function number of the preferred IO device.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSPreferredIOOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</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" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</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:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSPreferredIOOption | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK IOBus : 4 IODevice : 3 IOFunction : 2</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Plus AMD server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPreferredIOOption -Connection $connection IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK IOBus : 4 IODevice : 3 IOFunction : 2 IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK IOBus : 6 IODevice : 3 IOFunction : 2</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Plus AMD server 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSPreferredIOOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPrefetcher</command:name> <maml:description> <maml:para>The Get-HPEBIOSPrefectcher cmdlet gets the BIOS prefetching configuration of the processor.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSPrefetcher</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSPrefectcher cmdlet gets the BIOS prefetching configuration of the processor as follows:</maml:para> <maml:para>· AdjacentSectorPrefetch (available on Gen10 with Intel processor, Gen8 with Intel processor and Gen9 servers) - Gets the current status of the CPU adjacent sector prefetch configuration to cache line containing the currently requested data.</maml:para> <maml:para>· DCUIPPrefetcher (available on Gen10 with Intel processor, Gen8 with Intel processor and Gen9 servers) - Gets the current status of the DCU (Data Cache Unit) IP prefetch configuration to the L1 data cache.</maml:para> <maml:para>· DCUStreamerPrefetcher (available on Gen10 with Intel processor, Gen8 with Intel processor and Gen9 servers) - Gets the current status of the DCU (Data Cache Unit) streamer prefetch configuration to detect multiple loads from the same line done within a time limit.</maml:para> <maml:para>· HWPrefetcher (available on Gen10 with Intel processor, Gen8 with Intel processor and Gen9 servers) - Gets the current status of the Hw prefetch configuration of the processor.</maml:para> <maml:para>· L1StreamHWPrefetcher (only available on Gen10 with AMD processor servers) - Gets the current status of the L1 Stream HW prefetch.</maml:para> <maml:para>· L2StreamHWPrefetcher (only available on Gen10 with AMD processor servers) - Gets the current status of the L2 Stream HW prefetch.</maml:para> <maml:para>· LLCPrefetcher (only available on Gen10 with Intel processor servers) - Gets the current status of the processor Last Level Cache (LLC) prefetch.</maml:para> <maml:para>· UPIPrefetcher (only available on Gen10 with Intel processor servers) - Gets the current status of the UPI prefetch configuration of the processor.</maml:para> <maml:para>· XPTPrefetcher (only available on Gen10 with Intel processor servers) - Gets the current status of the XPT prefetch configuration of the processor.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSPrefetcher</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSPrefetcher | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK AdjacentSectorPrefetch : Disabled HWPrefetcher : Enabled DCUIPPrefetcher : Enabled DCUStreamerPrefetcher : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPrefetcher -Connection $connection | fl IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK L1StreamHWPrefetcher : Enabled L2StreamHWPrefetcher : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 AMD server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.5 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPrefetcher -Connection $connection | fl IP : 10.20.30.5 Hostname : abc5.domain.com Status : OK AdjacentSectorPrefetch : Enabled HWPrefetcher : Enabled DCUIPPrefetcher : Enabled DCUStreamerPrefetcher : Enabled LLCPrefetcher : Enabled UPIPrefetcher : Enabled XPTPrefetcher : Auto</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 6</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3,10.20.30.4,10.20.30.5 -Username admin -Password admin123 PS C:\> Get-HPEBIOSPrefetcher -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK AdjacentSectorPrefetch : Disabled HWPrefetcher : Enabled DCUIPPrefetcher : Enabled DCUStreamerPrefetcher : Enabled IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK L1StreamHWPrefetcher : Enabled L2StreamHWPrefetcher : Disabled IP : 10.20.30.5 Hostname : abc5.domain.com Status : OK AdjacentSectorPrefetch : Disabled HWPrefetcher : Enabled DCUIPPrefetcher : Enabled DCUStreamerPrefetcher : Enabled LLCPrefetcher : Enabled UPIPrefetcher : Enabled XPTPrefetcher : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, Gen10 AMD and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSPrefetcher</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSProcessorOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSProcessorOption cmdlet gets the BIOS configuration of the processor.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSProcessorOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSProcessorOption cmdlet gets the BIOS configuration of the processor as follows:</maml:para> <maml:para>· AMDCorePerformanceBoost (available on Gen10 with AMD processor servers) - Gets the current configuration of AMD Core Performance Boost.</maml:para> <maml:para>· IntelHyperthreading (available on Gen10 with Intel processor) - Gets the current configuration of Intel HyperThreading.</maml:para> <maml:para>· NoExecuteMemoryProtection (available on Gen8 with Intel processor and Gen9 servers) - Gets the current configuration of No-Execute Memory Protection.</maml:para> <maml:para>· PerformanceDeterminism (only available on Gen10 servers with AMD processors) - Gets the current configuration of performance and power determinism.</maml:para> <maml:para>· ProcessorCoreEnable - Gets the number of cores that will be enabled per processor socket on server.</maml:para> <maml:para>· ProcessorSMT (only available on Gen10 servers with AMD processors) - Gets the current configuration of AMD SMT.</maml:para> <maml:para>· Processorx2APICSupport (available on Gen10 with Intel processor and Gen9 servers) - Gets the current configuration of processor x2APIC (Advanced Programmable Interrupt Controller) support.</maml:para> <maml:para>· SpeculativeLockScheduling (only available on Gen10 servers with AMD processors) - Gets the current configuration of page table entry lock.</maml:para> <maml:para>· DeterminismControl (only available on Gen10 servers with AMD processors)- Gets the current status of the AMD determinism control.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSProcessorOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSProcessorOption -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK IntelHyperthreading : Enabled NoExecuteMemoryProtection : Enabled ProcessorCoreEnable : 10 ProcessorX2ApicSupport : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSProcessorOption -Connection $connection | fl IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK AMDCorePerformanceBoost : Enabled ProcessorCoreEnable : 0 ProcessorSMT : Enabled PerformanceDeterminism : PowerDeterministic SpeculativeLockScheduling : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 AMD server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.5 -Username admin -Password admin123 PS C:\> Get-HPEBIOSProcessorOption -Connection $connection | fl IP : 10.20.30.5 Hostname : abc5.domain.com Status : OK IntelHyperthreading : Enabled ProcessorCoreEnable : 16 ProcessorX2ApicSupport : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with the connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3,10.20.30.4,10.20.30.5 -Username admin -Password admin123 PS C:\> Get-HPEBIOSProcessorOption -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK IntelHyperthreading : Enabled NoExecuteMemoryProtection : Disabled ProcessorCoreEnable : 8 ProcessorX2ApicSupport : Enabled IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK AMDCorePerformanceBoost : Enabled ProcessorCoreEnable : 0 ProcessorSMT : Enabled PerformanceDeterminism : PowerDeterministic SpeculativeLockScheduling : Enabled DeterminismControl : Auto IP : 10.20.30.5 Hostname : abc5.domain.com Status : OK IntelHyperthreading : Enabled ProcessorCoreEnable : 10 ProcessorX2ApicSupport : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen8 AMD, Gen8 Intel, Gen9, Gen10 AMD, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSProcessorOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSProcessorPower</command:name> <maml:description> <maml:para>The Get-HPEBIOSProcessorPower cmdlet gets the processor related power management settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSProcessorPower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSProcessorPower cmdlet gets the BIOS processor-related power management settings as follows:</maml:para> <maml:para>· CollaborativePowerControl (available on Gen10 with Intel processor and Gen9 servers) - Gets the processor frequency changes setting.</maml:para> <maml:para>· DynamicPowerSavingsModeResponse (available on Gen9 servers) - Gets the response time for switching between processor performance and power state, depending on the processor workload.</maml:para> <maml:para>· EnergyPerformanceBias (available on Gen10 with Intel processor, and Gen9 servers) - Gets the processor performance and power usage settings.</maml:para> <maml:para>· IntelDMILinkFrequency (available on Gen10 with Intel processor and Gen9 servers) - Used to reduce the link speed between the processor and south bridge. Reducing the link speed reduces the power consumption.</maml:para> <maml:para>· MinimumProcessorIdlePowerCoreState (available on Gen9 and Gen10 servers) - Obtains the processor idle power (C-State) that the operating system uses.</maml:para> <maml:para>· MinimumProcessorIdlePowerPackageState (available on Gen10 with Intel processor, and Gen9 servers) - Gets the processor idle power state.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSProcessorPower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSProcessorPower -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK CollaborativePowerControl : Enabled DynamicPowerSavingsModeResponse : Fast EnergyPerformanceBias : PowerSavingsMode IntelDMILinkFrequency : Auto MinimumProcessorIdlePowerCoreState : C3State MinimumProcessorIdlePowerPackageState : PackageC3State</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSProcessorPower -Connection $connection | fl IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK MinimumProcessorIdlePowerCoreState : C6State</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 AMD server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.5 -Username admin -Password admin123 PS C:\> Get-HPEBIOSProcessorPower -Connection $connection | fl IP : 10.20.30.5 Hostname : abc5.domain.com Status : OK CollaborativePowerControl : Enabled EnergyPerformanceBias : BalancedPower IntelDMILinkFrequency : GEN1Speed MinimumProcessorIdlePowerCoreState : C6State MinimumProcessorIdlePowerPackageState : PackageC6State</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3,10.20.30.4,10.20.30.5 -Username admin -Password admin123 PS C:\> Get-HPEBIOSProcessorPower -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK CollaborativePowerControl : Enabled DynamicPowerSavingsModeResponse : Fast EnergyPerformanceBias : BalancedPower IntelDMILinkFrequency : GEN1Speed MinimumProcessorIdlePowerCoreState : C6State MinimumProcessorIdlePowerPackageState : PackageC6State IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK MinimumProcessorIdlePowerCoreState : NoCStates IP : 10.20.30.5 Hostname : abc5.domain.com Status : OK CollaborativePowerControl : Enabled EnergyPerformanceBias : BalancedPerformance IntelDMILinkFrequency : GEN2Speed MinimumProcessorIdlePowerCoreState : NoCStates MinimumProcessorIdlePowerPackageState : NoPackageState</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, Gen10 AMD, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSProcessorPower</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSQPI</command:name> <maml:description> <maml:para>The Get-HPEBIOSQPI cmdlet gets the BIOS QPI (QuickPath Interconnect) configuration of the processor.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSQPI</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSQPI cmdlet gets the BIOS QPI (QuickPath Interconnect) configuration of the processor as follows:</maml:para> <maml:para>· QPIBandwidthOptimization (available on Gen9 servers) - Gets the current QPI bandwidth optimization setting.</maml:para> <maml:para>· QPIHomeSnoopOptimization (only available on Gen9 servers) - Gets the current QPI home snoop optimization mode used by the Directory and Opportunistic Snoop Broadcast (OSB).</maml:para> <maml:para>· QPISnoopConfiguration (only available on Gen9 servers) - Gets the current QPI snoop mode used by the processor and QPI bus.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSQPI</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSQPI -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK QPIBandwidthOptimization : OptimizedForIO QPIHomeSnoopOptimization : DirectoryOSBEnabled QPISnoopConfiguration : Standard</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSQPI -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK QPIBandwidthOptimization : Balanced IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK QPIBandwidthOptimization : OptimizedForIO QPIHomeSnoopOptimization : DirectoryOSBDisabled QPISnoopConfiguration : EarlySnoop</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSQPI</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSQPILinkPower</command:name> <maml:description> <maml:para>The Get-HPEBIOSQPILinkPower cmdlet gets the current Intel QPI link power configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSQPILinkPower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSQPILinkPower cmdlet gets the current Intel QPI link power configuration as follows:</maml:para> <maml:para>· IntelQPILinkEnablement (only available on Gen9 servers) - Gets the status of the Intel QPI topology link settings between processors.</maml:para> <maml:para>· IntelQPILinkFrequency (available on Gen9 servers) - Gets the status of the Intel QPI link frequency settings.</maml:para> <maml:para>· IntelQPILinkPowerManagement (available on Gen9 servers) - Gets the status of the Intel QPI link power management settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSQPILinkPower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSQPILinkPower | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK IntelQPILinkEnablement : Auto IntelQPILinkFrequency : MinQPISpeed IntelQPILinkPowerManagement : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSQPILinkPower -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK IntelQPILinkFrequency : MinQPISpeed IntelQPILinkPowerManagement : Disabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK IntelQPILinkEnablement : SingleLink IntelQPILinkFrequency : Auto IntelQPILinkPowerManagement : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSQPILinkPower</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSRedundantPowerSupply</command:name> <maml:description> <maml:para>The Get-HPEBIOSRedundantPowerSupply cmdlet gets the BIOS redundant power supply configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSRedundantPowerSupply</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSRedundantPowerSupply cmdlet gets the BIOS redundant power supply configurations as follows:</maml:para> <maml:para>· RedundantPowerSupplyMode (not available on SL and BL servers) - Gets the redundant power supply mode configuration.</maml:para> <maml:para>· RedundantPowerSupplyLogic (available on Gen10 with Intel processor and Gen9 servers) - Gets the power supply redundancy logic configuration.</maml:para> <maml:para>· PowerSupplyRequirementOverride (only available on Gen9 servers) - Gets the override configuration of system power supply.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSRedundantPowerSupply</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSRedundantPowerSupplyMode | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK RedundantPowerSupplyMode : Auto RedundantPowerSupplyLogic : ConfiguredFor2+2Redundancy</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 or Gen10 Intel server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSRedundantPowerSupplyMode -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK RedundantPowerSupplyMode : HighEfficiencyOddStandby</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 AMD server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3,10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSRedundantPowerSupplyMode -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK RedundantPowerSupplyMode : HighEfficiencyOddStandby PowerSupplyRequirementOverride : ConfiguredFor3-4Redundancy IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK RedundantPowerSupplyMode : Auto IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK RedundantPowerSupplyMode : BalancedMode RedundantPowerSupplyLogic : ConfiguredFor4+0Redundancy</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, Gen10 AMD, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSRedundantPowerSupply</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSRemovableFlashMediaBootSequence</command:name> <maml:description> <maml:para>The Get-HPEBIOSRemovableFlashMediaBootSequence cmdlet gets the BIOS removable flash media boot sequence.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSRemovableFlashMediaBootSequence</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSRemovableFlashMediaBootSequence cmdlet gets the BIOS removable flash media boot sequence as follows:</maml:para> <maml:para>· RemovableFlashMediaBootSequence - Gets the removable flash media boot configuration.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSRemovableFlashMediaBootSequence</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSRemovableFlashMediaBootSequence | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK RemovableFlashMediaBootSequence : InternalSDCardFirst</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSRemovableFlashMediaBootSequence -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK RemovableFlashMediaBootSequence : InternalDriveKeysFirst</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSRemovableFlashMediaBootSequence -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK RemovableFlashMediaBootSequence : InternalDriveKeysFirst IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK RemovableFlashMediaBootSequence : ExternalDriveKeysFirst</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSRemovableFlashMediaBootSequence</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSSATAControllerOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSSATAControllerOption cmdlet gets the BIOS SATA controller configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSSATAControllerOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSSATAControllerOption cmdlet gets the SATA (Serial Advanced Technology Attachment) controller configuration as follows:</maml:para> <maml:para>· EmbeddedSATAConfiguration - Gets the current status of embedded SATA configuration support.</maml:para> <maml:para>· SATASecureErase (available on Gen9 and Gen10 servers) - Gets the current status of SATA secure erase support.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSSATAControllerOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSSATAControllerOption | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EmbeddedSATAConfiguration : EnableSATAAHCISupport SATASecureErase : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSSATAControllerOption -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK EmbeddedSATAConfiguration : EnableDynamicSmartArrayRAIDSupport SATASecureErase : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSSATAControllerOption -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EmbeddedSATAConfiguration : EnableSATAAHCISupport SATASecureErase : Disabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK EmbeddedSATAConfiguration : EnableDynamicSmartArrayRAIDSupport SATASecureErase : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSSATAControllerOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSSecureBootState</command:name> <maml:description> <maml:para>The Get-HPEBIOSSecureBootState cmdlet gets the BIOS Secure Boot configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSSecureBootState</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSSecureBootState cmdlet gets the BIOS Secure Boot configuration as follows:</maml:para> <maml:para>· SecureBootState (available on Gen9 and Gen10 servers) - Gets the current Secure Boot status.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSSecureBootState</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSSecureBootState | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK SecureBootState : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSSecureBootState -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK SecureBootState : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSSecureBootState -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK SecureBootState : Enabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK SecureBootState : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSSecureBootState</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSSerialConsole</command:name> <maml:description> <maml:para>The Get-HPEBIOSSerialConsole cmdlet gets the serial console configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSSerialConsole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSSerialConsole cmdlet gets the serial console configurations as follows:</maml:para> <maml:para>· SerialConsolePort - Gets the current status of the Serial Console Port configuration.</maml:para> <maml:para>· SerialConsoleEmulationMode (available on Gen9 and Gen10 servers) - Gets the current Serial Console Emulation Mode setting.</maml:para> <maml:para>· SerialConsoleBaudRate - Gets the current Serial Console Baud Rate setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSSerialConsole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSSerialConsole | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK SerialConsolePort : COM1 SerialConsoleBaudRate : 19200 SerialConsoleEmulationMode : VT100</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSSerialConsole -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK SerialConsolePort : PhysicalSerialPort SerialConsoleBaudRate : 115200 SerialConsoleEmulationMode : VT-UTF8</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSSerialConsole -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK SerialConsolePort : Disabled SerialConsoleBaudRate : 38400 SerialConsoleEmulationMode : ANSI IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK SerialConsolePort : VirtualSerialPort SerialConsoleBaudRate : 57600 SerialConsoleEmulationMode : VT-UTF8</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSSerialConsole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSSerialPort</command:name> <maml:description> <maml:para>The Get-HPEBIOSSerialPort cmdlet gets the serial port configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSSerialPort</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSSerialPort cmdlet gets the serial port configurations as follows:</maml:para> <maml:para>· EmbeddedSerialPort - Gets the current Embedded Serial Port settings.</maml:para> <maml:para>· VirtualSerialPort - Gets the current Virtual Serial Port settings.</maml:para> <maml:para></maml:para> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSSerialPort</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSSerialPort -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EmbeddedSerialPort : COM2_IRQ3 VirtualSerialPort : COM1_IRQ4</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSSerialPort -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK EmbeddedSerialPort : COM1_IRQ4 VirtualSerialPort : COM2_IRQ3</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSSerialPort | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK EmbeddedSerialPort : COM1_IRQ4 VirtualSerialPort : COM2_IRQ3 IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EmbeddedSerialPort : COM2_IRQ3 VirtualSerialPort : COM1_IRQ4</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS connection objects passed through a pipeline.</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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSSerialPort</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSServerAvailability</command:name> <maml:description> <maml:para>The Get-HPEBIOSServerAvailability cmdlet gets the BIOS Server Availability configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSServerAvailability</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSServerAvailability cmdlet gets the BIOS Server Availability configurations as follows:</maml:para> <maml:para>· ACPIWatchdogTimer (only available on Gen10 servers) - Gets the current status of ACPI watchdog timer.</maml:para> <maml:para>· ASR - Gets the current status of ASR (Automatic Server Recovery).</maml:para> <maml:para>· ASRTimeout - Gets the current setting of ASR Timeout.</maml:para> <maml:para>· WakeOnLAN - Gets the current Wake On LAN setting.</maml:para> <maml:para>· PowerButton - Gets the current status of Power Button mode.</maml:para> <maml:para>· PowerOnDelay - Gets the current setting of Power On Delay.</maml:para> <maml:para>· POSTF1Prompt - Gets the current F1 key prompt configuration.</maml:para> <maml:para>· AutomaticPowerOn - Gets the current Automatic Power On setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSServerAvailability</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSServerAvailability | fl IP : 10.20.30.1 Hostname : abc.domain.com Status : OK ASR : Enabled ASRTimeout : 5Minutes AutomaticPowerOn : AlwaysPowerOn POSTF1Prompt : Delayed PowerButton : Enabled PowerOnDelay : NoDelay WakeOnLAN : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSServerAvailability -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ACPIWatchdogTimer : Enabled ASR : Disabled ASRTimeout : 15Minutes AutomaticPowerOn : AlwaysPowerOn POSTF1Prompt : Delayed2Sec PowerButton : Enabled PowerOnDelay : Random WakeOnLAN : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSServerAvailability -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ASR : Disabled ASRTimeout : 10Minutes AutomaticPowerOn : RestoreLastPowerState POSTF1Prompt : Enabled PowerButton : Random PowerOnDelay : 15Second WakeOnLAN : Enabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK ACPIWatchdogTimer : Disabled ASR : Enabled ASRTimeout : 30Minutes AutomaticPowerOn : RestoreLastPowerState POSTF1Prompt : Delayed20Sec PowerButton : Disabled PowerOnDelay : 30Second WakeOnLAN : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSServerAvailability</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSServerConfigLockSetting</command:name> <maml:description> <maml:para>The Get-HPEBIOSServerConfigLockSetting cmdlet gets the BIOS Server Configuration Lock settings. It is supported only on Gen10 Plus AMD servers.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSServerConfigLockSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSServerConfigLockSetting cmdlet gets the following Server Configuration lock settings:</maml:para> <maml:para>· LockState - Specifies whether the lock is disabled or enabled.</maml:para> <maml:para>· LockLogStored - Specifies whether the log is stored.</maml:para> <maml:para>· LockChallenge - Specifies whether Server Configuration Lock password challenge on every boot is enabled or disabled.</maml:para> <maml:para>· LockTransport - Specifies whether the lock transport is enabled or disabled.</maml:para> <maml:para>· LockTamperHalt- Specifies whether the Server Configuration Lock behavior to halt on a configuration change detection is enabled or disabled.</maml:para> <maml:para>· LockExcludeDIMMS - Specifies whether the DIMM information from the Digital Fingerprint is excluded.</maml:para> <maml:para>· LockExcludeCPUs - Specifies whether the CPU information from the Digital Fingerprint is excluded.</maml:para> <maml:para>· LockExcludePCISlots - Specifies whether the PCIe slot information from the Digital Fingerprint is excluded.</maml:para> <maml:para>· LockExcludeSecurity - Specifies whether the security configuration information from the Digital Fingerprint is excluded.</maml:para> <maml:para>· LockExcludeFirmwareRevisions - Specifies whether system firmware revisions from the Digital Fingerprint is excluded.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSServerConfigLockSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</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" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</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.Management.Automation.PSObject[] or System.String[]</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSServerConfigLockSetting IP : 10.20.30.1 Hostname : abc.com Status : OK LockState : Enabled LockLogStored : No LockChallenge : Enabled LockTransport : Disabled LockTamperHalt : Disabled LockExcludeDIMMS : Disabled LockExcludeCPUs : Enabled LockExcludeFirmwareRevisions : Enabled LockExcludePCISlots : Disabled LockExcludeSecurity : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Plus server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSServerConfigLockSetting -Connection $connection | fl IP : 10.20.30.1 Hostname : abc.com Status : OK LockState : LockLogStored : No LockChallenge : LockTransport : LockTamperHalt : LockExcludeDIMMS : LockExcludeCPUs : LockExcludeFirmwareRevisions : LockExcludePCISlots : LockExcludeSecurity : IP : 10.20.30.2 Hostname : abc2.com Status : OK LockState : Enabled LockLogStored : No LockChallenge : Enabled LockTransport : Disabled LockTamperHalt : Disabled LockExcludeDIMMS : Disabled LockExcludeCPUs : Enabled LockExcludeFirmwareRevisions : Enabled LockExcludePCISlots : Disabled LockExcludeSecurity : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 Plus servers with a list of BIOS connection objects passed as named parameter and Server Configuration Lock not set on one of the 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSServerInfo</command:name> <maml:description> <maml:para>The Get-HPEBIOSServerInfo cmdlet gets the server administrator information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSServerInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSServerInfo cmdlet gets the server administrator information as follows:</maml:para> <maml:para>· AssetTagProtection (available on Gen9 and Gen10 servers) - Gets the asset tag information whether locked or unlocked.</maml:para> <maml:para>· PowerOnLogo (available on Gen9 and Gen10 servers) - Specifies whether the logo will be displayed during system boot.</maml:para> <maml:para>· ServerName - Gets the server name.</maml:para> <maml:para>· ServerAssetTag - Gets the server asset number.</maml:para> <maml:para>· ServerOtherInfo - Gets the additional text describing the server.</maml:para> <maml:para>· ServerPrimaryOS - Describes the primary OS of the server.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSServerInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSServerInfo | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK ServerAssetTag : HPE Proliant Server1 ServerName : ABC-WINDOWS-01 ServerOtherInfo : HPE Data Centre 1 ServerPrimaryOS : Windows Server 2008</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen8 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSServerInfo -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ServerAssetTag : HPE Proliant Server2 ServerName : ABC-WINDOWS-02 ServerOtherInfo : HPE Data Centre 2 ServerPrimaryOS : Windows Server 2012 AssetTagProtection : Locked PowerOnLogo : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 or Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSServerInfo -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ServerAssetTag : HPE Proliant Server2 ServerName : ABC-WINDOWS-02 ServerOtherInfo : HPE Data Centre 2 ServerPrimaryOS : Windows Server 2012 AssetTagProtection : Locked PowerOnLogo : Disabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK ServerAssetTag : HPE Proliant Server3 ServerName : ABC-WINDOWS-03 ServerOtherInfo : HPE Data Centre 3 ServerPrimaryOS : Windows Server 2012 R2 AssetTagProtection : Unlocked PowerOnLogo : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSServerInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSServerSecurity</command:name> <maml:description> <maml:para>The Get-HPEBIOSServerSecurity cmdlet gets the BIOS server security configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSServerSecurity</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSServerSecurity cmdlet gets the BIOS server security configuration as follows:</maml:para> <maml:para>· BackupROMImageAuthentication (only available on Gen10 servers) - Gets the current status of cryptographic authentication of the backup ROM image on startup.</maml:para> <maml:para>· F11BootMenuPrompt - Gets the current status of the POST One Time Boot F11 Prompt settings.</maml:para> <maml:para>· IntelligentProvisioningF10Prompt - Gets the current status of the Intelligent Provisioning functionality settings.</maml:para> <maml:para>· IntelTxtSupport (available on Gen10 with Intel processor and Gen9 servers) - Gets the current status of Intel TXT (Trusted Execution Technology) support settings.</maml:para> <maml:para>· ProcessorAESNISupport (available on Gen9 and Gen10 servers) - Gets the current status of the Advanced Encryption Standard New Instruction Set (AES-NI) in the processor.</maml:para> <maml:para>· AllowLoginWithiLO (available on Gen10 Plus AMD servers) - Specifies whether the user can login with an iLO account.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSServerSecurity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSServerSecurity | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK F11BootMenuPrompt : Enabled IntelligentProvisioningF10Prompt : Enabled IntelTxtSupport : Enabled ProcessorAESNISupport : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSServerSecurity | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK F11BootMenuPrompt : Enabled IntelligentProvisioningF10Prompt : Enabled ProcessorAESNISupport : Enabled BackupROMImageAuthentication : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 AMD server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSServerSecurity -Connection $connection | fl IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK F11BootMenuPrompt : Enabled IntelligentProvisioningF10Prompt : Enabled IntelTxtSupport : Enabled ProcessorAESNISupport : Enabled BackupROMImageAuthentication : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with connection object 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-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3,10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSServerSecurity -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK F11BootMenuPrompt : Enabled IntelligentProvisioningF10Prompt : Enabled IntelTxtSupport : Enabled ProcessorAESNISupport : Enabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK F11BootMenuPrompt : Enabled IntelligentProvisioningF10Prompt : Enabled AllowLoginWithiLO : Enabled ProcessorAESNISupport : Enabled BackupROMImageAuthentication : Disabled IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK F11BootMenuPrompt : Enabled IntelligentProvisioningF10Prompt : Enabled IntelTxtSupport : Enabled ProcessorAESNISupport : Enabled BackupROMImageAuthentication : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, Gen10 AMD, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSServerSecurity</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSServiceContact</command:name> <maml:description> <maml:para>The Get-HPEBIOSServiceContact cmdlet gets the reference information for the server service.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSServiceContact</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSServiceContact cmdlet gets the reference information for the server service as follows:</maml:para> <maml:para>· ServiceContactName - Gets the service contact name.</maml:para> <maml:para>· ServiceContactOtherInfo - Gets additional information related to the service contact.</maml:para> <maml:para>· ServicePhoneNumber - Gets the service contact number.</maml:para> <maml:para>· ServiceContactEmailAddress (available on Gen9 and Gen10 servers) - Gets the service contact email address.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSServiceContact</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSServiceContact -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ServiceContactName : XYZ ServicePhoneNumber : 980000000 ServiceContactOtherInfo : Alternate : 1800000112 ServiceContactEmailAddress : xyz@hpe.com</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 or Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSServiceContact -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ServiceContactName : XYZ ServicePhoneNumber : 980000000 ServiceContactOtherInfo : Alternate : 1800001012 ServiceContactEmailAddress : xyz@hpe.com IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK ServiceContactName : XYZ ServicePhoneNumber : 980000000 ServiceContactOtherInfo : Alternate : 1800001012 ServiceContactEmailAddress : xyz@hpe.com</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSServiceContact</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSSetting</command:name> <maml:description> <maml:para>The Get-HPEBIOSSetting cmdlet gets the base configuration, current settings, and pending settings of BIOS.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSSetting cmdlet gets the base configuration, current settings, and pending settings of BIOS as follows:</maml:para> <maml:para>· BaseConfig - Gets the factory default base BIOS settings.</maml:para> <maml:para>· CurrentBIOSSettings - Gets the current RBSU BIOS settings.</maml:para> <maml:para>· CurrentBIOSBootSettings - Gets the current RBSU BIOS boot settings.</maml:para> <maml:para>· PendingBIOSSettings - Gets the pending BIOS settings which will be applied to RBSU after reboot.</maml:para> <maml:para>· PendingBIOSBootSettings - Gets the pending BIOS boot settings which will be applied to RBSU after reboot.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , 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 (ByValue)" position="0" aliases="conn , 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>HPE.BIOS.Connection[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>· This cmdlet supports only on Gen9 and Gen10 servers.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSSetting | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK BaseConfig : @{NetworkLocationForShellAutoStartScript=; AdminName=; EmbeddedUEFIShell=Enabled; EmbeddedDiagnostic=Enabled; BootFromURL=; FibreChannelScanPolicy=ScanConfiguredTargetsOnly; SATASecureErase=Disabled; IPv4Gateway=0.0.0.0; AdminOtherInfo=; DynamicPowerSavingsModeResponse=Fast; VLANPriority=0; ServerOtherInfo=; TimeZone=Unspecified; MinimumProcessorIdlePowerPackageState=PackageC6State; PCIBusPaddingOption=Enabled; USBBootSupport=Enabled; DCUIPPrefetcher=Enabled; ProcessorCoreEnable=0; AddEmbeddedUEFIShellToBootOrder=Disabled; PrebootNetworkInterface=Auto; F11BootMenuPrompt=Enabled; VLANID=0; ResetDefaultManufacturingSetting=False; NetworkBootRetrySupport=Enabled; DaylightSavingTime=Disabled; DHCPv4=Enabled; EnergyPerformanceBias=BalancedPerformance; EmbeddedDiagnosticMode=Auto; ServerPrimaryOS=; UEFIOptimizedBoot=Enabled; IntelDMILinkFrequency=Auto; EnablePCIDevice=System.Collections.Generic.List`1[System.String]; ServiceContactOtherInfo=; POSTF1Prompt=Delayed20Sec; EmbeddedVideoConnection=Auto; FanFailurePolicy=Shutdown; SaveUserDefault=False; ConsistentDeviceNaming=CDNSupportForLOMsOnly; PCIExpressSupport=MaximumSupported; ExtendedMemoryTest=Disabled; WakeOnLAN=Enabled; NoExecuteMemoryProtection=Enabled; MemoryProximityReportingForIO=Enabled; IONonPostedPrefetching=Enabled; Intel_VT_d2=Enabled; EmbeddedUserPartition=Disabled; BootMode=UEFIMode; ServiceContactEmailAddress=; IPv4PrimaryDNS=0.0.0.0; ServiceContactName=; DCUStreamerPrefetcher=Enabled; PowerOnDelay=NoDelay; EraseUserDefault=False; InternalSDCardSlot=Enabled; ASRTimeout=10Minutes; PowerRegulator=DynamicPowerSavingsMode; ServicePhoneNumber=; PowerProfile=BalancedPowerAndPerformance; ServerName=; AdjacentSectorPrefetch=Enabled; PowerOnLogo=Enabled; SerialConsoleBaudRate=115200; HWPrefetcher=Enabled; PrebootNetworkEnvironmentPolicy=Auto; IntelligentProvisioningF10Prompt=Enabled; FanInstallationRequirement=EnableMessaging; EmbeddedSATAConfiguration=EnableDynamicSmartArrayRAIDSupport; IPv4SecondaryDNS=0.0.0.0; IntelTurboBoost=Enabled; VirtualSerialPort=COM1_IRQ4; MinimumProcessorIdlePowerCoreState=C6State; Language=English; CPUVirtualization=Enabled; ThermalShutdown=Enabled; PowerButton=Enabled; AutomaticPowerOn=RestoreLastPowerState; RestoreDefault=False; IntelNICDMAChannel=Enabled; TPMState=NotPresent; IPv4SubnetMask=0.0.0.0; MixedPowerSupplyReporting=Enabled; TimeFormat=UTC; VirtualInstallDisk=Disabled; ASR=Enabled; UEFIShellScriptAutoStart=Disabled; SecureBootState=Disabled; BootOrderPolicy=RetryIndefinitely; CustomPostMessage=; NMIDebugButton=Enabled; RemovableFlashMediaBootSequence=ExternalDriveKeysFirst; MemoryFastTraining=Enabled; AdvancedMemoryProtection=AdvancedECCSupport; SerialConsoleEmulationMode=VT100+; AdminPhoneNumber=; VLANControl=Disabled; USBControl=USBEnabled; EMSConsole=Disabled; DisableNetworkBoot=System.Collections.Generic.List`1[System.String]; ProcessorAESNISupport=Enabled; IPv6DHCPUniqueIdentifer=Auto; TPMType=NoTPM; SerialConsolePort=Auto; EnableNetworkBoot=System.Collections.Generic.List`1[System.String]; ServerAssetTag=; CollaborativePowerControl=Enabled; ThermalConfiguration=OptimalCooling; ShellAutoStartScriptLocation=Auto; IPv4Address=0.0.0.0; ProcessorX2ApicSupport=Enabled; MaximumMemoryBusFrequency=Auto; ExtendedAmbientTemperatureSupport=Disabled; AdminEmailAddress=; AssetTagProtection=Unlocked; NUMAGroupSizeOptimization=Clustered} CurrentBIOSSettings : @{NetworkLocationForShellAutoStartScript=ftp://testhost/startup.nsh; UEFIOptimizedBoot=Enabled; AdminName=; EmbeddedUEFIShell=Enabled; EmbeddedDiagnostic=Enabled; BootFromURL=; FibreChannelScanPolicy=ScanConfiguredTargetsOnly; SATASecureErase=Disabled; IPv4Gateway=0.0.0.0; AdminOtherInfo=; DynamicPowerSavingsModeResponse=Fast; VLANPriority=0; ServerOtherInfo=; TimeZone=Unspecified; MinimumProcessorIdlePowerPackageState=NoPackageState; PCIBusPaddingOption=Enabled; USBBootSupport=Enabled; DCUIPPrefetcher=Enabled; SerialNumber=MX2539009K; ProcessorCoreEnable=0; AddEmbeddedUEFIShellToBootOrder=Disabled; PrebootNetworkInterface=Auto; F11BootMenuPrompt=Enabled; VLANID=0; ResetDefaultManufacturingSetting=False; NetworkBootRetrySupport=Enabled; DaylightSavingTime=Disabled; DHCPv4=Enabled; USBControl=USBEnabled; EnergyPerformanceBias=MaximumPerformance; EmbeddedDiagnosticMode=Auto; ServerPrimaryOS=; IntelDMILinkFrequency=Auto; EnablePCIDevice=System.Collections.Generic.List`1[System.String]; ServiceContactOtherInfo=; ProductID=823556-B21; POSTF1Prompt=Delayed20Sec; EmbeddedVideoConnection=Auto; FanFailurePolicy=Shutdown; SaveUserDefault=False; ConsistentDeviceNaming=CDNSupportForLOMsOnly; PCIExpressSupport=MaximumSupported; ExtendedMemoryTest=Disabled; WakeOnLAN=Enabled; NoExecuteMemoryProtection=Enabled; MemoryProximityReportingForIO=Enabled; IONonPostedPrefetching=Enabled; Intel_VT_d2=Enabled; EmbeddedUserPartition=Disabled; ROMSelection=UseCurrentROM; BootMode=UEFIMode; ServiceContactEmailAddress=; IPv4PrimaryDNS=0.0.0.0; ServiceContactName=; DCUStreamerPrefetcher=Enabled; PowerOnDelay=NoDelay; EraseUserDefault=False; InternalSDCardSlot=Enabled; ASRTimeout=10Minutes; PowerRegulator=StaticHighPerformanceMode; ServicePhoneNumber=; PowerProfile=MaximumPerformance; ServerName=; AdjacentSectorPrefetch=Enabled; PowerOnLogo=Enabled; SerialConsoleBaudRate=115200; HWPrefetcher=Enabled; PrebootNetworkEnvironmentPolicy=Auto; IntelligentProvisioningF10Prompt=Enabled; TPMType=NoTPM; FanInstallationRequirement=EnableMessaging; EmbeddedSATAConfiguration=EnableSATAAHCISupport; IPv4SecondaryDNS=0.0.0.0; IntelTurboBoost=Enabled; VirtualSerialPort=COM1_IRQ4; MinimumProcessorIdlePowerCoreState=NoCStates; Language=English; CPUVirtualization=Enabled; ThermalShutdown=Enabled; PowerButton=Enabled; AutomaticPowerOn=RestoreLastPowerState; RestoreDefault=False; IntelNICDMAChannel=Enabled; TPMState=NotPresent; IPv4SubnetMask=0.0.0.0; TimeFormat=Local; VirtualInstallDisk=Disabled; ASR=Enabled; UEFIShellScriptAutoStart=Disabled; SecureBootState=Disabled; BootOrderPolicy=RetryIndefinitely; CustomPostMessage=; NMIDebugButton=Enabled; RemovableFlashMediaBootSequence=ExternalDriveKeysFirst; MemoryFastTraining=Enabled; AdvancedMemoryProtection=AdvancedECCSupport; SerialConsoleEmulationMode=VT100+; AdminPhoneNumber=; VLANControl=Disabled; MixedPowerSupplyReporting=Enabled; EMSConsole=Disabled; DisableNetworkBoot=System.Collections.Generic.List`1[System.String]; ProcessorAESNISupport=Enabled; IPv6DHCPUniqueIdentifer=Auto; SerialConsolePort=Auto; EnableNetworkBoot=System.Collections.Generic.List`1[System.String]; ServerAssetTag=; CollaborativePowerControl=Enabled; ThermalConfiguration=OptimalCooling; ShellAutoStartScriptLocation=Auto; IPv4Address=0.0.0.0; ProcessorX2ApicSupport=Enabled; MaximumMemoryBusFrequency=Auto; ExtendedAmbientTemperatureSupport=Disabled; AdminEmailAddress=; AssetTagProtection=Unlocked; NUMAGroupSizeOptimization=Clustered} CurrentBIOSBootSettings : @{DevicePriorityList=System.Collections.Generic.List`1[System.String]; UEFIBootOrder=System.Collections.Generic.List`1[System.String]} PendingBIOSSettings : @{NetworkLocationForShellAutoStartScript=ftp://testhost/startup.nsh; AdminName=; EmbeddedUEFIShell=Enabled; EmbeddedDiagnostic=Enabled; BootFromURL=; FibreChannelScanPolicy=ScanConfiguredTargetsOnly; SATASecureErase=Disabled; IPv4Gateway=0.0.0.0; AdminOtherInfo=; DynamicPowerSavingsModeResponse=Fast; VLANPriority=0; ServerOtherInfo=; TimeZone=Unspecified; MinimumProcessorIdlePowerPackageState=NoPackageState; PCIBusPaddingOption=Enabled; USBBootSupport=Enabled; DCUIPPrefetcher=Enabled; SerialNumber=MX2539009K; ProcessorCoreEnable=0; AddEmbeddedUEFIShellToBootOrder=Disabled; PrebootNetworkInterface=Auto; F11BootMenuPrompt=Enabled; VLANID=0; ResetDefaultManufacturingSetting=False; NetworkBootRetrySupport=Enabled; DaylightSavingTime=Disabled; DHCPv4=Enabled; USBControl=USBEnabled; EnergyPerformanceBias=MaximumPerformance; EmbeddedDiagnosticMode=Auto; ServerPrimaryOS=; UEFIOptimizedBoot=Enabled; IntelDMILinkFrequency=Auto; EnablePCIDevice=System.Collections.Generic.List`1[System.String]; ServiceContactOtherInfo=; ProductID=823556-B21; POSTF1Prompt=Delayed20Sec; EmbeddedVideoConnection=Auto; FanFailurePolicy=Shutdown; SaveUserDefault=False; ConsistentDeviceNaming=CDNSupportForLOMsOnly; PCIExpressSupport=MaximumSupported; ExtendedMemoryTest=Disabled; WakeOnLAN=Enabled; NoExecuteMemoryProtection=Enabled; MemoryProximityReportingForIO=Enabled; IONonPostedPrefetching=Enabled; Intel_VT_d2=Enabled; EmbeddedUserPartition=Disabled; ROMSelection=UseCurrentROM; BootMode=UEFIMode; ServiceContactEmailAddress=; IPv4PrimaryDNS=0.0.0.0; ServiceContactName=; DCUStreamerPrefetcher=Enabled; PowerOnDelay=NoDelay; EraseUserDefault=False; InternalSDCardSlot=Enabled; ASRTimeout=10Minutes; PowerRegulator=StaticHighPerformanceMode; ServicePhoneNumber=; PowerProfile=MaximumPerformance; ServerName=; AdjacentSectorPrefetch=Enabled; PowerOnLogo=Enabled; SerialConsoleBaudRate=115200; HWPrefetcher=Enabled; PrebootNetworkEnvironmentPolicy=Auto; IntelligentProvisioningF10Prompt=Enabled; TPMType=NoTPM; FanInstallationRequirement=EnableMessaging; EmbeddedSATAConfiguration=EnableSATAAHCISupport; IPv4SecondaryDNS=0.0.0.0; IntelTurboBoost=Enabled; VirtualSerialPort=COM1_IRQ4; MinimumProcessorIdlePowerCoreState=NoCStates; Language=English; CPUVirtualization=Enabled; ThermalShutdown=Enabled; PowerButton=Enabled; AutomaticPowerOn=RestoreLastPowerState; RestoreDefault=False; IntelNICDMAChannel=Enabled; TPMState=NotPresent; IPv4SubnetMask=0.0.0.0; TimeFormat=Local; VirtualInstallDisk=Disabled; ASR=Enabled; UEFIShellScriptAutoStart=Disabled; SecureBootState=Disabled; BootOrderPolicy=RetryIndefinitely; CustomPostMessage=; NMIDebugButton=Enabled; RemovableFlashMediaBootSequence=ExternalDriveKeysFirst; MemoryFastTraining=Enabled; AdvancedMemoryProtection=AdvancedECCSupport; SerialConsoleEmulationMode=VT100+; AdminPhoneNumber=; VLANControl=Disabled; MixedPowerSupplyReporting=Enabled; EMSConsole=Disabled; DisableNetworkBoot=System.Collections.Generic.List`1[System.String]; ProcessorAESNISupport=Enabled; IPv6DHCPUniqueIdentifer=Auto; SerialConsolePort=Auto; EnableNetworkBoot=System.Collections.Generic.List`1[System.String]; ServerAssetTag=; CollaborativePowerControl=Enabled; ThermalConfiguration=OptimalCooling; ShellAutoStartScriptLocation=Auto; IPv4Address=0.0.0.0; ProcessorX2ApicSupport=Enabled; MaximumMemoryBusFrequency=Auto; ExtendedAmbientTemperatureSupport=Disabled; AdminEmailAddress=; AssetTagProtection=Unlocked; NUMAGroupSizeOptimization=Clustered} PendingBIOSBootSettings : @{DevicePriorityList=System.Collections.Generic.List`1[System.String]; UEFIBootOrder=System.Collections.Generic.List`1[System.String]}</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSSetting -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK BaseConfig : @{NetworkLocationForShellAutoStartScript=; AdminName=; EmbeddedUEFIShell=Enabled; EmbeddedDiagnostic=Enabled; BootFromURL=; FibreChannelScanPolicy=ScanConfiguredTargetsOnly; SATASecureErase=Disabled; IPv4Gateway=0.0.0.0; AdminOtherInfo=; DynamicPowerSavingsModeResponse=Fast; VLANPriority=0; ServerOtherInfo=; TimeZone=Unspecified; MinimumProcessorIdlePowerPackageState=PackageC6State; PCIBusPaddingOption=Enabled; USBBootSupport=Enabled; DCUIPPrefetcher=Enabled; ProcessorCoreEnable=0; AddEmbeddedUEFIShellToBootOrder=Disabled; PrebootNetworkInterface=Auto; F11BootMenuPrompt=Enabled; VLANID=0; ResetDefaultManufacturingSetting=False; NetworkBootRetrySupport=Enabled; DaylightSavingTime=Disabled; DHCPv4=Enabled; EnergyPerformanceBias=BalancedPerformance; EmbeddedDiagnosticMode=Auto; ServerPrimaryOS=; UEFIOptimizedBoot=Enabled; IntelDMILinkFrequency=Auto; EnablePCIDevice=System.Collections.Generic.List`1[System.String]; ServiceContactOtherInfo=; POSTF1Prompt=Delayed20Sec; EmbeddedVideoConnection=Auto; FanFailurePolicy=Shutdown; SaveUserDefault=False; ConsistentDeviceNaming=CDNSupportForLOMsOnly; PCIExpressSupport=MaximumSupported; ExtendedMemoryTest=Disabled; WakeOnLAN=Enabled; NoExecuteMemoryProtection=Enabled; MemoryProximityReportingForIO=Enabled; IONonPostedPrefetching=Enabled; Intel_VT_d2=Enabled; EmbeddedUserPartition=Disabled; BootMode=UEFIMode; ServiceContactEmailAddress=; IPv4PrimaryDNS=0.0.0.0; ServiceContactName=; DCUStreamerPrefetcher=Enabled; PowerOnDelay=NoDelay; EraseUserDefault=False; InternalSDCardSlot=Enabled; ASRTimeout=10Minutes; PowerRegulator=DynamicPowerSavingsMode; ServicePhoneNumber=; PowerProfile=BalancedPowerAndPerformance; ServerName=; AdjacentSectorPrefetch=Enabled; PowerOnLogo=Enabled; SerialConsoleBaudRate=115200; HWPrefetcher=Enabled; PrebootNetworkEnvironmentPolicy=Auto; IntelligentProvisioningF10Prompt=Enabled; FanInstallationRequirement=EnableMessaging; EmbeddedSATAConfiguration=EnableDynamicSmartArrayRAIDSupport; IPv4SecondaryDNS=0.0.0.0; IntelTurboBoost=Enabled; VirtualSerialPort=COM1_IRQ4; MinimumProcessorIdlePowerCoreState=C6State; Language=English; CPUVirtualization=Enabled; ThermalShutdown=Enabled; PowerButton=Enabled; AutomaticPowerOn=RestoreLastPowerState; RestoreDefault=False; IntelNICDMAChannel=Enabled; TPMState=NotPresent; IPv4SubnetMask=0.0.0.0; MixedPowerSupplyReporting=Enabled; TimeFormat=UTC; VirtualInstallDisk=Disabled; ASR=Enabled; UEFIShellScriptAutoStart=Disabled; SecureBootState=Disabled; BootOrderPolicy=RetryIndefinitely; CustomPostMessage=; NMIDebugButton=Enabled; RemovableFlashMediaBootSequence=ExternalDriveKeysFirst; MemoryFastTraining=Enabled; AdvancedMemoryProtection=AdvancedECCSupport; SerialConsoleEmulationMode=VT100+; AdminPhoneNumber=; VLANControl=Disabled; USBControl=USBEnabled; EMSConsole=Disabled; DisableNetworkBoot=System.Collections.Generic.List`1[System.String]; ProcessorAESNISupport=Enabled; IPv6DHCPUniqueIdentifer=Auto; TPMType=NoTPM; SerialConsolePort=Auto; EnableNetworkBoot=System.Collections.Generic.List`1[System.String]; ServerAssetTag=; CollaborativePowerControl=Enabled; ThermalConfiguration=OptimalCooling; ShellAutoStartScriptLocation=Auto; IPv4Address=0.0.0.0; ProcessorX2ApicSupport=Enabled; MaximumMemoryBusFrequency=Auto; ExtendedAmbientTemperatureSupport=Disabled; AdminEmailAddress=; AssetTagProtection=Unlocked; NUMAGroupSizeOptimization=Clustered} CurrentBIOSSettings : @{NetworkLocationForShellAutoStartScript=ftp://testhost/startup.nsh; UEFIOptimizedBoot=Enabled; AdminName=; EmbeddedUEFIShell=Enabled; EmbeddedDiagnostic=Enabled; BootFromURL=; FibreChannelScanPolicy=ScanConfiguredTargetsOnly; SATASecureErase=Disabled; IPv4Gateway=0.0.0.0; AdminOtherInfo=; DynamicPowerSavingsModeResponse=Fast; VLANPriority=0; ServerOtherInfo=; TimeZone=Unspecified; MinimumProcessorIdlePowerPackageState=NoPackageState; PCIBusPaddingOption=Enabled; USBBootSupport=Enabled; DCUIPPrefetcher=Enabled; SerialNumber=MX2539009K; ProcessorCoreEnable=0; AddEmbeddedUEFIShellToBootOrder=Disabled; PrebootNetworkInterface=Auto; F11BootMenuPrompt=Enabled; VLANID=0; ResetDefaultManufacturingSetting=False; NetworkBootRetrySupport=Enabled; DaylightSavingTime=Disabled; DHCPv4=Enabled; USBControl=USBEnabled; EnergyPerformanceBias=MaximumPerformance; EmbeddedDiagnosticMode=Auto; ServerPrimaryOS=; IntelDMILinkFrequency=Auto; EnablePCIDevice=System.Collections.Generic.List`1[System.String]; ServiceContactOtherInfo=; ProductID=823556-B21; POSTF1Prompt=Delayed20Sec; EmbeddedVideoConnection=Auto; FanFailurePolicy=Shutdown; SaveUserDefault=False; ConsistentDeviceNaming=CDNSupportForLOMsOnly; PCIExpressSupport=MaximumSupported; ExtendedMemoryTest=Disabled; WakeOnLAN=Enabled; NoExecuteMemoryProtection=Enabled; MemoryProximityReportingForIO=Enabled; IONonPostedPrefetching=Enabled; Intel_VT_d2=Enabled; EmbeddedUserPartition=Disabled; ROMSelection=UseCurrentROM; BootMode=UEFIMode; ServiceContactEmailAddress=; IPv4PrimaryDNS=0.0.0.0; ServiceContactName=; DCUStreamerPrefetcher=Enabled; PowerOnDelay=NoDelay; EraseUserDefault=False; InternalSDCardSlot=Enabled; ASRTimeout=10Minutes; PowerRegulator=StaticHighPerformanceMode; ServicePhoneNumber=; PowerProfile=MaximumPerformance; ServerName=; AdjacentSectorPrefetch=Enabled; PowerOnLogo=Enabled; SerialConsoleBaudRate=115200; HWPrefetcher=Enabled; PrebootNetworkEnvironmentPolicy=Auto; IntelligentProvisioningF10Prompt=Enabled; TPMType=NoTPM; FanInstallationRequirement=EnableMessaging; EmbeddedSATAConfiguration=EnableSATAAHCISupport; IPv4SecondaryDNS=0.0.0.0; IntelTurboBoost=Enabled; VirtualSerialPort=COM1_IRQ4; MinimumProcessorIdlePowerCoreState=NoCStates; Language=English; CPUVirtualization=Enabled; ThermalShutdown=Enabled; PowerButton=Enabled; AutomaticPowerOn=RestoreLastPowerState; RestoreDefault=False; IntelNICDMAChannel=Enabled; TPMState=NotPresent; IPv4SubnetMask=0.0.0.0; TimeFormat=Local; VirtualInstallDisk=Disabled; ASR=Enabled; UEFIShellScriptAutoStart=Disabled; SecureBootState=Disabled; BootOrderPolicy=RetryIndefinitely; CustomPostMessage=; NMIDebugButton=Enabled; RemovableFlashMediaBootSequence=ExternalDriveKeysFirst; MemoryFastTraining=Enabled; AdvancedMemoryProtection=AdvancedECCSupport; SerialConsoleEmulationMode=VT100+; AdminPhoneNumber=; VLANControl=Disabled; MixedPowerSupplyReporting=Enabled; EMSConsole=Disabled; DisableNetworkBoot=System.Collections.Generic.List`1[System.String]; ProcessorAESNISupport=Enabled; IPv6DHCPUniqueIdentifer=Auto; SerialConsolePort=Auto; EnableNetworkBoot=System.Collections.Generic.List`1[System.String]; ServerAssetTag=; CollaborativePowerControl=Enabled; ThermalConfiguration=OptimalCooling; ShellAutoStartScriptLocation=Auto; IPv4Address=0.0.0.0; ProcessorX2ApicSupport=Enabled; MaximumMemoryBusFrequency=Auto; ExtendedAmbientTemperatureSupport=Disabled; AdminEmailAddress=; AssetTagProtection=Unlocked; NUMAGroupSizeOptimization=Clustered} CurrentBIOSBootSettings : @{DevicePriorityList=System.Collections.Generic.List`1[System.String]; UEFIBootOrder=System.Collections.Generic.List`1[System.String]} PendingBIOSSettings : @{NetworkLocationForShellAutoStartScript=ftp://testhost/startup.nsh; AdminName=; EmbeddedUEFIShell=Enabled; EmbeddedDiagnostic=Enabled; BootFromURL=; FibreChannelScanPolicy=ScanConfiguredTargetsOnly; SATASecureErase=Disabled; IPv4Gateway=0.0.0.0; AdminOtherInfo=; DynamicPowerSavingsModeResponse=Fast; VLANPriority=0; ServerOtherInfo=; TimeZone=Unspecified; MinimumProcessorIdlePowerPackageState=NoPackageState; PCIBusPaddingOption=Enabled; USBBootSupport=Enabled; DCUIPPrefetcher=Enabled; SerialNumber=MX2539009K; ProcessorCoreEnable=0; AddEmbeddedUEFIShellToBootOrder=Disabled; PrebootNetworkInterface=Auto; F11BootMenuPrompt=Enabled; VLANID=0; ResetDefaultManufacturingSetting=False; NetworkBootRetrySupport=Enabled; DaylightSavingTime=Disabled; DHCPv4=Enabled; USBControl=USBEnabled; EnergyPerformanceBias=MaximumPerformance; EmbeddedDiagnosticMode=Auto; ServerPrimaryOS=; UEFIOptimizedBoot=Enabled; IntelDMILinkFrequency=Auto; EnablePCIDevice=System.Collections.Generic.List`1[System.String]; ServiceContactOtherInfo=; ProductID=823556-B21; POSTF1Prompt=Delayed20Sec; EmbeddedVideoConnection=Auto; FanFailurePolicy=Shutdown; SaveUserDefault=False; ConsistentDeviceNaming=CDNSupportForLOMsOnly; PCIExpressSupport=MaximumSupported; ExtendedMemoryTest=Disabled; WakeOnLAN=Enabled; NoExecuteMemoryProtection=Enabled; MemoryProximityReportingForIO=Enabled; IONonPostedPrefetching=Enabled; Intel_VT_d2=Enabled; EmbeddedUserPartition=Disabled; ROMSelection=UseCurrentROM; BootMode=UEFIMode; ServiceContactEmailAddress=; IPv4PrimaryDNS=0.0.0.0; ServiceContactName=; DCUStreamerPrefetcher=Enabled; PowerOnDelay=NoDelay; EraseUserDefault=False; InternalSDCardSlot=Enabled; ASRTimeout=10Minutes; PowerRegulator=StaticHighPerformanceMode; ServicePhoneNumber=; PowerProfile=MaximumPerformance; ServerName=; AdjacentSectorPrefetch=Enabled; PowerOnLogo=Enabled; SerialConsoleBaudRate=115200; HWPrefetcher=Enabled; PrebootNetworkEnvironmentPolicy=Auto; IntelligentProvisioningF10Prompt=Enabled; TPMType=NoTPM; FanInstallationRequirement=EnableMessaging; EmbeddedSATAConfiguration=EnableSATAAHCISupport; IPv4SecondaryDNS=0.0.0.0; IntelTurboBoost=Enabled; VirtualSerialPort=COM1_IRQ4; MinimumProcessorIdlePowerCoreState=NoCStates; Language=English; CPUVirtualization=Enabled; ThermalShutdown=Enabled; PowerButton=Enabled; AutomaticPowerOn=RestoreLastPowerState; RestoreDefault=False; IntelNICDMAChannel=Enabled; TPMState=NotPresent; IPv4SubnetMask=0.0.0.0; TimeFormat=Local; VirtualInstallDisk=Disabled; ASR=Enabled; UEFIShellScriptAutoStart=Disabled; SecureBootState=Disabled; BootOrderPolicy=RetryIndefinitely; CustomPostMessage=; NMIDebugButton=Enabled; RemovableFlashMediaBootSequence=ExternalDriveKeysFirst; MemoryFastTraining=Enabled; AdvancedMemoryProtection=AdvancedECCSupport; SerialConsoleEmulationMode=VT100+; AdminPhoneNumber=; VLANControl=Disabled; MixedPowerSupplyReporting=Enabled; EMSConsole=Disabled; DisableNetworkBoot=System.Collections.Generic.List`1[System.String]; ProcessorAESNISupport=Enabled; IPv6DHCPUniqueIdentifer=Auto; SerialConsolePort=Auto; EnableNetworkBoot=System.Collections.Generic.List`1[System.String]; ServerAssetTag=; CollaborativePowerControl=Enabled; ThermalConfiguration=OptimalCooling; ShellAutoStartScriptLocation=Auto; IPv4Address=0.0.0.0; ProcessorX2ApicSupport=Enabled; MaximumMemoryBusFrequency=Auto; ExtendedAmbientTemperatureSupport=Disabled; AdminEmailAddress=; AssetTagProtection=Unlocked; NUMAGroupSizeOptimization=Clustered} PendingBIOSBootSettings : @{DevicePriorityList=System.Collections.Generic.List`1[System.String]; UEFIBootOrder=System.Collections.Generic.List`1[System.String]} IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK BaseConfig : @{NetworkLocationForShellAutoStartScript=; AdminName=; EmbeddedUEFIShell=Enabled; EmbeddedDiagnostic=Enabled; BootFromURL=; FibreChannelScanPolicy=ScanConfiguredTargetsOnly; SATASecureErase=Disabled; IPv4Gateway=0.0.0.0; AdminOtherInfo=; DynamicPowerSavingsModeResponse=Fast; VLANPriority=0; ServerOtherInfo=; TimeZone=Unspecified; MinimumProcessorIdlePowerPackageState=PackageC6State; PCIBusPaddingOption=Enabled; USBBootSupport=Enabled; DCUIPPrefetcher=Enabled; ProcessorCoreEnable=0; AddEmbeddedUEFIShellToBootOrder=Disabled; PrebootNetworkInterface=Auto; F11BootMenuPrompt=Enabled; VLANID=0; ResetDefaultManufacturingSetting=False; NetworkBootRetrySupport=Enabled; DaylightSavingTime=Disabled; DHCPv4=Enabled; EnergyPerformanceBias=BalancedPerformance; EmbeddedDiagnosticMode=Auto; ServerPrimaryOS=; UEFIOptimizedBoot=Enabled; IntelDMILinkFrequency=Auto; EnablePCIDevice=System.Collections.Generic.List`1[System.String]; ServiceContactOtherInfo=; POSTF1Prompt=Delayed20Sec; EmbeddedVideoConnection=Auto; FanFailurePolicy=Shutdown; SaveUserDefault=False; ConsistentDeviceNaming=CDNSupportForLOMsOnly; PCIExpressSupport=MaximumSupported; ExtendedMemoryTest=Disabled; WakeOnLAN=Enabled; NoExecuteMemoryProtection=Enabled; MemoryProximityReportingForIO=Enabled; IONonPostedPrefetching=Enabled; Intel_VT_d2=Enabled; EmbeddedUserPartition=Disabled; BootMode=UEFIMode; ServiceContactEmailAddress=; IPv4PrimaryDNS=0.0.0.0; ServiceContactName=; DCUStreamerPrefetcher=Enabled; PowerOnDelay=NoDelay; EraseUserDefault=False; InternalSDCardSlot=Enabled; ASRTimeout=10Minutes; PowerRegulator=DynamicPowerSavingsMode; ServicePhoneNumber=; PowerProfile=BalancedPowerAndPerformance; ServerName=; AdjacentSectorPrefetch=Enabled; PowerOnLogo=Enabled; SerialConsoleBaudRate=115200; HWPrefetcher=Enabled; PrebootNetworkEnvironmentPolicy=Auto; IntelligentProvisioningF10Prompt=Enabled; FanInstallationRequirement=EnableMessaging; EmbeddedSATAConfiguration=EnableDynamicSmartArrayRAIDSupport; IPv4SecondaryDNS=0.0.0.0; IntelTurboBoost=Enabled; VirtualSerialPort=COM1_IRQ4; MinimumProcessorIdlePowerCoreState=C6State; Language=English; CPUVirtualization=Enabled; ThermalShutdown=Enabled; PowerButton=Enabled; AutomaticPowerOn=RestoreLastPowerState; RestoreDefault=False; IntelNICDMAChannel=Enabled; TPMState=NotPresent; IPv4SubnetMask=0.0.0.0; MixedPowerSupplyReporting=Enabled; TimeFormat=UTC; VirtualInstallDisk=Disabled; ASR=Enabled; UEFIShellScriptAutoStart=Disabled; SecureBootState=Disabled; BootOrderPolicy=RetryIndefinitely; CustomPostMessage=; NMIDebugButton=Enabled; RemovableFlashMediaBootSequence=ExternalDriveKeysFirst; MemoryFastTraining=Enabled; AdvancedMemoryProtection=AdvancedECCSupport; SerialConsoleEmulationMode=VT100+; AdminPhoneNumber=; VLANControl=Disabled; USBControl=USBEnabled; EMSConsole=Disabled; DisableNetworkBoot=System.Collections.Generic.List`1[System.String]; ProcessorAESNISupport=Enabled; IPv6DHCPUniqueIdentifer=Auto; TPMType=NoTPM; SerialConsolePort=Auto; EnableNetworkBoot=System.Collections.Generic.List`1[System.String]; ServerAssetTag=; CollaborativePowerControl=Enabled; ThermalConfiguration=OptimalCooling; ShellAutoStartScriptLocation=Auto; IPv4Address=0.0.0.0; ProcessorX2ApicSupport=Enabled; MaximumMemoryBusFrequency=Auto; ExtendedAmbientTemperatureSupport=Disabled; AdminEmailAddress=; AssetTagProtection=Unlocked; NUMAGroupSizeOptimization=Clustered} CurrentBIOSSettings : @{NetworkLocationForShellAutoStartScript=ftp://testhost/startup.nsh; UEFIOptimizedBoot=Enabled; AdminName=; EmbeddedUEFIShell=Enabled; EmbeddedDiagnostic=Enabled; BootFromURL=; FibreChannelScanPolicy=ScanConfiguredTargetsOnly; SATASecureErase=Disabled; IPv4Gateway=0.0.0.0; AdminOtherInfo=; DynamicPowerSavingsModeResponse=Fast; VLANPriority=0; ServerOtherInfo=; TimeZone=Unspecified; MinimumProcessorIdlePowerPackageState=NoPackageState; PCIBusPaddingOption=Enabled; USBBootSupport=Enabled; DCUIPPrefetcher=Enabled; SerialNumber=MX2539009K; ProcessorCoreEnable=0; AddEmbeddedUEFIShellToBootOrder=Disabled; PrebootNetworkInterface=Auto; F11BootMenuPrompt=Enabled; VLANID=0; ResetDefaultManufacturingSetting=False; NetworkBootRetrySupport=Enabled; DaylightSavingTime=Disabled; DHCPv4=Enabled; USBControl=USBEnabled; EnergyPerformanceBias=MaximumPerformance; EmbeddedDiagnosticMode=Auto; ServerPrimaryOS=; IntelDMILinkFrequency=Auto; EnablePCIDevice=System.Collections.Generic.List`1[System.String]; ServiceContactOtherInfo=; ProductID=823556-B21; POSTF1Prompt=Delayed20Sec; EmbeddedVideoConnection=Auto; FanFailurePolicy=Shutdown; SaveUserDefault=False; ConsistentDeviceNaming=CDNSupportForLOMsOnly; PCIExpressSupport=MaximumSupported; ExtendedMemoryTest=Disabled; WakeOnLAN=Enabled; NoExecuteMemoryProtection=Enabled; MemoryProximityReportingForIO=Enabled; IONonPostedPrefetching=Enabled; Intel_VT_d2=Enabled; EmbeddedUserPartition=Disabled; ROMSelection=UseCurrentROM; BootMode=UEFIMode; ServiceContactEmailAddress=; IPv4PrimaryDNS=0.0.0.0; ServiceContactName=; DCUStreamerPrefetcher=Enabled; PowerOnDelay=NoDelay; EraseUserDefault=False; InternalSDCardSlot=Enabled; ASRTimeout=10Minutes; PowerRegulator=StaticHighPerformanceMode; ServicePhoneNumber=; PowerProfile=MaximumPerformance; ServerName=; AdjacentSectorPrefetch=Enabled; PowerOnLogo=Enabled; SerialConsoleBaudRate=115200; HWPrefetcher=Enabled; PrebootNetworkEnvironmentPolicy=Auto; IntelligentProvisioningF10Prompt=Enabled; TPMType=NoTPM; FanInstallationRequirement=EnableMessaging; EmbeddedSATAConfiguration=EnableSATAAHCISupport; IPv4SecondaryDNS=0.0.0.0; IntelTurboBoost=Enabled; VirtualSerialPort=COM1_IRQ4; MinimumProcessorIdlePowerCoreState=NoCStates; Language=English; CPUVirtualization=Enabled; ThermalShutdown=Enabled; PowerButton=Enabled; AutomaticPowerOn=RestoreLastPowerState; RestoreDefault=False; IntelNICDMAChannel=Enabled; TPMState=NotPresent; IPv4SubnetMask=0.0.0.0; TimeFormat=Local; VirtualInstallDisk=Disabled; ASR=Enabled; UEFIShellScriptAutoStart=Disabled; SecureBootState=Disabled; BootOrderPolicy=RetryIndefinitely; CustomPostMessage=; NMIDebugButton=Enabled; RemovableFlashMediaBootSequence=ExternalDriveKeysFirst; MemoryFastTraining=Enabled; AdvancedMemoryProtection=AdvancedECCSupport; SerialConsoleEmulationMode=VT100+; AdminPhoneNumber=; VLANControl=Disabled; MixedPowerSupplyReporting=Enabled; EMSConsole=Disabled; DisableNetworkBoot=System.Collections.Generic.List`1[System.String]; ProcessorAESNISupport=Enabled; IPv6DHCPUniqueIdentifer=Auto; SerialConsolePort=Auto; EnableNetworkBoot=System.Collections.Generic.List`1[System.String]; ServerAssetTag=; CollaborativePowerControl=Enabled; ThermalConfiguration=OptimalCooling; ShellAutoStartScriptLocation=Auto; IPv4Address=0.0.0.0; ProcessorX2ApicSupport=Enabled; MaximumMemoryBusFrequency=Auto; ExtendedAmbientTemperatureSupport=Disabled; AdminEmailAddress=; AssetTagProtection=Unlocked; NUMAGroupSizeOptimization=Clustered} CurrentBIOSBootSettings : @{DevicePriorityList=System.Collections.Generic.List`1[System.String]; UEFIBootOrder=System.Collections.Generic.List`1[System.String]} PendingBIOSSettings : @{NetworkLocationForShellAutoStartScript=ftp://testhost/startup.nsh; AdminName=; EmbeddedUEFIShell=Enabled; EmbeddedDiagnostic=Enabled; BootFromURL=; FibreChannelScanPolicy=ScanConfiguredTargetsOnly; SATASecureErase=Disabled; IPv4Gateway=0.0.0.0; AdminOtherInfo=; DynamicPowerSavingsModeResponse=Fast; VLANPriority=0; ServerOtherInfo=; TimeZone=Unspecified; MinimumProcessorIdlePowerPackageState=NoPackageState; PCIBusPaddingOption=Enabled; USBBootSupport=Enabled; DCUIPPrefetcher=Enabled; SerialNumber=MX2539009K; ProcessorCoreEnable=0; AddEmbeddedUEFIShellToBootOrder=Disabled; PrebootNetworkInterface=Auto; F11BootMenuPrompt=Enabled; VLANID=0; ResetDefaultManufacturingSetting=False; NetworkBootRetrySupport=Enabled; DaylightSavingTime=Disabled; DHCPv4=Enabled; USBControl=USBEnabled; EnergyPerformanceBias=MaximumPerformance; EmbeddedDiagnosticMode=Auto; ServerPrimaryOS=; UEFIOptimizedBoot=Enabled; IntelDMILinkFrequency=Auto; EnablePCIDevice=System.Collections.Generic.List`1[System.String]; ServiceContactOtherInfo=; ProductID=823556-B21; POSTF1Prompt=Delayed20Sec; EmbeddedVideoConnection=Auto; FanFailurePolicy=Shutdown; SaveUserDefault=False; ConsistentDeviceNaming=CDNSupportForLOMsOnly; PCIExpressSupport=MaximumSupported; ExtendedMemoryTest=Disabled; WakeOnLAN=Enabled; NoExecuteMemoryProtection=Enabled; MemoryProximityReportingForIO=Enabled; IONonPostedPrefetching=Enabled; Intel_VT_d2=Enabled; EmbeddedUserPartition=Disabled; ROMSelection=UseCurrentROM; BootMode=UEFIMode; ServiceContactEmailAddress=; IPv4PrimaryDNS=0.0.0.0; ServiceContactName=; DCUStreamerPrefetcher=Enabled; PowerOnDelay=NoDelay; EraseUserDefault=False; InternalSDCardSlot=Enabled; ASRTimeout=10Minutes; PowerRegulator=StaticHighPerformanceMode; ServicePhoneNumber=; PowerProfile=MaximumPerformance; ServerName=; AdjacentSectorPrefetch=Enabled; PowerOnLogo=Enabled; SerialConsoleBaudRate=115200; HWPrefetcher=Enabled; PrebootNetworkEnvironmentPolicy=Auto; IntelligentProvisioningF10Prompt=Enabled; TPMType=NoTPM; FanInstallationRequirement=EnableMessaging; EmbeddedSATAConfiguration=EnableSATAAHCISupport; IPv4SecondaryDNS=0.0.0.0; IntelTurboBoost=Enabled; VirtualSerialPort=COM1_IRQ4; MinimumProcessorIdlePowerCoreState=NoCStates; Language=English; CPUVirtualization=Enabled; ThermalShutdown=Enabled; PowerButton=Enabled; AutomaticPowerOn=RestoreLastPowerState; RestoreDefault=False; IntelNICDMAChannel=Enabled; TPMState=NotPresent; IPv4SubnetMask=0.0.0.0; TimeFormat=Local; VirtualInstallDisk=Disabled; ASR=Enabled; UEFIShellScriptAutoStart=Disabled; SecureBootState=Disabled; BootOrderPolicy=RetryIndefinitely; CustomPostMessage=; NMIDebugButton=Enabled; RemovableFlashMediaBootSequence=ExternalDriveKeysFirst; MemoryFastTraining=Enabled; AdvancedMemoryProtection=AdvancedECCSupport; SerialConsoleEmulationMode=VT100+; AdminPhoneNumber=; VLANControl=Disabled; MixedPowerSupplyReporting=Enabled; EMSConsole=Disabled; DisableNetworkBoot=System.Collections.Generic.List`1[System.String]; ProcessorAESNISupport=Enabled; IPv6DHCPUniqueIdentifer=Auto; SerialConsolePort=Auto; EnableNetworkBoot=System.Collections.Generic.List`1[System.String]; ServerAssetTag=; CollaborativePowerControl=Enabled; ThermalConfiguration=OptimalCooling; ShellAutoStartScriptLocation=Auto; IPv4Address=0.0.0.0; ProcessorX2ApicSupport=Enabled; MaximumMemoryBusFrequency=Auto; ExtendedAmbientTemperatureSupport=Disabled; AdminEmailAddress=; AssetTagProtection=Unlocked; NUMAGroupSizeOptimization=Clustered} PendingBIOSBootSettings : @{DevicePriorityList=System.Collections.Generic.List`1[System.String]; UEFIBootOrder=System.Collections.Generic.List`1[System.String]}</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSStorageOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSStorageOption cmdlet gets the storage boot policy for storage controllers.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSStorageOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSStorageOption cmdlet gets the storage boot policy for storage controllers as follows:</maml:para> <maml:para>· FibreChannelScanPolicy - Gets the current policy for scanning for valid FC/FCoE (or boot from SAN) boot targets.</maml:para> <maml:para>· EmbeddedStorageBootPolicy - Gets the current policy set for scanning UEFI BIOS boot targets for embedded storage controllers.</maml:para> <maml:para>· SlotxStorageBoot - Gets the current storage boot policy for storage controllers connected in PCIe slots.</maml:para> <maml:para>NOTE: The “x” represents a numeric value that ranges from 1-16 and 21. The number of installed storage controllers varies from system to system.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSStorageOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSStorageOption | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK EmbeddedStorageBootPolicy : BootAllTargets FibreChannelScanPolicy : ScanAllTargets Slot1StorageBoot : BootLimitTo3Targets Slot2StorageBoot : ScanAllTargets Slot3StorageBoot : BootNoTargets Slot4StorageBoot : BootLimitTo3Targets Slot5StorageBoot : ScanAllTargets Slot6StorageBoot : ScanAllTargets Slot7StorageBoot : ScanAllTargets Slot8StorageBoot : BootNoTargets Slot9StorageBoot : BootNoTargets</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSStorageOption -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EmbeddedStorageBootPolicy : BootLimitTo24Targets FibreChannelScanPolicy : ScanConfiguredTargetsOnly Slot1StorageBoot : ScanAllTargets Slot2StorageBoot : BootLimitTo24Targets Slot3StorageBoot : BootNoTargets Slot4StorageBoot : BootLimitTo24Targets Slot5StorageBoot : ScanAllTargets Slot6StorageBoot : ScanAllTargets Slot7StorageBoot : BootLimitTo24Targets Slot8StorageBoot : BootLimitTo24Targets Slot9StorageBoot : ScanAllTargets Slot10StorageBoot : ScanAllTargets Slot11StorageBoot : ScanAllTargets Slot12StorageBoot : ScanAllTargets Slot13StorageBoot : BootNoTargets Slot14StorageBoot : BootNoTargets Slot15StorageBoot : BootLimitTo24Targets Slot16StorageBoot : BootNoTargets</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSStorageOption -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK EmbeddedStorageBootPolicy : BootAllTargets FibreChannelScanPolicy : ScanAllTargets Slot1StorageBoot : BootLimitTo3Targets Slot2StorageBoot : ScanAllTargets Slot3StorageBoot : BootNoTargets Slot4StorageBoot : BootLimitTo3Targets Slot5StorageBoot : ScanAllTargets Slot6StorageBoot : ScanAllTargets Slot7StorageBoot : ScanAllTargets Slot8StorageBoot : BootNoTargets Slot9StorageBoot : BootNoTargets IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK EmbeddedStorageBootPolicy : BootLimitTo24Targets FibreChannelScanPolicy : ScanConfiguredTargetsOnly Slot1StorageBoot : ScanAllTargets Slot2StorageBoot : BootLimitTo24Targets Slot3StorageBoot : BootNoTargets Slot4StorageBoot : BootLimitTo24Targets Slot5StorageBoot : ScanAllTargets Slot6StorageBoot : ScanAllTargets Slot7StorageBoot : BootLimitTo24Targets Slot8StorageBoot : BootLimitTo24Targets Slot9StorageBoot : ScanAllTargets Slot10StorageBoot : ScanAllTargets Slot11StorageBoot : ScanAllTargets Slot12StorageBoot : ScanAllTargets Slot13StorageBoot : BootNoTargets Slot14StorageBoot : BootNoTargets Slot15StorageBoot : BootLimitTo24Targets Slot16StorageBoot : BootNoTargets</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSStorageOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSSystemInfo</command:name> <maml:description> <maml:para>The Get-HPEBIOSSystemInfo cmdlet gets the BIOS system information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSSystemInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSSystemInfo cmdlet gets the BIOS system information as follows:</maml:para> <maml:para>· SerialNumber - Gets the system board serial number.</maml:para> <maml:para>· ProductID - Gets the ID located on the chassis.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSSystemInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSSystemInfo | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK ProductID : DL380123ABC SerialNumber : 1AB65432AQ</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSSystemInfo -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ProductID : ML350456DEF SerialNumber : 7CD65432AZ</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSSystemInfo -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK ProductID : DL380123ABC SerialNumber : 1AB65432AQ IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ProductID : ML350456DEF SerialNumber : 7CD65432AZ</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSSystemInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSThermalOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSThermalOption cmdlet obtains the fan cooling solution for the system.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSThermalOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSThermalOption cmdlet obtains the fan cooling solution for the system as follows:</maml:para> <maml:para>· ThermalConfiguration - Gets the current thermal configuration setting.</maml:para> <maml:para>· ExtendedAmbientTemperatureSupport - Gets the current ambient operating temperature setting.</maml:para> <maml:para>· ThermalShutdown - Gets the current status of Thermal Shutdown.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSThermalOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSThermalOption | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ThermalConfiguration : MaximumCooling ThermalShutdown : Enabled ExtendedAmbientTemperatureSupport : ASHRAE3</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSThermalOption -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK ThermalConfiguration : IncreasedCooling ThermalShutdown : Disabled ExtendedAmbientTemperatureSupport : ASHRAE4</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSThermalOption -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK ThermalConfiguration : MaximumCooling ThermalShutdown : Enabled ExtendedAmbientTemperatureSupport : ASHRAE3 IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK ThermalConfiguration : EnhancedCPUCooling ThermalShutdown : Disabled ExtendedAmbientTemperatureSupport : ASHRAE4</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSThermalOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSTLSCertificate</command:name> <maml:description> <maml:para>The Get-HPEBIOSTLSCertificate cmdlet obtains the list of installed certificates for the TLS HTTPS connection.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSTLSCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSTLSCertificate cmdlet obtains the list of installed certificates for the TLS HTTPS connection as follows:</maml:para> <maml:para>· TLSCertificate (only available on Gen10 servers) - Gets the current installed certificate.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSTLSCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $installedCertificate = $connection | Get-HPEBIOSTLSCertificate PS C:\> $installedCertificate.TLSCertificate | fl Index : 1 Certificate : @{FingerPrint=C4:C3:7C:41:B7:33:33:43:F8:B2:63:EC:DB:16:13:DA:54:F8:70:29:6A:87:21:D3:DC:4D:9A:50:DC:03:4C:F3; Issuer=C=US, O=DigiCert Inc, CN=DigiCert Global CA G2; ValidFrom=08/10/2018 00:00; Subject=C=US, ST=California, L=Palo Alto, O=Hewlett Packard Enterprise Company, OU=Operations, CN=www.hpe.com; SerialNumber=CC2F5D233E63CD9879739D434AB1D8; ValidTo=08/11/2019 12:00} Index : 2 Certificate : @{FingerPrint=5C:9A:5C:D3:62:64:CB:ED:00:75:44:08:23:09:50:2D:0B:D1:38:1A:C3:F8:B7:FB:B3:EE:31:2F:1D:03:77:16; Issuer=C=US, ST=Washington, L=Redmond, O=Microsoft Corporation, OU=Microsoft IT, CN=Microsoft IT TLS CA 4; ValidFrom=01/16/2018 21:24; Subject=C=US, ST=WA, L=Redmond, O=Microsoft Corporation, OU=Microsoft Corporation, CN=www.microsoft.com; SerialNumber=1600A226527171F754ACC4160000A226; ValidTo=01/16/2020 21:24}</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $installedCertificate = Get-HPEBIOSTLSCertificate -Connection $connection PS C:\> $installedCertificate | fl IP : 192.168.10.27 Hostname : ml110gen10-01.powershvpn.com Status : OK TLSCertificate : {@{Index=1; Certificate=}} IP : 192.168.10.29 Hostname : dl580gen10-01.powershvpn.com Status : OK TLSCertificate : {@{Index=1; Certificate=}, @{Index=2; Certificate=}}</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Uninstall-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificateInstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificateUninstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEBIOSTLSCertificateInstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEBIOSTLSCertificateUninstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSTLSCertificateInstallationQueue</command:name> <maml:description> <maml:para>The Get-HPEBIOSTLSCertificateInstallationQueue cmdlet gets the BIOS list of certificates in the installation queue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSTLSCertificateInstallationQueue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSTLSCertificateInstallationQueue cmdlet gets the BIOS list of certificates in the installation queue as follows:</maml:para> <maml:para>· InstallationQueue (only available on Gen10 servers) - Gets the current list of certificates in the installation queue.</maml:para> <maml:para>Note: Use the Clear-HPEBIOSTLSCertificateInstallationQueue cmdlet to clear the installation queue.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSTLSCertificateInstallationQueue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $installationQueue = $connection | Get-HPEBIOSTLSCertificateInstallationQueue PS C:\> $installationQueue.InstallationQueue Index Certificate ----- ----------- 1 -----BEGIN CERTIFICATE-----... 2 -----BEGIN CERTIFICATE-----...</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $installationQueue = Get-HPEBIOSTLSCertificateInstallationQueue -Connection $connection PS C:\> $installationQueue[0].InstallationQueue Index Certificate ----- ----------- 1 -----BEGIN CERTIFICATE-----... 2 -----BEGIN CERTIFICATE-----... PS C:\> $installationQueue[1].InstallationQueue Index Certificate ----- ----------- 1 -----BEGIN CERTIFICATE-----...</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Uninstall-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificateUninstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEBIOSTLSCertificateInstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEBIOSTLSCertificateUninstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSTLSCertificateUninstallationQueue</command:name> <maml:description> <maml:para>The Get-HPEBIOSTLSCertificateUninstallationQueue cmdlet gets the BIOS list of certificates in the uninstallation queue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSTLSCertificateUninstallationQueue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSTLSCertificateUninstallationQueue cmdlet gets the BIOS list of certificates in the uninstallation queue as follows:</maml:para> <maml:para>· UninstallationQueue (only available on Gen10 servers) - Gets the current list of certificates in the uninstallation queue.</maml:para> <maml:para>Note: Use the Clear-HPEBIOSTLSCertificateUninstallationQueue cmdlet to clear the uninstallation queue.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSTLSCertificateUninstallationQueue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $uninstallationQueue = $connection | Get-HPEBIOSTLSCertificateUninstallationQueue PS C:\> $uninstallationQueue.UninstallationQueue Index FingerPrint ----- ----------- 1 5C:9A:5C:D3:62:64:CB:ED:00:75:44:08:23:09:50:2D:0B:D1:38:1A:C3:F8:B7:FB:B3:EE:31:2F:1D:03:77:16 2 C4:C3:7C:41:B7:33:33:43:F8:B2:63:EC:DB:16:13:DA:54:F8:70:29:6A:87:21:D3:DC:4D:9A:50:DC:03:4C:F3</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $uninstallationQueue = Get-HPEBIOSTLSCertificateUninstallationQueue -Connection $connection PS C:\> $uninstallationQueue[0].UninstallationQueue Index FingerPrint ----- ----------- 1 5C:9A:5C:D3:62:64:CB:ED:00:75:44:08:23:09:50:2D:0B:D1:38:1A:C3:F8:B7:FB:B3:EE:31:2F:1D:03:77:16 2 C4:C3:7C:41:B7:33:33:43:F8:B2:63:EC:DB:16:13:DA:54:F8:70:29:6A:87:21:D3:DC:4D:9A:50:DC:03:4C:F3 PS C:\> $uninstallationQueue[1].UninstallationQueue Index FingerPrint ----- ----------- 1 20:E3:47:31:5A:7A:E3:E7:AA:2F:A1:8F:57:CA:14:6F:8B:B0:AA:40:8C:85:83:05:8C:66:E8:87:C0:17:68:B6</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Uninstall-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificateInstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEBIOSTLSCertificateInstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEBIOSTLSCertificateUninstallationQueue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSTLSConfiguration</command:name> <maml:description> <maml:para>The Get-HPEBIOSTLSConfiguration cmdlet gets the BIOS Transport Layer Security (TLS) configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSTLSConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSTLSConfiguration cmdlet gets the BIOS Transport Layer Security (TLS) configuration as follows:</maml:para> <maml:para>· Cipher (only available on Gen10 servers) - Gets the list of encryption used.</maml:para> <maml:para>· HostnameCheck (only available on Gen10 servers) - Gets the current hostname check setting in the certificate supplied by the server.</maml:para> <maml:para>· VerifyMode (only available on Gen10 servers) - Gets the certificates verification mode setting.</maml:para> <maml:para>· ProtocolVersion (only available on Gen10 servers) - Gets the protocol version setting used for TLS connection.</maml:para> <maml:para>· TLSCertificateCount (only available on Gen10 servers) - Gets the TLS CA certificate count (This is a read only attribute).</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSTLSConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSTLSConfiguration | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK Cipher : {AES128-SHA, AES256-SHA, AES128-SHA256, AES256-SHA256...} HostnameCheck : Disabled VerifyMode : Peer ProtocolVersion : Auto TLSCertificateCount : 0</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSTLSConfiguration -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK Cipher : {AES128-SHA, AES256-SHA, AES128-SHA256, AES256-SHA256...} HostnameCheck : Disabled VerifyMode : Peer ProtocolVersion : Auto TLSCertificateCount : 0 IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK Cipher : {AES128-SHA, AES256-SHA, AES128-SHA256, AES256-SHA256...} HostnameCheck : Enabled VerifyMode : Peer ProtocolVersion : 1.2 TLSCertificateCount : 1</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSTLSConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSTPMChipInfo</command:name> <maml:description> <maml:para>The Get-HPEBIOSTPMChipInfo cmdlet gets the TPM (Trusted Platform Module) information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSTPMChipInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSTPMChipInfo cmdlet gets the TPM (Trusted Platform Module) information as follows:</maml:para> <maml:para>· TPMType - Gets the current installed TPM type; either TPM 1.2, TPM 2.0, or TM 1.0.</maml:para> <maml:para>· TPMState - Gets the current TPM state; present or not present.</maml:para> <maml:para>· TPMFIPSMode (only available on Gen10 servers) - Gets the current TPM FIPS (Federal Information Processing Standard) status.</maml:para> <maml:para>· TPM20ActivePCR (only available on Gen10 servers) - Gets the current TPM 2.0 PCR (Platform Configuration Registers) configuration.</maml:para> <maml:para>· TPM20SoftwareInterfaceStatus (only available on Gen10 servers) - Gets the current status of the TPM 2.0 software interface.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSTPMChipInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSTPMChipInfo | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK TPMType : TPM20 TPMState : PresentAndEnabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSTPMChipInfo | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK TPMType : TPM20 TPMState : PresentAndEnabled TPMFIPSMode : FIPSMode TPM20ActivePCR : SHA256 TPM20SoftwareInterfaceStatus : FIFOInterface</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSTPMChipInfo -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK TPMType : NoTPM TPMState : NotPresent</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 or Gen10 server with connection object 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-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3,10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSTPMChipInfo -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK TPMType : TPM12 TPMState : PresentAndDisabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK TPMType : NoTPM TPMState : NotPresent IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK TPMType : TPM12 TPMState : PresentAndDisabled TPMFIPSMode : Non-FIPSMode TPM20ActivePCR : NotSpecified TPM20SoftwareInterfaceStatus : CRBInterface IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK TPMType : NoTPM TPMState : NotPresent</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTPMConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSTPMConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSTPMConfiguration</command:name> <maml:description> <maml:para>The Get-HPEBIOSTPMConfiguration cmdlet gets the TPM (Trusted Platform Module) configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSTPMConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSTPMConfiguration cmdlet gets the TPM (Trusted Platform Module) configurations as follows:</maml:para> <maml:para>· TPMChipsetFeatureType (only available on Gen10 with Intel processor servers) - Specifies the TPM chipset feature type.</maml:para> <maml:para>· TPMChipset (only available on Gen10 with Intel processor servers) - Specifies the TPM chipset state, whether it is enabled or disabled.</maml:para> <maml:para>· TPMChipID (only available on Gen10 servers) - Specifies the TPM chipset ID.</maml:para> <maml:para>· TM10Operation (only available on Gen9 servers) - Specifies the operational state of TM 1.0.</maml:para> <maml:para>· TPM12Operation (available on Gen9 and Gen10 servers) - Specifies the operational state of TPM 1.2.</maml:para> <maml:para>· TPM20Operation (available on Gen9 and Gen10 servers) - Specifies the operational state of TPM 2.0.</maml:para> <maml:para>· TM10Visibility (only available on Gen9 servers) - Specifies whether TM 1.0 is visible or hidden from the operating system.</maml:para> <maml:para>· TPMVisibility - Specifies whether TPM 1.2 or TPM 2.0 is visible or hidden from the operating system.</maml:para> <maml:para>· TPM20Visibility (only available on Gen9 servers) - Specifies whether TM 2.0 is visible or hidden from the operating system.</maml:para> <maml:para>· TPMBinding (only available on Gen9 servers) - Specifies whether data is encrypted using a TPM bind key.</maml:para> <maml:para>· TPMUEFIOptionROMMeasurement (available on Gen9 and Gen10 servers) - Specifies whether the BIOS will measure the PCI or PCIe expansion ROM code and store that measurement in the TPM.</maml:para> <maml:para>· TPM20PhysicalPresence (only available on Gen9 servers) - Specifies the TPM 2.0 physical presence interface state.</maml:para> <maml:para>· TPMModeSwitchOperation (only available on Gen10 servers) - Specifies the TPM switch mode between TPM 1.0 and TPM 2.0.</maml:para> <maml:para>· TPM20SoftwareInterfaceOperation (only available on Gen10 servers) - Specifies the TPM 2.0 software interface configuration.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSTPMConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.PSObject[].</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title></maml:title> <maml:alert> <maml:para>• Use Get-HPEBIOSTPMChipInfo cmdlet for TPM chip availability information.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSTPMConfiguration | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK TPMFunctionality : Enabled TPMVisibility : Visible TPMExpansionROMMeasuring : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen8 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSTPMConfiguration | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK TPM20Operation : NoAction TPM20Visibility : Hidden TPMBinding : Disabled TPMUEFIOptionROMMeasurement : Enabled TPM20PhysicalPresence : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSTPMConfiguration -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK TPM20Operation : Clear TPMChipsetFeatureType : None TPMChipset : Disabled TPMChipID : None TPMModeSwitchOperation : NoAction TPM20SoftwareInterfaceOperation : NoAction TPMVisibility : Visible TPMUEFIOptionROMMeasurement : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with connection object 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-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSTPMConfiguration -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK TPMFunctionality : Disabled TPMVisibility : Visible TPMExpansionROMMeasuring : Disabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK TPM20Operation : NoAction TPM20Visibility : Hidden TPMBinding : Disabled TPMUEFIOptionROMMeasurement : Enabled TPM20PhysicalPresence : Disabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK TPM20Operation : Clear TPMChipsetFeatureType : PTT TPMChipset : Enabled TPMChipID : NationzTPM20 TPMModeSwitchOperation : TPM20 TPM20SoftwareInterfaceOperation : FIFOInterface TPMVisibility : Visible TPMUEFIOptionROMMeasurement : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen8, Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTPMChipInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSTPMConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUEFIBootOrder</command:name> <maml:description> <maml:para>The Get-HPEBIOSUEFIBootOrder cmdlet gets the current advanced UEFI Boot Order list.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSUEFIBootOrder</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSUEFIBootOrder cmdlet gets the current advanced UEFI Boot Order list as follows:</maml:para> <maml:para>· UEFIBootOrder - Gets the current UEFI Boot Order list.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSUEFIBootOrder</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $bootOrderList = $connection | Get-HPEBIOSUEFIBootOrder PS C:\> $bootOrderList.UEFIBootOrder Index DeviceName ----- ---------- 1 Generic USB Boot 2 Embedded RAID 1 : Smart Array P830i Controller - 931.48 GiB, RAID 0 Logical Drive(Target:0, Lun:0) 3 Embedded FlexibleLOM 1 Port 1 : HP Ethernet 1Gb 4-port 331FLR Adapter - NIC (PXE IPv4) 4 Embedded FlexibleLOM 1 Port 1 : HP Ethernet 1Gb 4-port 331FLR Adapter - NIC (PXE IPv6)</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $bootOrderList = Get-HPEBIOSUEFIBootOrder -Connection $connection PS C:\> $bootOrderList.UEFIBootOrder Index DeviceName ----- ---------- 1 Generic USB Boot 2 Embedded FlexibleLOM 1 Port 2 : HP FlexFabric 10Gb 2-port 536FLB Adapter - NIC (HTTP(S) IPv4) 3 Embedded FlexibleLOM 1 Port 2 : HP FlexFabric 10Gb 2-port 536FLB Adapter - NIC (PXE IPv4) 4 Embedded FlexibleLOM 1 Port 2 : HP FlexFabric 10Gb 2-port 536FLB Adapter - NIC (HTTP(S) IPv6)</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $bootOrderList = Get-HPEBIOSUEFIBootOrder -Connection $connection PS C:\> $bootOrderList[0].UEFIBootOrder Index DeviceName ----- ---------- 1 Embedded SATA Port 10 CD/DVD ROM : hp DVDRAM GUB0N 2 Generic USB Boot 3 Embedded RAID 1 : Smart Array P440ar Controller - 1117.78 GiB, RAID 1 Logical Drive(Target:0, Lun:0) 4 Embedded FlexibleLOM 1 Port 1 : HP FlexFabric 10Gb 2-port 533FLR-T Adapter - NIC (PXE IPv4) 5 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv4) 6 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv6) 7 Embedded FlexibleLOM 1 Port 1 : HP FlexFabric 10Gb 2-port 533FLR-T Adapter - NIC (PXE IPv6) 8 Slot 6 Port 1 : HP Ethernet 1Gb 2-port 361T Adapter - NIC (PXE IPv4) 9 Slot 6 Port 1 : HP Ethernet 1Gb 2-port 361T Adapter - NIC (PXE IPv6) PS C:\> $bootOrderList[1].UEFIBootOrder Index DeviceName ----- ---------- 1 Generic USB Boot 2 Internal SD Card 1 : Generic USB3.0-CRW 3 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv4) 4 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (HTTP(S) IPv4) 5 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (HTTP(S) IPv6) 6 Embedded RAID 1 : HPE P450ar - Logical Drives 0 HBA Drives 1</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSUEFIBootOrder</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUEFIDevicePriority</command:name> <maml:description> <maml:para>The Get-HPEBIOSUEFIDevicePriority cmdlet gets the BIOS UEFI device priority.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSUEFIDevicePriority</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSUEFIDevicePriority cmdlet obtains the BIOS UEFI device priority as follows:</maml:para> <maml:para>· DevicePriorityList - Gets the UEFI device priority list.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSUEFIDevicePriority</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $devicePriority = $connection | Get-HPEBIOSUEFIDevicePriority PS C:\> $devicePriority | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK DevicePriorityList : {FloppyDrives, OpticalDrives, USBMassStorageDevices, EmbeddedStorageControllers...} PS C:\> $devicePriority.DevicePriorityList FloppyDrives OpticalDrives USBMassStorageDevices EmbeddedStorageControllers AddInStorageControllers EmbeddedFlexibleNetwork AddInNetworkControllers EmbeddedUEFIShell</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $devicePriority = Get-HPEBIOSUEFIDevicePriority -Connection $connection PS C:\> $devicePriority | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK DevicePriorityList : {FloppyDrives, OpticalDrives, USBMassStorageDevices, EmbeddedStorageControllers...} IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK DevicePriorityList : {FloppyDrives, OpticalDrives, USBMassStorageDevices, EmbeddedStorageControllers...} PS C:\> $devicePriority[0].DevicePriorityList FloppyDrives OpticalDrives USBMassStorageDevices EmbeddedStorageControllers AddInStorageControllers EmbeddedFlexibleNetwork AddInNetworkControllers EmbeddedUEFIShell PS C:\> $devicePriority[1].DevicePriorityList FloppyDrives OpticalDrives USBMassStorageDevices EmbeddedStorageControllers AddInStorageControllers EmbeddedFlexibleNetwork AddInNetworkControllers EmbeddedUEFIShell</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUEFIOptimizedBoot</command:name> <maml:description> <maml:para>The Get-HPEBIOSUEFIOptimizedBoot cmdlet gets the BIOS UEFI Optimized Boot configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSUEFIOptimizedBoot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSUEFIOptimizedBoot cmdlet gets the BIOS UEFI Optimized Boot configuration as follows:</maml:para> <maml:para>· UEFIOptizedBoot - Gets the current configuration of the UEFI Optimized Boot state.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSUEFIOptimizedBoot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSUEFIOptimizedBoot | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK UEFIOptimizedBoot : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSUEFIOptimizedBoot -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK UEFIOptimizedBoot : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSUEFIOptimizedBoot -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK UEFIOptimizedBoot : Enabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK UEFIOptimizedBoot : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSUEFIOptimizedBoot</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUPILinkPower</command:name> <maml:description> <maml:para>The Get-HPEBIOSUPILinkPower cmdlet gets the current Intel UPI link power configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSUPILinkPower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSUPILinkPower cmdlet gets the current Intel UPI link power configuration as follows:</maml:para> <maml:para>· IntelDirectToUPI (only available on Gen10 with Intel processor servers) - Gets the status of the Intel direct to UPI (D2K).</maml:para> <maml:para>· IntelUPILinkEnablement (only available on Gen10 with Intel processor servers) - Gets the status of the Intel UPI topology link settings between processors.</maml:para> <maml:para>· IntelUPILinkFrequency (only available on Gen10 with Intel processor servers) - Gets the status of the Intel UPI link frequency settings,</maml:para> <maml:para>· IntelUPILinkPowerManagement (only available on Gen10 with Intel processor servers) - Get the status of the Intel UPI link power management settings.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSUPILinkPower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSUPILinkPower | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK IntelDirectToUPI : Auto IntelUPILinkEnablement : Auto IntelUPILinkFrequency : Auto IntelUPILinkPowerManagement : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSUPILinkPower -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK IntelDirectToUPI : Enabled IntelUPILinkEnablement : Auto IntelUPILinkFrequency : Auto IntelUPILinkPowerManagement : Enabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK IntelDirectToUPI : Disabled IntelUPILinkEnablement : SingleLink IntelUPILinkFrequency : MinUPISpeed IntelUPILinkPowerManagement : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSUPILinkPower</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUSBOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSUSBOption cmdlet gets the BIOS USB (Universal Serial Bus) options.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSUSBOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSUSBOption cmdlet gets the BIOS USB (Universal Serial Bus) options as follows:</maml:para> <maml:para>· USBControl - Gets current status of USB ports and embedded devices operated at startup.</maml:para> <maml:para>· USBBootSupport - Gets current status of the system USB boot.</maml:para> <maml:para>· USB3Mode (only available on Gen9 servers) - Gets current status of the system USB 3.0 capable mode.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSUSBOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSUSBOption | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK USBControl : ExternalUSBPortDisabled USBBootSupport : Enabled USB3Mode : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSUSBOption -Connection $connection | fl IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK USBControl : InternalUSBPortDisabled USBBootSupport : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3,10.20.30.4 -Username admin -Password admin123 PS C:\> Get-HPEBIOSUSBOption -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK USBControl : USBDisabled USBBootSupport : Enabled USB3Mode : Auto IP : 10.20.30.4 Hostname : abc4.domain.com Status : OK USBControl : USBEnabled USBBootSupport : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSUSBOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUserDefaultState</command:name> <maml:description> <maml:para>The Get-HPEBIOSUserDefaultState cmdlet gets the BIOS user default state.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSUserDefaultState</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSUserDefaultState cmdlet gets the BIOS user default state as follows:</maml:para> <maml:para>· UserDefaultState (only available on Gen10 servers) - Gets the current user default state of the system, whether user default settings are enabled or disabled.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSUserDefaultState</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSUserDefaultState | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK UserDefaultState : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSUserDefaultState -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK UserDefaultState : Enabled IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK UserDefaultState : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUtilityLanguage</command:name> <maml:description> <maml:para>The Get-HPEBIOSUtilityLanguage cmdlet gets the BIOS system utility language.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSUtilityLanguage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSUtilityLanguage cmdlet gets the BIOS system utility language as follows:</maml:para> <maml:para>· Language (available on Gen9 and Gen10 servers) - Gets the current language settings of the BIOS.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSUtilityLanguage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSUtilityLanguage | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK Language : English</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSUtilityLanguage -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK Language : English IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK Language : Japanese IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK Language : Chinese</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSUtilityLanguage</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSVideoOption</command:name> <maml:description> <maml:para>The Get-HPEBIOSVideoOption cmdlet gets the BIOS video configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSVideoOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSVideoOption cmdlet gets the BIOS video configuration as follows:</maml:para> <maml:para>· EmbeddedVideoConnection (available on Gen9 and Gen10 servers) - Gets the current configuration of Embedded Video Connection.</maml:para> <maml:para>· VideoOption - Gets the current configuration of the Video Option that controls the video display.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSVideoOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSVideoOption | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK VideoOption : AddInVideoEnabledEmbeddedVideoDisabled EmbeddedVideoConnection : Auto</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSVideoOption -Connection $connection | | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK VideoOption : BothAddInAndEmbeddedVideoEnabled EmbeddedVideoConnection : AlwaysDisabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSVideoOption -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK VideoOption : EmbeddedVideoPrimaryOptionalVideoSecondary IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK VideoOption : BothAddInAndEmbeddedVideoEnabled EmbeddedVideoConnection : AlwaysEnabled IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK VideoOption : AddInVideoEnabledEmbeddedVideoDisabled EmbeddedVideoConnection : Auto</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSVideoOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSVirtualization</command:name> <maml:description> <maml:para>The Get-HPEBIOSVirtualization cmdlet gets the hardware virtualization configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSVirtualization</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSVirtualization cmdlet gets the hardware virtualization configurations as follows:</maml:para> <maml:para>· AMD_Vi_IOMMU (available on Gen10 with AMD processor servers) - Gets the current configuration of AMD I/O Memory Management Unit.</maml:para> <maml:para>· CPUVirtualization - Gets the current CPU virtualization configuration.</maml:para> <maml:para>· Intel_VT_d2 (available on Gen9 and Gen10 with Intel processor servers) - Gets the current configuration of Intel Virtualization Technology for Directed I/O.</maml:para> <maml:para>· MinimumSEV_ASID (only available on Gen10 Plus AMD processor servers) - Gets the number of AMD Secure Encrypted Virtualization (SEV) address space identifiers (ASID).</maml:para> <maml:para>· SR_IOV - Gets the current configuration of single root I/O virtualization.</maml:para> <maml:para>· AccessControlService (only available on Gen10 Plus AMD processor servers) - Gets the current configuration of Access Control Service for the downstream port.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSVirtualization</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSVirtualization | fl IP : 10.20.30.2 Hostname : abc2.domain.com SR_IOV : Enabled CPUVirtualization : Disabled AMD_Vi_IOMMU : Enabled MinimumSEV_ASID : 10</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 AMD server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSVirtualization -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK SR_IOV : Enabled CPUVirtualization : Enabled Intel_VT_d2 : Enabled</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 or Gen10 Intel server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3,10.20.30.4,10.20.30.5 -Username admin -Password admin123 PS C:\> Get-HPEBIOSVirtualization -Connection $connection | fl IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK SR_IOV : Enabled CPUVirtualization : Disabled Intel_VT_d2 : Disabled IP : 10.20.30.4 Hostname : abc4.domain.com SR_IOV : Disabled CPUVirtualization : Enabled AMD_Vi_IOMMU : Disabled MinimumSEV_ASID : 5 AccessControlService : Enabled IP : 10.20.30.5 Hostname : abc5.domain.com Status : OK SR_IOV : Enabled CPUVirtualization : Enabled Intel_VT_d2 : Disabled</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9, Gen10 AMD, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSVirtualization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSVLANConfiguration</command:name> <maml:description> <maml:para>The Get-HPEBIOSVLANConfiguration cmdlet gets the global VLAN configuration for all enabled network interfaces.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSVLANConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSVLANConfiguration cmdlet gets the global VLAN configuration for all enabled network interfaces as follows:</maml:para> <maml:para>· VLANControl - Gets the status of the VLAN control settings.</maml:para> <maml:para>· VLANID - Gets the numeric VLANID.</maml:para> <maml:para>· VLANPriority - Gets the priority level of the VLAN.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSVLANConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSVLANConfiguration | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK VLANControl : Enabled VLANID : 100 VLANPriority : 5</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSVLANConfiguration -Connection $connection | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK VLANControl : Disabled VLANID : 0 VLANPriority : 0</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Get-HPEBIOSVLANConfiguration -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK VLANControl : Enabled VLANID : 4000 VLANPriority : 1 IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK VLANControl : Disabled VLANID : 0 VLANPriority : 0</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSVLANConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSWorkloadProfile</command:name> <maml:description> <maml:para>The Get-HPEBIOSWorkloadProfile cmdlet gets the BIOS workload profile configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>HPEBIOSWorkloadProfile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-HPEBIOSWorkloadProfile cmdlet gets the BIOS workload profile configuration as follows:</maml:para> <maml:para>· WorkloadProfile (only available on Gen10 servers) - Gets the current workload profile setting.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-HPEBIOSWorkloadProfile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>OutputType</maml:name> <maml:description> <maml:para>Specifies the type of required output. Possible values are RawText and PSObject. Default value is PSObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PSObject</command:parameterValue> <command:parameterValue required="false" variableLength="false">RawText</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PSObject</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[] or System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Returns System.String[] when OutputType is RawText; Otherwise System.Management.Automation.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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Get-HPEBIOSWorkloadProfile | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK WorkloadProfile : GeneralPowerEfficientCompute</dev:code> <dev:remarks> <maml:para>This example shows the output on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Get-HPEBIOSWorkloadProfile -Connection $connection | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : OK WorkloadProfile : GeneralPowerEfficientCompute IP : 10.20.30.2 Hostname : abc2.domain.com Status : OK WorkloadProfile : MissionCritical IP : 10.20.30.3 Hostname : abc3.domain.com Status : OK WorkloadProfile : Custom</dev:code> <dev:remarks> <maml:para>This example shows the output on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSWorkloadProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Install-HPEBIOSTLSCertificate</command:name> <maml:description> <maml:para>The Install-HPEBIOSTLSCertificate cmdlet installs the certificate for the TLS HTTPS connection in the installation queue.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Install</command:verb> <command:noun>HPEBIOSTLSCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Install-HPEBIOSTLSCertificate cmdlet installs the certificate for the TLS HTTPS connection in the installation queue. This cmdlet supports only on Gen10 servers. This cmdlet has the following parameter:</maml:para> <maml:para>· Certificate (only available on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Install-HPEBIOSTLSCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>Certificate</maml:name> <maml:description> <maml:para>Specifies the certificate in Base64 encoded PER format to install it in the installation queue. The certificate in the installation queue is installed only when you reboot the server. Use the Get-Content cmdlet to get the certificate raw text. Use the Get-HPEBIOSTLSCertificateInstallationQueue cmdlet to get the list of certificates in 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>Certificate</maml:name> <maml:description> <maml:para>Specifies the certificate in Base64 encoded PER format to install it in the installation queue. The certificate in the installation queue is installed only when you reboot the server. Use the Get-Content cmdlet to get the certificate raw text. Use the Get-HPEBIOSTLSCertificateInstallationQueue cmdlet to get the list of certificates in 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $cert = Get-Content -raw C:\TestFolder\hpe.cer PS C:\> $connection | Install-HPEBIOSTLSCertificate -Certificate $cert</dev:code> <dev:remarks> <maml:para>This example installs the TLS certificate on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $cert = Get-Content -raw C:\TestFolder\hpe.cer PS C:\> Install-HPEBIOSTLSCertificate -Connection $connection -Certificate $cert</dev:code> <dev:remarks> <maml:para>This example installs TLS certificate on a Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Uninstall-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSiSCSIBootAttempt</command:name> <maml:description> <maml:para>The Remove-HPEBIOSiSCSIBootAttempt cmdlet deletes an existing BIOS iSCSI boot attempt in the iSCSI source array.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>HPEBIOSiSCSIBootAttempt</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-HPEBIOSiSCSIBootAttempt cmdlet deletes an existing BIOS iSCSI boot attempt in the iSCSI source array. This cmdlet supports only on Gen9 and Gen10 servers. This cmdlet has the following parameter:</maml:para> <maml:para>· iSCSIBootAttemptIndex</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-HPEBIOSiSCSIBootAttempt</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>iSCSIBootAttemptIndex</maml:name> <maml:description> <maml:para>Use this option to delete one or more existing iSCSI boot attempt in the iSCSI source array. if you want to delete more than one iSCSI boot attempt, enter the index value with comma separated delimiter. Example: 1,3.</maml:para> <maml:para>You cannot delete the unused boot attempt index in the iSCSI source 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>iSCSIBootAttemptIndex</maml:name> <maml:description> <maml:para>Use this option to delete one or more existing iSCSI boot attempt in the iSCSI source array. if you want to delete more than one iSCSI boot attempt, enter the index value with comma separated delimiter. Example: 1,3.</maml:para> <maml:para>You cannot delete the unused boot attempt index in the iSCSI source 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Remove-HPEBIOSiSCSIBootAttempt -iSCSIBootAttemptIndex "1,3"</dev:code> <dev:remarks> <maml:para>This example deletes the iSCSI boot attempt at index 1 and 3 in iSCSI source array on a Gen9, or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Remove-HPEBIOSiSCSIBootAttempt -Connection $connection -iSCSIBootAttemptIndex 2</dev:code> <dev:remarks> <maml:para>This example deletes the iSCSI boot attempt at index 2 in the iSCSI source array on a Gen9 or Gen10 server with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSiSCSIBootAttempt</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-HPEBIOSiSCSIBootAttempt</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Edit-HPEBIOSiSCSIBootAttempt</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdminPassword</command:name> <maml:description> <maml:para>The Reset-HPEBIOSAdminPassword cmdlet clears the BIOS Administrator Password.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>HPEBIOSAdminPassword</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Reset-HPEBIOSAdminPassword cmdlet clears the BIOS Administrator Password. Once the password is reset, the BIOS configuration can be changed without an administrator password. This cmdlet is supported only on Gen9 and Gen10 servers. This cmdlet has the following parameters.</maml:para> <maml:para>· AdminPassword (available on Gen9 and Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Reset-HPEBIOSAdminPassword</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AdminPassword</maml:name> <maml:description> <maml:para>Specifies the current Administrator Password. The maximum password length is 31 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AdminPassword</maml:name> <maml:description> <maml:para>Specifies the current Administrator Password. The maximum password length is 31 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[]</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>· Rebooting the server is strongly recommended to apply password changes in BIOS. · For Gen9 servers, there is no mechanism to check whether the entered admin password is correct.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Reset-HPEBIOSAdminPassword -AdminPassword test123 | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.}</dev:code> <dev:remarks> <maml:para>The BIOS administrator password is already set. This example shows how to reset the BIOS administrator password on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Reset-HPEBIOSAdminPassword -Connection $connection -AdminPassword test123,admin123 | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.} IP : 10.20.30.2 Hostname : abc2.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.}</dev:code> <dev:remarks> <maml:para>The BIOS administrator password is already set. This example resets the BIOS administrator password on Gen9 and Gen10 servers with the connection object passed through 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSAdminPassword</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSDefaultManufacturingSetting</command:name> <maml:description> <maml:para>The Reset-HPEBIOSDefaultManufacturingSetting cmdlet 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>HPEBIOSDefaultManufacturingSetting</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Reset-HPEBIOSDefaultManufacturingSetting 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 previously made changes may be lost. Immediate restart of the server is required to make this effective in BIOS configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· ResetDefaultManufacturingSetting (available on Gen9 and Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Reset-HPEBIOSDefaultManufacturingSetting</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResetDefaultManufacturingSetting</maml:name> <maml:description> <maml:para>Resets all BIOS configuration settings to the factory default settings when the switch parameter is provided. Without the switch parameter, the restore default manufacturing setting will be set to No or Cancel.</maml:para> </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" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResetDefaultManufacturingSetting</maml:name> <maml:description> <maml:para>Resets all BIOS configuration settings to the factory default settings when the switch parameter is provided. Without the switch parameter, the restore default manufacturing setting will be set to No or Cancel.</maml:para> </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>HPE.BIOS.Connection[]</maml:name> <maml:uri></maml: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 or System.Management.Automation.PSObject[]</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 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 difference between this cmdlet and the Reset-HPEBIOSUserDefault cmdlet is that Reset-HPEBIOSDefaultManufacturingSetting erases all UEFI variables. An OS can write UEFI variables that store things like entries in the boot order and key database information for Secure Boot. Reset-HPEBIOSDefaultManufacturingSetting cmdlet clears this information, whereas it is retained when using the Reset-HPEBIOSUserDefault 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Reset-HPEBIOSDefaultManufacturingSetting -ResetDefaultManufacturingSetting</dev:code> <dev:remarks> <maml:para>This example resets the BIOS configuration to factory settings on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Reset-HPEBIOSDefaultManufacturingSetting -Connection $connection -ResetDefaultManufacturingSetting</dev:code> <dev:remarks> <maml:para>This example resets the BIOS configuration to factory settings on Gen 9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPowerOnPassword</command:name> <maml:description> <maml:para>The Reset-HPEBIOSPowerOnPassword cmdlet clears the BIOS Power On Password.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>HPEBIOSPowerOnPassword</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Reset-HPEBIOSPowerOnPassword cmdlet clears the Power On Password. Once the password is reset, the server is accessible during the boot process without a password. This cmdlet is supported only on Gen9 and Gen10 servers. This cmdlet has the following parameters.</maml:para> <maml:para>· PowerOnPassword (available on Gen9 and Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Reset-HPEBIOSPowerOnPassword</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PowerOnPassword</maml:name> <maml:description> <maml:para>Specifies the current Power On Password. The maximum password length is 31 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PowerOnPassword</maml:name> <maml:description> <maml:para>Specifies the current Power On Password. The maximum password length is 31 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[]</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>· Rebooting the server is strongly recommended to apply password changes in BIOS. · For Gen9 servers, there is no mechanism to check whether the entered power on password is correct.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Reset-HPEBIOSPowerOnPassword -PowerOnPassword test123 | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.}</dev:code> <dev:remarks> <maml:para>The BIOS power on password is already set. This example shows how to reset the BIOS power on password on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Reset-HPEBIOSPowerOnPassword -Connection $connection -PowerOnPassword test123,admin123 | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.} IP : 10.20.30.2 Hostname : abc2.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.}</dev:code> <dev:remarks> <maml:para>The BIOS power on password is already set. This example resets the BIOS power on password on Gen9 and Gen10 servers with the connection object passed through 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSPowerOnPassword</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUserDefault</command:name> <maml:description> <maml:para>The Reset-HPEBIOSUserDefault cmdlet resets all BIOS configuration settings to saved user or factory default settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>HPEBIOSUserDefault</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Reset-HPEBIOSUserDefault cmdlet resets all BIOS configuration settings to the saved user default settings if they are available. Otherwise, it will reset to factory default settings. This cmdlet will reset all platform settings except Secure Boot BIOS settings, Date and Time settings, and Primary and Redundant ROM Selection (if supported). The user can save a custom default configuration to use during a system restore. Any modifications might be lost. Immediate restart of the server is required to make this effective in BIOS configuration. This cmdlet is supported only on Gen9 and Gen10 servers. This cmdlet has the following parameters.</maml:para> <maml:para>· RestoreDefault</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Reset-HPEBIOSUserDefault</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RestoreDefault</maml:name> <maml:description> <maml:para>Resets all BIOS configuration settings to the saved user or factory default settings when the switch parameter is provided. Without the switch parameter, restore user default will be set to No or Cancel.</maml:para> </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" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RestoreDefault</maml:name> <maml:description> <maml:para>Resets all BIOS configuration settings to the saved user or factory default settings when the switch parameter is provided. Without the switch parameter, restore user default will be set to No or Cancel.</maml:para> </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>HPE.BIOS.Connection[]</maml:name> <maml:uri></maml: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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Reset-HPEBIOSUserDefault -RestoreDefault</dev:code> <dev:remarks> <maml:para>This example resets the UserDefaults on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Reset-HPEBIOSUserDefault –Connection $connection -RestoreDefault</dev:code> <dev:remarks> <maml:para>This example resets the UserDefaults on Gen 9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-HPEBIOSUserDefault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEBIOSUserDefault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSACPI_SLIT</command:name> <maml:description> <maml:para>The Set-HPEBIOSACPI_SLIT cmdlet configures BIOS ACPI SLIT preference.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSACPI_SLIT</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSACPI_SLIT cmdlet sets the BIOS ACPI SLIT preference. This cmdlet has the following parameters.</maml:para> <maml:para>· SystemLocalityInformationTable</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSACPI_SLIT</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>SystemLocalityInformationTable</maml:name> <maml:description> <maml:para>Describes the relative access times between processors, memory subsystems, and I/O subsystems. Operating systems that support the SLIT can use this information to improve performance by allocating resources and workloads more efficiently. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>SystemLocalityInformationTable</maml:name> <maml:description> <maml:para>Describes the relative access times between processors, memory subsystems, and I/O subsystems. Operating systems that support the SLIT can use this information to improve performance by allocating resources and workloads more efficiently. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSACPI_SLIT -SystemLocalityInformationTable Disabled | fl</dev:code> <dev:remarks> <maml:para>This example sets the SystemLocalityInformationTable to the specified value on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSACPI_SLIT -Connection $connection -SystemLocalityInformationTable Enabled | fl</dev:code> <dev:remarks> <maml:para>This example sets the SystemLocalityInformationTable to the specified value on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSACPI_SLIT -Connection $connection -SystemLocalityInformationTable Enabled,Disabled,Enabled | fl</dev:code> <dev:remarks> <maml:para>This example sets the SystemLocalityInformationTable to the specified values on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSACPI_SLIT</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdminInfo</command:name> <maml:description> <maml:para>The Set-HPEBIOSAdminInfo cmdlet sets the contact information for the server administrator.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSAdminInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSAdminInfo cmdlet sets the contact information for the server administrator. This cmdlet has the following parameters.</maml:para> <maml:para>· AdminName</maml:para> <maml:para>· AdminPhoneNumber</maml:para> <maml:para>· AdminOtherInfo</maml:para> <maml:para>· AdminEmailAddress</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSAdminInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AdminName</maml:name> <maml:description> <maml:para>Defines the server administrator name. The valid length is 0 to 28.</maml:para> </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>AdminOtherInfo</maml:name> <maml:description> <maml:para>Defines additional text relating to the server administrator. The valid length is 0 to 28.</maml:para> </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>AdminPhoneNumber</maml:name> <maml:description> <maml:para>Defines the server administrator phone number. The valid length is 0 to 28.</maml:para> </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>AdminEmailAddress</maml:name> <maml:description> <maml:para>Defines the server administrator email address. The valid length is 0 to 28.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AdminName</maml:name> <maml:description> <maml:para>Defines the server administrator name. The valid length is 0 to 28.</maml:para> </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>AdminOtherInfo</maml:name> <maml:description> <maml:para>Defines additional text relating to the server administrator. The valid length is 0 to 28.</maml:para> </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>AdminPhoneNumber</maml:name> <maml:description> <maml:para>Defines the server administrator phone number. The valid length is 0 to 28.</maml:para> </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>AdminEmailAddress</maml:name> <maml:description> <maml:para>Defines the server administrator email address. The valid length is 0 to 28.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $Connection | Set-HPEBIOSAdminInfo -AdminName 'HPE Admin' -AdminPhoneNumber 9999999999 -AdminOtherInfo 'HPE Gen9 server' -AdminEmailAddress xyz@hpe.com | fl</dev:code> <dev:remarks> <maml:para>This example sets AdminName, AdminPhoneNumber, AdminOtherInfo, and AdminEmailAddress to the specified values on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $Connection | Set-HPEBIOSAdminInfo -AdminName 'HPE Admin' -AdminPhoneNumber 9988800000 -AdminOtherInfo 'HPE Server' -AdminEmailAddress xyz@hpe.com | fl</dev:code> <dev:remarks> <maml:para>This example sets AdminName, AdminPhoneNumber, AdminOtherInfo, and AdminEmailAddress to the specified values on a Gen10 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSAdminInfo -Connection $Connection -AdminName 'HPE Admin1','HPE Admin2' -AdminPhoneNumber 9999999999,9876543210 -AdminOtherInfo 'HPE Gen9 server','HPE Gen10 server' -AdminEmailAddress xyz1@hpe.com,xyz2@hpe.com | fl</dev:code> <dev:remarks> <maml:para>This example sets AdminName, AdminPhoneNumber, AdminOtherInfo, and AdminEmailAddress to the specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSAdminInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdminPassword</command:name> <maml:description> <maml:para>The Set-HPEBIOSAdminPassword cmdlet sets the BIOS Administrator Password.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSAdminPassword</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSAdminPassword cmdlet sets an Administrator password to protect the BIOS configuration. This cmdlet is supported only on Gen9 and Gen10 servers. This cmdlet has the following parameters.</maml:para> <maml:para>· OldAdminPassword</maml:para> <maml:para>· NewAdminPassword</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSAdminPassword</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>NewAdminPassword</maml:name> <maml:description> <maml:para>Specifies the new BIOS Administrator Password as input. The maximum password length is 31 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OldAdminPassword</maml:name> <maml:description> <maml:para>Specifies the current BIOS Administrator Password. It provides an empty string as input for OldAdminPassword when setting the BIOS Administrator Password for the first time. Otherwise, the current password is used as input for OldAdminPassword. The maximum password length is 31 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>NewAdminPassword</maml:name> <maml:description> <maml:para>Specifies the new BIOS Administrator Password as input. The maximum password length is 31 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OldAdminPassword</maml:name> <maml:description> <maml:para>Specifies the current BIOS Administrator Password. It provides an empty string as input for OldAdminPassword when setting the BIOS Administrator Password for the first time. Otherwise, the current password is used as input for OldAdminPassword. The maximum password length is 31 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[]</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>· Rebooting the server is strongly recommended to apply password changes in BIOS. · For Gen9, executing any write operation cmdlet requires a BIOS Administrator Password. A new parameter is added in Connect-HPEBIOS to accept the BIOS Administrator Password. Refer to Connect-HPEBIOS help for more details. · For Gen10 servers, a new mechanism will throw an error for an incorrect current admin password if the password is already set. · For Gen9 servers, there is no mechansim to authenicate whether the entered current admin password is correct.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSAdminPassword -OldAdminPassword "" -NewAdminPassword test123 | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.}</dev:code> <dev:remarks> <maml:para>The BIOS administrator password is not set. This example sets the BIOS administrator password for the first time on a Gen9 or Gen10 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>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSAdminPassword -OldAdminPassword test123 -NewAdminPassword test456 | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.}</dev:code> <dev:remarks> <maml:para>The BIOS administrator password is already set. This example shows how to modify or change the BIOS administrator password on a Gen9 or Gen10 server.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSAdminPassword -Connection $connection -OldAdminPassword test123,admin123 -NewAdminPassword test456,admin456 | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.} IP : 10.20.30.2 Hostname : abc2.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.}</dev:code> <dev:remarks> <maml:para>The BIOS administrator password is already set. This example shows how to modify or change the BIOS administrator password on Gen9 and Gen10 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-HPEBIOSAdminPassword</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdvancedDebugOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSAdvancedDebugOption cmdlet sets the BIOS advanced debug option.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSAdvancedDebugOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSAdvancedDebugOption cmdlet sets the BIOS advanced debug option.This cmdlet has the following parameters.</maml:para> <maml:para>. AdvancedCrashDumpMode (only available on Gen10 servers)</maml:para> <maml:para>. PostBootProgress (only available on Gen10 servers)</maml:para> <maml:para>. UEFISerialDebugMessageLevel (only available on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSAdvancedDebugOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AdvancedCrashDumpMode</maml:name> <maml:description> <maml:para>Use this option to enable the Advanced Crash Dump Mode. When enabled, the system will be configured to log additional debug information to the Active Health System logs when an unexpected system crash is experienced. This option should only be enabled when directed by qualified service personnel. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UEFISerialDebugMessageLevel</maml:name> <maml:description> <maml:para>Use this option to enable the UEFI Serial Debug output and verbosity level. Selecting Verbose can impact server boot time significantly. This option is only applicable in UEFI Mode. Possible values are Disabled, ErrorsOnly, Medium, Network, Verbose, and Custom.</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">ErrorsOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">Medium</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> </command:parameterValueGroup> <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>PostBootProgress</maml:name> <maml:description> <maml:para>Enables or Disables verbose boot progress messaging. This option displays additional debug information to the screen and serial console. It might be helpful in determining why a server became unresponsive during the boot process. Possible values are All, SerialOnly, 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">SerialOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AdvancedCrashDumpMode</maml:name> <maml:description> <maml:para>Use this option to enable the Advanced Crash Dump Mode. When enabled, the system will be configured to log additional debug information to the Active Health System logs when an unexpected system crash is experienced. This option should only be enabled when directed by qualified service personnel. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UEFISerialDebugMessageLevel</maml:name> <maml:description> <maml:para>Use this option to enable the UEFI Serial Debug output and verbosity level. Selecting Verbose can impact server boot time significantly. This option is only applicable in UEFI Mode. Possible values are Disabled, ErrorsOnly, Medium, Network, Verbose, and Custom.</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">ErrorsOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">Medium</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> </command:parameterValueGroup> <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>PostBootProgress</maml:name> <maml:description> <maml:para>Enables or Disables verbose boot progress messaging. This option displays additional debug information to the screen and serial console. It might be helpful in determining why a server became unresponsive during the boot process. Possible values are All, SerialOnly, 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">SerialOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[]</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 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-HPEBIOS 10.20.30.1 admin admin123 -DisableCertificateAuthentication PS C:\> $connection | Set-HPEBIOSAdvancedDebugOption -AdvancedCrashDumpMode Enabled -UEFISerialDebugMessageLevel ErrorsOnly -PostBootProgress All</dev:code> <dev:remarks> <maml:para>This example sets the advanced debug option to the specified value on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS 10.20.30.1,10.20.30.2 admin admin123 -DisableCertificateAuthentication PS C:\> Set-HPEBIOSAdvancedDebugOption -Connection $connection -AdvancedCrashDumpMode Enabled,Disabled -UEFISerialDebugMessageLevel Custom,ErrorsOnly -PostBootProgress All,SerialOnly</dev:code> <dev:remarks> <maml:para>This example sets the advanced debug option to the specified values on Gen10 servers with list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSAdvancedDebugOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdvancedMemoryProtection</command:name> <maml:description> <maml:para>The Set-HPEBIOSAdvancedMemoryProtection cmdlet sets the BIOS Advanced Memory Protection configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSAdvancedMemoryProtection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSAdvancedMemoryProtection cmdlet sets the BIOS Advanced Memory Protection configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· AdvancedMemoryProtection (available on Gen10 with Intel processors, and Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSAdvancedMemoryProtection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AdvancedMemoryProtection</maml:name> <maml:description> <maml:para>Provides additional memory protection beyond ECC (error checking and correcting). Advanced ECC provides the largest memory capacity to the operating system. Possible values are AdvancedECCSupport, FastFaultTolerantA3DCSupport, MirroredMemoryAdvancedECCSupport, and OnlineSpareAdvancedECCSupport.</maml:para> <maml:para>· AdvancedECCSupport - Provides the largest memory capacity to the operating system while protecting the system against all single-bit failures and some multi-bit failures.</maml:para> <maml:para>· OnlineSpareAdvancedECCSupport - Enables the system to automatically map out a group of memory that is receiving excessive correctable memory errors. This memory is replaced by a spare group of memory.</maml:para> <maml:para>· MirroredMemoryAdvancedECCSupport - Provides the maximum protection against uncorrected memory errors that might otherwise result in a system failure. You must install additional memory to provide mirrored memory to the operating system.</maml:para> <maml:para>· FastFaultTolerantA3DCSupport (only available on Gen10 with Intel processor servers) - Enables the system to correct memory errors and continue to operate in cases of multiple DRAM device failures on a DIMM. This provides protection against uncorrectable memory errors beyond what is available with Advanced ECC.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AdvancedECCSupport</command:parameterValue> <command:parameterValue required="false" variableLength="false">FastFaultTolerantA3DCSupport</command:parameterValue> <command:parameterValue required="false" variableLength="false">MirroredMemoryAdvancedECCSupport</command:parameterValue> <command:parameterValue required="false" variableLength="false">OnlineSpareAdvancedECCSupport</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AdvancedMemoryProtection</maml:name> <maml:description> <maml:para>Provides additional memory protection beyond ECC (error checking and correcting). Advanced ECC provides the largest memory capacity to the operating system. Possible values are AdvancedECCSupport, FastFaultTolerantA3DCSupport, MirroredMemoryAdvancedECCSupport, and OnlineSpareAdvancedECCSupport.</maml:para> <maml:para>· AdvancedECCSupport - Provides the largest memory capacity to the operating system while protecting the system against all single-bit failures and some multi-bit failures.</maml:para> <maml:para>· OnlineSpareAdvancedECCSupport - Enables the system to automatically map out a group of memory that is receiving excessive correctable memory errors. This memory is replaced by a spare group of memory.</maml:para> <maml:para>· MirroredMemoryAdvancedECCSupport - Provides the maximum protection against uncorrected memory errors that might otherwise result in a system failure. You must install additional memory to provide mirrored memory to the operating system.</maml:para> <maml:para>· FastFaultTolerantA3DCSupport (only available on Gen10 with Intel processor servers) - Enables the system to correct memory errors and continue to operate in cases of multiple DRAM device failures on a DIMM. This provides protection against uncorrectable memory errors beyond what is available with Advanced ECC.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AdvancedECCSupport</command:parameterValue> <command:parameterValue required="false" variableLength="false">FastFaultTolerantA3DCSupport</command:parameterValue> <command:parameterValue required="false" variableLength="false">MirroredMemoryAdvancedECCSupport</command:parameterValue> <command:parameterValue required="false" variableLength="false">OnlineSpareAdvancedECCSupport</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSAdvancedMemoryProtection -AdvancedMemoryProtection MirroredMemoryAdvancedECCSupport</dev:code> <dev:remarks> <maml:para>This example sets AdvancedMemoryProtection to the specified value on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSAdvancedMemoryProtection -Connection $connection -AdvancedMemoryProtection FastFaultTolerantA3DCSupport</dev:code> <dev:remarks> <maml:para>This example sets AdvancedMemoryProtection to the specified value on a Gen10 Intel server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSAdvancedMemoryProtection -Connection $connection -AdvancedMemoryProtection OnlineSpareAdvancedECCSupport,MirroredMemoryAdvancedECCSupport,FastFaultTolerantA3DCSupport</dev:code> <dev:remarks> <maml:para>This example sets AdvancedMemoryProtection to the specified values on Gen9, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSAdvancedMemoryProtection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdvancedPCIConfiguration</command:name> <maml:description> <maml:para>The Set-HPEBIOSAdvancedPCIConfiguration cmdlet sets the BIOS Advanced PCI configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSAdvancedPCIConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSAdvancedPCIConfiguration cmdlet sets the BIOS Advanced PCI configuration. This cmdlet has the following parameters:</maml:para> <maml:para>· PCIeDeviceIsolationSupport (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· PCIeSlotToProcessorMapping (only available on Gen10 servers with Intel processors)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSAdvancedPCIConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PCIeDeviceIsolationSupport</maml:name> <maml:description> <maml:para>Enables or disables the PCIe Isolation Support. When enabled, a PCIe device is disabled at runtime when an error is detected. Refer to the Operating System documentation before enabling this option. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIeSlotToProcessorMapping</maml:name> <maml:description> <maml:para>Configures the PCIe to Processor mapping configuration. When X4GPUConfiguration is selected, 4 PCIe slots are mapped to each installed processor. When X8GPUConfiguration is selected, all slots are mapped to a single processor. Possible values are X4GPUConfiguration and X8GPUConfiguration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">X4GPUConfiguration</command:parameterValue> <command:parameterValue required="false" variableLength="false">X8GPUConfiguration</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PCIeDeviceIsolationSupport</maml:name> <maml:description> <maml:para>Enables or disables the PCIe Isolation Support. When enabled, a PCIe device is disabled at runtime when an error is detected. Refer to the Operating System documentation before enabling this option. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIeSlotToProcessorMapping</maml:name> <maml:description> <maml:para>Configures the PCIe to Processor mapping configuration. When X4GPUConfiguration is selected, 4 PCIe slots are mapped to each installed processor. When X8GPUConfiguration is selected, all slots are mapped to a single processor. Possible values are X4GPUConfiguration and X8GPUConfiguration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">X4GPUConfiguration</command:parameterValue> <command:parameterValue required="false" variableLength="false">X8GPUConfiguration</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSAdvancedPCIConfiguration -PCIeDeviceIsolationSupport Enabled</dev:code> <dev:remarks> <maml:para>This example sets PCIeDeviceIsolationSupport to the specified value on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSAdvancedPCIConfiguration -Connection $connection -PCIeSlotToProcessorMapping X4GPUConfiguration,X8GPUConfiguration</dev:code> <dev:remarks> <maml:para>This example sets PCIeSlotToProcessorMapping to the specified values on Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSPCIDeviceConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdvancedPerformanceTuningOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSAdvancedPerformanceTuningOption cmdlet sets the BIOS advanced performance tuning options.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSAdvancedPerformanceTuningOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSAdvancedPerformanceTuningOption cmdlet sets the BIOS performance tuning options. This cmdlet has the following parameters:</maml:para> <maml:para>· IntelPerformanceMonitoringSupport (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· IONonPostedPrefetching (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· NUMAGroupSizeOptimization (available on Gen10 and Gen9 servers)</maml:para> <maml:para>· EnergyEfficientTurbo (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· LocalRemoteThreshold (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· ProcessorJitterControl (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· ProcessorJitterControlFrequency (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· ProcessorJitterControlOptimization (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· SubNUMAClustering (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· UncoreFrequencyScaling (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· LLCDeadLineAllocation (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· StaleAtoS (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· CoreBoosting (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· HPCOptimizationMode (only available on Gen8 servers with AMD processors)</maml:para> <maml:para>· DataFabricCStateEnable (only available on Gen10 servers with AMD processors)</maml:para> <maml:para>· CStateEfficiencyMode (only available on Gen10 servers with AMD processors)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSAdvancedPerformanceTuningOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>CoreBoosting</maml:name> <maml:description> <maml:para>Specifies to enable the Core Boosting technology to increase processor performance on qualified Intel processors. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EnergyEfficientTurbo</maml:name> <maml:description> <maml:para>Specifies the options to control whether the processor uses an energy efficiency-based policy when engaging turbo range frequencies. This option is only applicable when Turbo 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HPCOptimizationMode</maml:name> <maml:description> <maml:para>This mode is specially designed for deploying servers in a high-performance computing environment. When enabled, the process can maintain performance at a high level even if the processor temporarily exceeds the normal power threshold. Possible values are Enabled and Disabled.</maml:para> <maml:para>This option should only be enabled in unique, high-performance computing environments. Refer to the User Guide for more information.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntelPerformanceMonitoringSupport</maml:name> <maml:description> <maml:para>Specifies the options to provide Intel Performance Monitoring Toolkit support to certain chipset devices. This option does not impact system performance. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IONonPostedPrefetching</maml:name> <maml:description> <maml:para>Specifies the options to enable or disable the I/O non-posted pre-fetch function. In most environments, leave the option enabled for optimal performance. With certain workloads, disabling it might provide a performance benefit. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LLCDeadLineAllocation</maml:name> <maml:description> <maml:para>Specifies the options to fill dead lines in LLC (Last Level Cache). 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LocalRemoteThreshold</maml:name> <maml:description> <maml:para>Specifies the options for local or remote threshold settings. Possible values are Auto, Low, Medium, High, and 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">Low</command:parameterValue> <command:parameterValue required="false" variableLength="false">Medium</command:parameterValue> <command:parameterValue required="false" variableLength="false">High</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NUMAGroupSizeOptimization</maml:name> <maml:description> <maml:para>Specifies options to report the number of logical processors in a NUMA (Non-Uniform Memory Access) node. The resulting information helps the operating system to group processors for application use. Possible values are Clustered and Flat.</maml:para> <maml:para>· Clustered (default) - Optimizes groups along NUMA boundaries to provide better performance.</maml:para> <maml:para>· Flat - Enables unoptimized applications to leverage processors spanning multiple groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Clustered</command:parameterValue> <command:parameterValue required="false" variableLength="false">Flat</command:parameterValue> </command:parameterValueGroup> <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>ProcessorJitterControl</maml:name> <maml:description> <maml:para>Specifies the options that allows you to manage processor frequency variance and use technologies, such as Turbo, which vary the frequency based on power, thermals, and active cores. When configured for Auto-tuned, the platform monitors frequency variance and automatically makes adjustments to minimize variance over time. When configured for Manual-tuned, you can choose to operate the processor at a fixed frequency and can select lower or higher frequencies statically. Possible values are Disabled, Auto-tuned, and Manual-tuned.</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">Auto-tuned</command:parameterValue> <command:parameterValue required="false" variableLength="false">Manual-tuned</command:parameterValue> </command:parameterValueGroup> <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>ProcessorJitterControlFrequency</maml:name> <maml:description> <maml:para>Specifies the options that allows you to stipulate the starting frequency in the Auto-tuned mode, or the desired frequency in the Manual-tuned mode. The input frequency is in units of Megahertz. System firmware adjusts the frequency to the nearest higher intermediate frequency supported by the processor if the input frequency is not supported. The range of valid frequency values is from 1 to 10000.</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>None</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>Specifies the options that optimizes the thresholds used when the Auto-tuned function detects fluctuations in processor frequency. Optimizing for throughput allows only the amount of fluctuations that does not impact overall compute throughput. Optimizing for Latency allows for a very small amount of occasional fluctuations to occur before reducing processor frequency. Zero Latency attempts to eliminate any frequency fluctuations. Possible values are OptimizedForThroughput, OptimizedForLatency, and ZeroLatency.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StaleAtoS</maml:name> <maml:description> <maml:para>Specifies the options to enable or disable the stale A to S directory optimization. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SubNUMAClustering</maml:name> <maml:description> <maml:para>Specifies the options to divide the processor's cores, cache, and memory into multiple NUMA domains. Enabling this feature can increase performance for workloads that are NUMA-aware and optimized. Note: When this option is enabled, up to 1GB of system memory may become unavailable. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UncoreFrequencyScaling</maml:name> <maml:description> <maml:para>Specifies the options to control the frequency scaling of the processor's internal busses (the uncore). Setting this option to Auto enables the processor to dynamically change frequencies based on workload. Forcing the maximum or minimum frequency enables tuning for latency or power consumption. Possible values are Auto, Maximum, and Minimum.</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">Maximum</command:parameterValue> <command:parameterValue required="false" variableLength="false">Minimum</command:parameterValue> </command:parameterValueGroup> <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>DataFabricCStateEnable</maml:name> <maml:description> <maml:para>Use this option to Enable or Disable data fabric c states. Possible values are Auto, ForceEnabled, and 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">ForceEnabled</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>CStateEfficiencyMode</maml:name> <maml:description> <maml:para>Enabling this option will monitor the workload and modulate the frequency of the core to maintain a high C0 residency. This has power and latency benefits when the core is not 100% utilized. 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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>CoreBoosting</maml:name> <maml:description> <maml:para>Specifies to enable the Core Boosting technology to increase processor performance on qualified Intel processors. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EnergyEfficientTurbo</maml:name> <maml:description> <maml:para>Specifies the options to control whether the processor uses an energy efficiency-based policy when engaging turbo range frequencies. This option is only applicable when Turbo 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HPCOptimizationMode</maml:name> <maml:description> <maml:para>This mode is specially designed for deploying servers in a high-performance computing environment. When enabled, the process can maintain performance at a high level even if the processor temporarily exceeds the normal power threshold. Possible values are Enabled and Disabled.</maml:para> <maml:para>This option should only be enabled in unique, high-performance computing environments. Refer to the User Guide for more information.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntelPerformanceMonitoringSupport</maml:name> <maml:description> <maml:para>Specifies the options to provide Intel Performance Monitoring Toolkit support to certain chipset devices. This option does not impact system performance. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IONonPostedPrefetching</maml:name> <maml:description> <maml:para>Specifies the options to enable or disable the I/O non-posted pre-fetch function. In most environments, leave the option enabled for optimal performance. With certain workloads, disabling it might provide a performance benefit. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LLCDeadLineAllocation</maml:name> <maml:description> <maml:para>Specifies the options to fill dead lines in LLC (Last Level Cache). 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LocalRemoteThreshold</maml:name> <maml:description> <maml:para>Specifies the options for local or remote threshold settings. Possible values are Auto, Low, Medium, High, and 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">Low</command:parameterValue> <command:parameterValue required="false" variableLength="false">Medium</command:parameterValue> <command:parameterValue required="false" variableLength="false">High</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NUMAGroupSizeOptimization</maml:name> <maml:description> <maml:para>Specifies options to report the number of logical processors in a NUMA (Non-Uniform Memory Access) node. The resulting information helps the operating system to group processors for application use. Possible values are Clustered and Flat.</maml:para> <maml:para>· Clustered (default) - Optimizes groups along NUMA boundaries to provide better performance.</maml:para> <maml:para>· Flat - Enables unoptimized applications to leverage processors spanning multiple groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Clustered</command:parameterValue> <command:parameterValue required="false" variableLength="false">Flat</command:parameterValue> </command:parameterValueGroup> <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>ProcessorJitterControl</maml:name> <maml:description> <maml:para>Specifies the options that allows you to manage processor frequency variance and use technologies, such as Turbo, which vary the frequency based on power, thermals, and active cores. When configured for Auto-tuned, the platform monitors frequency variance and automatically makes adjustments to minimize variance over time. When configured for Manual-tuned, you can choose to operate the processor at a fixed frequency and can select lower or higher frequencies statically. Possible values are Disabled, Auto-tuned, and Manual-tuned.</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">Auto-tuned</command:parameterValue> <command:parameterValue required="false" variableLength="false">Manual-tuned</command:parameterValue> </command:parameterValueGroup> <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>ProcessorJitterControlFrequency</maml:name> <maml:description> <maml:para>Specifies the options that allows you to stipulate the starting frequency in the Auto-tuned mode, or the desired frequency in the Manual-tuned mode. The input frequency is in units of Megahertz. System firmware adjusts the frequency to the nearest higher intermediate frequency supported by the processor if the input frequency is not supported. The range of valid frequency values is from 1 to 10000.</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>None</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>Specifies the options that optimizes the thresholds used when the Auto-tuned function detects fluctuations in processor frequency. Optimizing for throughput allows only the amount of fluctuations that does not impact overall compute throughput. Optimizing for Latency allows for a very small amount of occasional fluctuations to occur before reducing processor frequency. Zero Latency attempts to eliminate any frequency fluctuations. Possible values are OptimizedForThroughput, OptimizedForLatency, and ZeroLatency.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>StaleAtoS</maml:name> <maml:description> <maml:para>Specifies the options to enable or disable the stale A to S directory optimization. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SubNUMAClustering</maml:name> <maml:description> <maml:para>Specifies the options to divide the processor's cores, cache, and memory into multiple NUMA domains. Enabling this feature can increase performance for workloads that are NUMA-aware and optimized. Note: When this option is enabled, up to 1GB of system memory may become unavailable. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UncoreFrequencyScaling</maml:name> <maml:description> <maml:para>Specifies the options to control the frequency scaling of the processor's internal busses (the uncore). Setting this option to Auto enables the processor to dynamically change frequencies based on workload. Forcing the maximum or minimum frequency enables tuning for latency or power consumption. Possible values are Auto, Maximum, and Minimum.</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">Maximum</command:parameterValue> <command:parameterValue required="false" variableLength="false">Minimum</command:parameterValue> </command:parameterValueGroup> <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>DataFabricCStateEnable</maml:name> <maml:description> <maml:para>Use this option to Enable or Disable data fabric c states. Possible values are Auto, ForceEnabled, and 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">ForceEnabled</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>CStateEfficiencyMode</maml:name> <maml:description> <maml:para>Enabling this option will monitor the workload and modulate the frequency of the core to maintain a high C0 residency. This has power and latency benefits when the core is not 100% utilized. 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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSAdvancedPerformanceTuningOption -IntelPerformanceMonitoringSupport Enabled -IONonPostedPrefetching Enabled -NUMAGroupSizeOptimization Clustered</dev:code> <dev:remarks> <maml:para>This example sets IntelPerformanceMonitoringSupport, IONonPostedPrefetching, and NUMAGroupSizeOptimization to the specified value on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSAdvancedPerformanceTuningOption -NUMAGroupSizeOptimization Clustered</dev:code> <dev:remarks> <maml:para>This example sets NUMAGroupSizeOptimization to the specified value on a Gen10 AMD server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSAdvancedPerformanceTuningOption -EnergyEfficientTurbo Enabled -IntelPerformanceMonitoringSupport Enabled -IONonPostedPrefetching Enabled -NUMAGroupSizeOptimization Flat -LocalRemoteThreshold Auto -ProcessorJitterControl Auto-tuned -ProcessorJitterControlFrequency 100 -ProcessorJitterControlOptimization OptimizedForLatency -SubNUMAClustering Enabled -UncoreFrequencyScaling Auto</dev:code> <dev:remarks> <maml:para>This example sets EnergyEfficientTurbo, IntelPerformanceMonitoringSupport, IONonPostedPrefetching, NUMAGroupSizeOptimization, LocalRemoteThreshold, ProcessorJitterControl, ProcessorJitterControlFrequency, ProcessorJitterControlOptimization, SubNUMAClustering, and UncoreFrequencyScaling to the specified value on a Gen10 Intel server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSAdvancedPerformanceTuningOption -Connection $connection -IntelPerformanceMonitoringSupport Enabled,Disabled -IONonPostedPrefetching Enabled,Disabled -NUMAGroupSizeOptimization Clustered,Flat</dev:code> <dev:remarks> <maml:para>This example sets IntelPerformanceMonitoringSupport, IONonPostedPrefetching, and NUMAGroupSizeOptimization to the specified values on Gen9 servers with a list of BIOS 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSAdvancedPerformanceTuningOption -Connection $connection -NUMAGroupSizeOptimization Clustered,Flat -DataFabricCStateEnable Auto -CStateEfficiencyMode Enabled</dev:code> <dev:remarks> <maml:para>This example sets NUMAGroupSizeOptimization, DataFabricCStateEnable, and CStateEfficiencyMode to the specified values on Gen10 AMD servers with a list of BIOS connection objects passed as named parameters.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 6</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSAdvancedPerformanceTuningOption -Connection $connection -CoreBoosting Enabled,Disabled -EnergyEfficientTurbo Enabled,Disabled -IntelPerformanceMonitoringSupport Enabled,Disabled -NUMAGroupSizeOptimization Flat,Clustered -LLCDeadLineAllocation Enabled,Disabled -LocalRemoteThreshold High,Low -ProcessorJitterControl Auto-tuned,Manual-tuned -ProcessorJitterControlFrequency 100,555 -ProcessorJitterControlOptimization OptimizedForThroughput,ZeroLatency -StaleAtoS Enabled,Disabled -SubNUMAClustering Enabled,Disabled -UncoreFrequencyScaling Maximum,Minimum</dev:code> <dev:remarks> <maml:para>This example sets CoreBoosting, EnergyEfficientTurbo, IntelPerformanceMonitoringSupport, NUMAGroupSizeOptimization, LLCDeadLineAllocation, LocalRemoteThreshold, ProcessorJitterControl, ProcessorJitterControlFrequency, ProcessorJitterControlOptimization, StaleAtoS, SubNUMAClustering, and UncoreFrequencyScaling to the specified values on Gen10 Intel servers with a list of BIOS connection objects passed as named parameters.</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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSAdvancedPerformanceTuningOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdvancedSecurityOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSAdvancedSecurityOption cmdlet sets the BIOS advanced security configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSAdvancedSecurityOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSAdvancedSecurityOption cmdlet sets the BIOS advanced security configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· TPM_FIPSModeSwitch (only available on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSAdvancedSecurityOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>TPM_FIPSModeSwitch</maml:name> <maml:description> <maml:para>Specifies the TPM chip switch mode. Possible values are NoAction, RegularMode, and FIPSMode.</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">RegularMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">FIPSMode</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>TPM_FIPSModeSwitch</maml:name> <maml:description> <maml:para>Specifies the TPM chip switch mode. Possible values are NoAction, RegularMode, and FIPSMode.</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">RegularMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">FIPSMode</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSAdvancedSecurityOption -TPM_FIPSModeSwitch FIPSMode</dev:code> <dev:remarks> <maml:para>This example sets TPM_FIPSModeSwitch to the specified value on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSAdvancedSecurityOption -Connection $connection -TPM_FIPSModeSwitch NoAction,RegularMode</dev:code> <dev:remarks> <maml:para>This example sets TPM_FIPSModeSwitch to the specified values on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSAdvancedSecurityOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSAdvancedSystemROMOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSAdvancedSystemROMOption cmdlet sets the BIOS system ROM options.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSAdvancedSystemROMOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSAdvancedSystemROMOption cmdlet sets the BIOS system ROM options. This cmdlet has the following parameters.</maml:para> <maml:para>· ConsistentDeviceNaming</maml:para> <maml:para>· HighPrecisionEventTimerACPISupport (only available on Gen10 servers)</maml:para> <maml:para>· MixedPowerSupplyReporting (available on Gen9 and Gen10 servers)</maml:para> <maml:para>· NMIDebugButton (available on Gen9 servers)</maml:para> <maml:para>· PCIBusPaddingOption (available on Gen9 servers)</maml:para> <maml:para>· ROMSelection</maml:para> <maml:para>· VirtualInstallDisk</maml:para> <maml:para>· LogUEFIDebugMessage (only available on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSAdvancedSystemROMOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ConsistentDeviceNaming</maml:name> <maml:description> <maml:para>Selects the level of Consistent Device Naming. On supported operating systems, NIC ports are named based on their location in the system. CDN Support for LOMs Only names Embedded NICs and FlexibleLOMs. Existing NIC connections retain their names until reinstalled under the OS environment. Possible values are CDNSupportForLOMsAndSlots, CDNSupportForLOMsOnly and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CDNSupportForLOMsAndSlots</command:parameterValue> <command:parameterValue required="false" variableLength="false">CDNSupportForLOMsOnly</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HighPrecisionEventTimerACPISupport</maml:name> <maml:description> <maml:para>Use this option to disable the High Precision Event Timer (HPET) table and device object in ACPI. When disabled, the HPET is not available to an operating system that supports the HPET through the industry standard ACPI name space. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MixedPowerSupplyReporting</maml:name> <maml:description> <maml:para>When enabled, the server logs a message that a mixed power supply configuration is present. When disabled, the server no longer logs messages that a mixed power supply configuration is present. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LogUEFIDebugMessage</maml:name> <maml:description> <maml:para>Use this option to log the UEFI debug message into memory. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NMIDebugButton</maml:name> <maml:description> <maml:para>A toggle setting that allows you to enable debug functionality when the system has experienced a software lock-up. The NMI Debug Button generates an NMI to enable the use of the operating system debugger. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIBusPaddingOption</maml:name> <maml:description> <maml:para>Allows the user to disable the default PCI Bus setting where each expansion slot is provided an extra PCI Bus number. By default, the system ROM will pad one PCI bus per bridge to not affect current bus numbering schemes. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ROMSelection</maml:name> <maml:description> <maml:para>Toggles the server ROM between the current ROM and the backup ROM. This option is supported only on servers with redundant ROMs. Possible values are UseCurrentROM and SwitchToBackupROM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UseCurrentROM</command:parameterValue> <command:parameterValue required="false" variableLength="false">SwitchToBackupROM</command:parameterValue> </command:parameterValueGroup> <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>VirtualInstallDisk</maml:name> <maml:description> <maml:para>Controls the Virtual Install Disk. The Virtual Install Disk may contain drivers specific to this server that an OS may use during installation. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ConsistentDeviceNaming</maml:name> <maml:description> <maml:para>Selects the level of Consistent Device Naming. On supported operating systems, NIC ports are named based on their location in the system. CDN Support for LOMs Only names Embedded NICs and FlexibleLOMs. Existing NIC connections retain their names until reinstalled under the OS environment. Possible values are CDNSupportForLOMsAndSlots, CDNSupportForLOMsOnly and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CDNSupportForLOMsAndSlots</command:parameterValue> <command:parameterValue required="false" variableLength="false">CDNSupportForLOMsOnly</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HighPrecisionEventTimerACPISupport</maml:name> <maml:description> <maml:para>Use this option to disable the High Precision Event Timer (HPET) table and device object in ACPI. When disabled, the HPET is not available to an operating system that supports the HPET through the industry standard ACPI name space. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MixedPowerSupplyReporting</maml:name> <maml:description> <maml:para>When enabled, the server logs a message that a mixed power supply configuration is present. When disabled, the server no longer logs messages that a mixed power supply configuration is present. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LogUEFIDebugMessage</maml:name> <maml:description> <maml:para>Use this option to log the UEFI debug message into memory. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NMIDebugButton</maml:name> <maml:description> <maml:para>A toggle setting that allows you to enable debug functionality when the system has experienced a software lock-up. The NMI Debug Button generates an NMI to enable the use of the operating system debugger. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIBusPaddingOption</maml:name> <maml:description> <maml:para>Allows the user to disable the default PCI Bus setting where each expansion slot is provided an extra PCI Bus number. By default, the system ROM will pad one PCI bus per bridge to not affect current bus numbering schemes. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ROMSelection</maml:name> <maml:description> <maml:para>Toggles the server ROM between the current ROM and the backup ROM. This option is supported only on servers with redundant ROMs. Possible values are UseCurrentROM and SwitchToBackupROM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UseCurrentROM</command:parameterValue> <command:parameterValue required="false" variableLength="false">SwitchToBackupROM</command:parameterValue> </command:parameterValueGroup> <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>VirtualInstallDisk</maml:name> <maml:description> <maml:para>Controls the Virtual Install Disk. The Virtual Install Disk may contain drivers specific to this server that an OS may use during installation. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSAdvancedSystemROMOption -ConsistentDeviceNaming Disabled -MixedPowerSupplyReporting Enabled -NMIDebugButton Enabled -PCIBusPaddingOption Enabled -ROMSelection SwitchToBackupROM -VirtualInstallDisk Enabled</dev:code> <dev:remarks> <maml:para>This example sets ConsistentDeviceNaming, MixedPowerSupplyReporting, NMIDebugButton, PCIBusPaddingOption, ROMSelection, and VirtualInstallDisk to the specified value on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSAdvancedSystemROMOption -ConsistentDeviceNaming CDNSupportForLOMsAndSlots -HighPrecisionEventTimerACPISupport Enabled -MixedPowerSupplyReporting Enabled -ROMSelection SwitchToBackupROM -VirtualInstallDisk Enabled -LogUEFIDebugMessage Enabled</dev:code> <dev:remarks> <maml:para>This example sets ConsistentDeviceNaming, HighPrecisionEventTimerACPISupport, MixedPowerSupplyReporting, ROMSelection, VirtualInstallDisk, and LogUEFIDebugMessage to the specified value on a Gen10 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSAdvancedSystemROMOption -Connection $connection -ConsistentDeviceNaming CDNSupportForLOMsOnly,Disabled -MixedPowerSupplyReporting Enabled,Disabled -NMIDebugButton Enabled,Disabled -PCIBusPaddingOption Enabled,Disabled -ROMSelection SwitchToBackupROM,UseCurrentROM -VirtualInstallDisk Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets ConsistentDeviceNaming, MixedPowerSupplyReporting, NMIDebugButton, PCIBusPaddingOption, ROMSelection, and VirtualInstallDisk to the specified value on Gen9 servers with a list of BIOS 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSAdvancedSystemROMOption -Connection $connection -ConsistentDeviceNaming CDNSupportForLOMsAndSlots,CDNSupportForLOMsOnly -HighPrecisionEventTimerACPISupport Enabled,Disabled -MixedPowerSupplyReporting Enabled,Disabled -ROMSelection UseCurrentROM,SwitchToBackupROM -VirtualInstallDisk Enabled,Disabled -LogUEFIDebugMessage Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets ConsistentDeviceNaming, HighPrecisionEventTimerACPISupport, MixedPowerSupplyReporting, ROMSelection, VirtualInstallDisk, and LogUEFIDebugMessage to the specified value on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSAdvancedSystemROMOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSBootBrowserConfiguration</command:name> <maml:description> <maml:para>The Set-HPEBIOSBootBrowserConfiguration cmdlet sets the BIOS boot browser settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSBootBrowserConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSBootBrowserConfiguration cmdlet sets the BIOS boot browser settings. This cmdlet has the following parameters.</maml:para> <maml:para>· BootBrowserSelection (only available on Gen10 with Intel processor servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSBootBrowserConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>BootBrowserSelection</maml:name> <maml:description> <maml:para>Selects the boot setup browser to use Text or GUI. Auto mode uses text when the user enters RBSU via serial console, and uses GUI via IRC or physical terminal. Possible values are Auto, GUI, and Text.</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">GUI</command:parameterValue> <command:parameterValue required="false" variableLength="false">Text</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>BootBrowserSelection</maml:name> <maml:description> <maml:para>Selects the boot setup browser to use Text or GUI. Auto mode uses text when the user enters RBSU via serial console, and uses GUI via IRC or physical terminal. Possible values are Auto, GUI, and Text.</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">GUI</command:parameterValue> <command:parameterValue required="false" variableLength="false">Text</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSBootBrowserConfiguration -BootBrowserSelection GUI</dev:code> <dev:remarks> <maml:para>This example sets BootBrowserSelection to the specified value on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSBootBrowserConfiguration -Connection $connection -BootBrowserSelection Text,Auto</dev:code> <dev:remarks> <maml:para>This example sets BootBrowserSelection to the specified values on Gen10 Intel servers with list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSBootBrowserConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSBootMode</command:name> <maml:description> <maml:para>The Set-HPEBIOSBootMode cmdlet sets the BIOS Boot Mode configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSBootMode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSBootMode cmdlet sets the BIOS Boot Mode configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· BootMode</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSBootMode</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>BootMode</maml:name> <maml:description> <maml:para>The boot mode to be set for the system. ProLiant Gen9 and Gen10 servers provide two boot mode configurations: UEFI Mode and Legacy BIOS Mode. Possible values are UEFIMode and LegacyBIOSMode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">LegacyBIOSMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">UEFIMode</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>BootMode</maml:name> <maml:description> <maml:para>The boot mode to be set for the system. ProLiant Gen9 and Gen10 servers provide two boot mode configurations: UEFI Mode and Legacy BIOS Mode. Possible values are UEFIMode and LegacyBIOSMode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">LegacyBIOSMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">UEFIMode</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[]</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $result = $connection | Set-HPEBIOSBootMode -BootMode UEFIMode PS C:\> $result | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on BootMode.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]} PS C:\> $result.StatusInfo | fl Category : Dependency Message : Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on BootMode. AffectedAttribute : {[UEFIOptimizedBoot, Enabled]} PS C:\> $result.StatusInfo.AffectedAttribute Key Value --- ----- UEFIOptimizedBoot Enabled</dev:code> <dev:remarks> <maml:para>This example sets BootMode to the specified value on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $result = $connection | Set-HPEBIOSBootMode -BootMode LegacyBIOSMode PS C:\> $result | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on BootMode.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]} PS C:\> $result.StatusInfo | fl Category : Dependency Message : Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on BootMode. AffectedAttribute : {[UEFIOptimizedBoot, Disabled]} PS C:\> $result.StatusInfo.AffectedAttribute Key Value --- ----- UEFIOptimizedBoot Disabled</dev:code> <dev:remarks> <maml:para>This example sets BootMode to the specified value on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSBootMode -Connection $connection -BootMode UEFIMode,LegacyBIOSMode | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on BootMode.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]} IP : 10.20.30.2 Hostname : abc2.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on BootMode.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]}</dev:code> <dev:remarks> <maml:para>This example sets BootMode to the specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSBootMode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSBootOrderPolicy</command:name> <maml:description> <maml:para>The Set-HPEBIOSBootOrderPolicy cmdlet sets the BIOS UEFI Boot Order Policy.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSBootOrderPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSBootOrderPolicy cmdlet sets the BIOS UEFI Boot Order Policy. This cmdlet has the following parameters.</maml:para> <maml:para>· BootOrderPolicy</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSBootOrderPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>BootOrderPolicy</maml:name> <maml:description> <maml:para>Use Boot Order Policy to control the system behavior when attempting to boot devices per the UEFI Boot Order list and no bootable device is found. Possible values are AttemptOnce, ResetAfterFailed and RetryIndefinitely.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AttemptOnce</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResetAfterFailed</command:parameterValue> <command:parameterValue required="false" variableLength="false">RetryIndefinitely</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>BootOrderPolicy</maml:name> <maml:description> <maml:para>Use Boot Order Policy to control the system behavior when attempting to boot devices per the UEFI Boot Order list and no bootable device is found. Possible values are AttemptOnce, ResetAfterFailed and RetryIndefinitely.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AttemptOnce</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResetAfterFailed</command:parameterValue> <command:parameterValue required="false" variableLength="false">RetryIndefinitely</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSBootOrderPolicy -BootOrderPolicy AttemptOnce</dev:code> <dev:remarks> <maml:para>This example sets BootOrderPolicy to the specified value on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSBootOrderPolicy -Connection $connection -BootOrderPolicy ResetAfterFailed</dev:code> <dev:remarks> <maml:para>This example sets BootOrderPolicy to the specified value on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSBootOrderPolicy -Connection $connection -BootOrderPolicy AttemptOnce,RetryIndefinitely</dev:code> <dev:remarks> <maml:para>This example sets BootOrderPolicy to the specified values on Gen9 and Gen10 servers with a list of BIOS connection objects passed as named paramater.</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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSBootOrderPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSBootTimeMemoryOptimization</command:name> <maml:description> <maml:para>The Set-HPEBIOSBootTimeMemoryOptimization cmdlet sets the boot time memory optimization options.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSBootTimeMemoryOptimization</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSBootTimeMemoryOptimization cmdlet sets the boot time memory optimization options. This cmdlet has the following parameters.</maml:para> <maml:para>· ExtendedMemoryTest</maml:para> <maml:para>· MemoryFastTraining (available on Gen10 with Intel processors and Gen9 servers)</maml:para> <maml:para>· MemoryClearOnWarmReset (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· PostDiscoveryMode (only available on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSBootTimeMemoryOptimization</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ExtendedMemoryTest</maml:name> <maml:description> <maml:para>Validates memory during the memory initialization process. If uncorrectable memory errors are detected, the memory is mapped out and the failed DIMMs are logged to the Integrated Management Log (IML). Enabling this option can significantly increase system boot time. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MemoryClearOnWarmReset</maml:name> <maml:description> <maml:para>Configures memory training on server reboots. When enabled, the platform uses the memory training parameters applied on the server’s last cold boot to improve boot-time efficiency. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MemoryFastTraining</maml:name> <maml:description> <maml:para>Use this option to configure when memory is cleared on warm resets. When disabled, the contents of memory will only be cleared on a warm reset if requested by the operating system. When enabled, memory will be cleared on all reboots. Disabling this option can save boot time by skipping the clearing of memory on warm resets. 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>None</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>Configures the UEFI POST Discovery Mode. When Auto is selected, the system will only load select drivers required to boot devices in the UEFI Boot Order. When Force Full Discovery is selected, the system will load UEFI drivers for all devices in the systems providing full boot target availability. When this option is selected, boot time may significantly increase. Possible values are Auto, ForceFullDiscovery and ForceFastDiscovery.</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">ForceFastDiscovery</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ExtendedMemoryTest</maml:name> <maml:description> <maml:para>Validates memory during the memory initialization process. If uncorrectable memory errors are detected, the memory is mapped out and the failed DIMMs are logged to the Integrated Management Log (IML). Enabling this option can significantly increase system boot time. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MemoryClearOnWarmReset</maml:name> <maml:description> <maml:para>Configures memory training on server reboots. When enabled, the platform uses the memory training parameters applied on the server’s last cold boot to improve boot-time efficiency. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MemoryFastTraining</maml:name> <maml:description> <maml:para>Use this option to configure when memory is cleared on warm resets. When disabled, the contents of memory will only be cleared on a warm reset if requested by the operating system. When enabled, memory will be cleared on all reboots. Disabling this option can save boot time by skipping the clearing of memory on warm resets. 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>None</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>Configures the UEFI POST Discovery Mode. When Auto is selected, the system will only load select drivers required to boot devices in the UEFI Boot Order. When Force Full Discovery is selected, the system will load UEFI drivers for all devices in the systems providing full boot target availability. When this option is selected, boot time may significantly increase. Possible values are Auto, ForceFullDiscovery and ForceFastDiscovery.</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">ForceFastDiscovery</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSBootTimeMemoryOptimization -ExtendedMemoryTest Enabled -MemoryFastTraining Disabled</dev:code> <dev:remarks> <maml:para>This example sets ExtendedMemoryTest and MemoryFastTraining to the specified values on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSBootTimeMemoryOptimization -ExtendedMemoryTest Disabled -PostDiscoveryMode ForceFastDiscovery</dev:code> <dev:remarks> <maml:para>This example sets ExtendedMemoryTest and PostDiscoveryMode to the specified values on a Gen10 AMD server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSBootTimeMemoryOptimization -ExtendedMemoryTest Enabled -MemoryFastTraining Disabled -MemoryClearOnWarmReset Enabled -PostDiscoveryMode Auto</dev:code> <dev:remarks> <maml:para>This example sets ExtendedMemoryTest, MemoryFastTraining, MemoryClearOnWarmReset, and PostDiscoveryMode to the specified values on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSBootTimeMemoryOptimization -Connection $connection -ExtendedMemoryTest Enabled,Disabled -MemoryFastTraining Disabled,Enabled</dev:code> <dev:remarks> <maml:para>This example sets ExtendedMemoryTest and MemoryFastTraining to the specified values on Gen9 servers with a list of BIOS 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSBootTimeMemoryOptimization -Connection $connection -ExtendedMemoryTest Enabled,Disabled -PostDiscoveryMode Auto,ForceFullDiscovery</dev:code> <dev:remarks> <maml:para>This example sets ExtendedMemoryTest and PostDiscoveryMode to the specified values on Gen10 AMD servers with a list of BIOS connection objects passed as named parameter.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSBootTimeMemoryOptimization -Connection $connection -ExtendedMemoryTest Enabled,Disabled -MemoryFastTraining Disabled,Enabled -MemoryClearOnWarmReset Enabled,Disabled -PostDiscoveryMode Auto,ForceFullDiscovery</dev:code> <dev:remarks> <maml:para>This example sets ExtendedMemoryTest, MemoryFastTraining, MemoryClearOnWarmReset, and PostDiscoveryMode to the specified values on Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSBootTimeMemoryOptimization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSCustomPostMessage</command:name> <maml:description> <maml:para>The Set-HPEBIOSCustomPostMessage cmdlet sets the BIOS custom post message.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSCustomPostMessage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSCustomPostMessage cmdlet sets the BIOS custom post message. This cmdlet has the following parameters.</maml:para> <maml:para>· CustomPostMessage</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSCustomPostMessage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>CustomPostMessage</maml:name> <maml:description> <maml:para>Use this option to enter a custom message to display during server POST in the ProLiant POST screen. A maximum of 59 characters for Gen8 and 62 characters for Gen9\Gen10 are supported. By default, this value is 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>CustomPostMessage</maml:name> <maml:description> <maml:para>Use this option to enter a custom message to display during server POST in the ProLiant POST screen. A maximum of 59 characters for Gen8 and 62 characters for Gen9\Gen10 are supported. By default, this value is 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSCustomPostMessage -Connection $connection -CustomPostMessage “Custom Post Message For Gen9”</dev:code> <dev:remarks> <maml:para>This example sets CustomPostMessage to the specified value on Gen9 server with 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSCustomPostMessage -Connection $connection -CustomPostMessage “Custom Post Message For Gen10”</dev:code> <dev:remarks> <maml:para>This example sets CustomPostMessage to the specified value on Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSCustomPostMessage -Connection $connection -CustomPostMessage 'Test Message1','Test Message2','Test Message3'</dev:code> <dev:remarks> <maml:para>This example sets CustomPostMessage to the specified values on Gen9, and Gen10 servers with a list 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSCustomPostMessage</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSDateTimeOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSDateTimeOption cmdlet sets the BIOS date and time settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSDateTimeOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSDateTimeOption cmdlet sets the BIOS date and time settings. This cmdlet has the following parameters.</maml:para> <maml:para>· DaylightSavingTime</maml:para> <maml:para>· TimeFormat</maml:para> <maml:para>· TimeZone</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSDateTimeOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>DaylightSavingTime</maml:name> <maml:description> <maml:para>Adjusts local time displayed by one hour to daylight-saving time. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TimeFormat</maml:name> <maml:description> <maml:para>Selects the time format for the system. Possible values are UTC and Local.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Local</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTC</command:parameterValue> </command:parameterValueGroup> <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>TimeZone</maml:name> <maml:description> <maml:para>Selects the time zone for the system. Possible values are UTCM12, UTCM11, UTCM10, UTCM9, UTCM8, UTCM7, UTCM6, UTCM5, UTCM430, UTCM4, UTCM330, UTCM3, UTCM2, UTCM1, UTC0, UTCP1, UTCP2, UTCP3, UTCP330, UTCP4, UTCP430, UTCP5, UTCP530, UTCP545, UTCP6, UTCP630, UTCP7, UTCP8, UTCP9, UTCP930, UTCP10, UTCP11, UTCP12, UTCP13, UTCP14, and Unspecified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UTCM12</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM11</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM10</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM9</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM930</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM8</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM7</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM6</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM5</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM430</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM4</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM330</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM3</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM2</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM1</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTC0</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP1</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP2</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP3</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP330</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP4</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP430</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP5</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP530</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP545</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP6</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP630</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP7</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP8</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP845</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP9</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP930</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP10</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP1030</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP1045</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP11</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP12</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP13</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP14</command:parameterValue> <command:parameterValue required="false" variableLength="false">Unspecified</command:parameterValue> </command:parameterValueGroup> <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>HourFormat</maml:name> <maml:description> <maml:para>Specifies the hour format. Possible values are 24 Hours and 12 Hours.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">24Hours</command:parameterValue> <command:parameterValue required="false" variableLength="false">12Hours</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" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>DaylightSavingTime</maml:name> <maml:description> <maml:para>Adjusts local time displayed by one hour to daylight-saving time. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TimeFormat</maml:name> <maml:description> <maml:para>Selects the time format for the system. Possible values are UTC and Local.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Local</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTC</command:parameterValue> </command:parameterValueGroup> <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>TimeZone</maml:name> <maml:description> <maml:para>Selects the time zone for the system. Possible values are UTCM12, UTCM11, UTCM10, UTCM9, UTCM8, UTCM7, UTCM6, UTCM5, UTCM430, UTCM4, UTCM330, UTCM3, UTCM2, UTCM1, UTC0, UTCP1, UTCP2, UTCP3, UTCP330, UTCP4, UTCP430, UTCP5, UTCP530, UTCP545, UTCP6, UTCP630, UTCP7, UTCP8, UTCP9, UTCP930, UTCP10, UTCP11, UTCP12, UTCP13, UTCP14, and Unspecified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">UTCM12</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM11</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM10</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM9</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM930</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM8</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM7</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM6</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM5</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM430</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM4</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM330</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM3</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM2</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCM1</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTC0</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP1</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP2</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP3</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP330</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP4</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP430</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP5</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP530</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP545</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP6</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP630</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP7</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP8</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP845</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP9</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP930</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP10</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP1030</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP1045</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP11</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP12</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP13</command:parameterValue> <command:parameterValue required="false" variableLength="false">UTCP14</command:parameterValue> <command:parameterValue required="false" variableLength="false">Unspecified</command:parameterValue> </command:parameterValueGroup> <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>HourFormat</maml:name> <maml:description> <maml:para>Specifies the hour format. Possible values are 24 Hours and 12 Hours.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">24Hours</command:parameterValue> <command:parameterValue required="false" variableLength="false">12Hours</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>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSDateTimeOption -DaylightSavingTime Enabled -TimeFormat UTC -TimeZone UTCP530</dev:code> <dev:remarks> <maml:para>This example sets DaylightSavingTime, TimeFormat, and TimeZone to specified values on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSDateTimeOption -Connection $connection -DaylightSavingTime Disabled -TimeFormat Local</dev:code> <dev:remarks> <maml:para>This example sets DaylightSavingTime and TimeFormat to specified values on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSDateTimeOption -Connection $connection -DaylightSavingTime Enabled,Disabled -TimeFormat UTC,Local -HourFormat 12Hours</dev:code> <dev:remarks> <maml:para>This example sets Gen10 Plus AMD processor servers with a list of BIOS 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSDateTimeOption -Connection $connection -DaylightSavingTime Enabled,Disabled -TimeFormat UTC,Local</dev:code> <dev:remarks> <maml:para>This example sets DaylightSavingTime and TimeFormat to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSDateTimeOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSEmbeddedDiagnostic</command:name> <maml:description> <maml:para>The Set-HPEBIOSEmbeddedDiagnostic cmdlet sets the BIOS Embedded Diagnostic settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSEmbeddedDiagnostic</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSEmbeddedDiagnostic cmdlet sets the Embedded Diagnostic settings and the mode for viewing diagnostic information. Enabling the Embedded Diagnostic option allows the user to launch the diagnostics screen and view system health and other information. This cmdlet has the following parameters.</maml:para> <maml:para>· EmbeddedDiagnostic</maml:para> <maml:para>· EmbeddedDiagnosticMode (available on Gen10 with Intel processors and Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSEmbeddedDiagnostic</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EmbeddedDiagnostic</maml:name> <maml:description> <maml:para>Enables or disables Embedded Diagnostic functionality. When enabled, the Embedded Diagnostic option allows the user to launch the diagnostics screen and view system health and other information.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EmbeddedDiagnosticMode</maml:name> <maml:description> <maml:para>Identifies whether to view Embedded Diagnostic in Auto or Text Console mode.</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">TextConsole</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EmbeddedDiagnostic</maml:name> <maml:description> <maml:para>Enables or disables Embedded Diagnostic functionality. When enabled, the Embedded Diagnostic option allows the user to launch the diagnostics screen and view system health and other information.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EmbeddedDiagnosticMode</maml:name> <maml:description> <maml:para>Identifies whether to view Embedded Diagnostic in Auto or Text Console mode.</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">TextConsole</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSEmbeddedDiagnostic -EmbeddedDiagnostic Enabled -EmbeddedDiagnosticMode Auto</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedDiagnostic and EmbeddedDiagnosticMode to specified values on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSEmbeddedDiagnostic -EmbeddedDiagnostic Enabled</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedDiagnostic to specified values on a Gen10 AMD server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSEmbeddedDiagnostic -EmbeddedDiagnostic Enabled -EmbeddedDiagnosticMode TextConsole</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedDiagnostic and EmbeddedDiagnosticMode to specified values on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSEmbeddedDiagnostic -Connection $connection -EmbeddedDiagnostic Enabled,Disabled -EmbeddedDiagnosticMode TextConsole,Auto</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedDiagnostic and EmbeddedDiagnosticMode to specified values on Gen9 and Gen10 Intel servers with a list of BIOS 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSEmbeddedDiagnostic -Connection $connection -EmbeddedDiagnostic Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedDiagnostic to specified values on Gen10 AMD servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSEmbeddedDiagnostic</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSEmbeddedUEFIShell</command:name> <maml:description> <maml:para>The Set-HPEBIOSEmbeddedUEFIShell cmdlet sets the BIOS Embedded UEFI Shell.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSEmbeddedUEFIShell</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Embedded UEFI Shell is a pre-boot command line environment for scripting and running UEFI applications, including UEFI boot loaders. The Embedded UEFI Shell also provides CLI-based commands to obtain system information and configure and update the system BIOS. This feature is supported only in UEFI Boot Mode. This cmdlet has the following parameters.</maml:para> <maml:para>· EmbeddedUEFIShell</maml:para> <maml:para>· AddEmbeddedUEFIShellToBootOrder</maml:para> <maml:para>· UEFIShellScriptAutoStart</maml:para> <maml:para>· ShellAutoStartScriptLocation</maml:para> <maml:para>· NetworkLocationForShellAutoStartScript</maml:para> <maml:para>· UEFIShellScriptVerification (only available on Gen10 servers)</maml:para> <maml:para>· UEFIShellStartupURLFromDHCP (only available on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSEmbeddedUEFIShell</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AddEmbeddedUEFIShellToBootOrder</maml:name> <maml:description> <maml:para>Adds the Embedded UEFI Shell as an entry in the UEFI Boot Order list. Possible values are Enabled and Disabled.</maml:para> <maml:para>NOTE: After enabling this option, reboot the server for the Embedded UEFI Shell to appear in the UEFI Boot Order list.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EmbeddedUEFIShell</maml:name> <maml:description> <maml:para>A pre-boot command line environment for scripting and running UEFI applications, including UEFI boot loaders. The Embedded UEFI Shell also provides CLI-based commands to obtain system information and configure and update the system BIOS. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NetworkLocationForShellAutoStartScript</maml:name> <maml:description> <maml:para>Sets the network URL location of the Embedded UEFI Shell startup script. You can specify a URL in HTTP or FTP format using either an IPv4 server address or host name. The script file at the location must end with an .nsh file extension. When UEFI Shell Script Auto-Start is enabled and the Shell Auto-Start Script Location is set to Network Location, the shell attempts to load and execute the startup script from the network location pointed to by the specified URL.</maml:para> <maml:para>NOTE: IPv6 server addresses are not supported.</maml:para> </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>ShellAutoStartScriptLocation</maml:name> <maml:description> <maml:para>Selects the location of the Embedded UEFI Shell startup script. When UEFI Shell Script Auto-Start is enabled, this setting specifies where the shell looks for the startup.nsh file. Possible values are Auto, FileSystemOnAttachedMedia, and NetworkLocation.</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">FileSystemOnAttachedMedia</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkLocation</command:parameterValue> </command:parameterValueGroup> <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>UEFIShellScriptAutoStart</maml:name> <maml:description> <maml:para>Enables or disables automatic execution of the Embedded UEFI Shell startup script during shell startup. You can use the startup script to create a RAM disk, download files from the network, collect data, upload results back to network, and then boot to the OS without rebooting the system. You must name the script file startup.nsh and place it on local media or a network location accessible to the server. When auto-start is enabled, the Shell Auto-Start Script Location option is set to Auto. The shell looks for the script file in any of the FAT16 or FAT32 file systems available. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UEFIShellScriptVerification</maml:name> <maml:description> <maml:para>Enables or disables the shell to allow verification of UEFI shell script files when Secure Boot is enabled. For successful execution of script, make sure that UEFI shell scripts are enrolled in the Secure Boot database (db). 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UEFIShellStartupURLFromDHCP</maml:name> <maml:description> <maml:para>Enables or disables the shell to discover its startup script URL using DHCP. When set to 'Enabled', the Shell sends DHCP requests with the DHCP User Class option set to the string 'UEFIShell'. The DHCP server must be configured to provide HTTP/HTTPS or FTP URLs when this DHCP User Class string is present in the DHCP request. The User Class option is Option 77 when using DHCP over IPv4, and Option 15 when using DHCP over IPv6. URLs in HTTP/HTTPS must use either an IPv4 or IPv6 server address, or a host name. FTP formats are accepted using either an IPv4 server address or a host name. The URL provided by the DHCP server should match the 'HTTP Support' policy. When 'HTTP Support' policy is set to 'Auto', any HTTP/HTTPS or FTP URL provided by the DHCP server is used. When policy is set to 'HTTPS only', only HTTPS URLs are used, and other URLs are ignored. When policy is set to 'HTTP only', only HTTP or FTP URLs are used, and other URLs are ignored. When policy is set to 'Disabled', the Shell does not send any DHCP request. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AddEmbeddedUEFIShellToBootOrder</maml:name> <maml:description> <maml:para>Adds the Embedded UEFI Shell as an entry in the UEFI Boot Order list. Possible values are Enabled and Disabled.</maml:para> <maml:para>NOTE: After enabling this option, reboot the server for the Embedded UEFI Shell to appear in the UEFI Boot Order list.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>EmbeddedUEFIShell</maml:name> <maml:description> <maml:para>A pre-boot command line environment for scripting and running UEFI applications, including UEFI boot loaders. The Embedded UEFI Shell also provides CLI-based commands to obtain system information and configure and update the system BIOS. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NetworkLocationForShellAutoStartScript</maml:name> <maml:description> <maml:para>Sets the network URL location of the Embedded UEFI Shell startup script. You can specify a URL in HTTP or FTP format using either an IPv4 server address or host name. The script file at the location must end with an .nsh file extension. When UEFI Shell Script Auto-Start is enabled and the Shell Auto-Start Script Location is set to Network Location, the shell attempts to load and execute the startup script from the network location pointed to by the specified URL.</maml:para> <maml:para>NOTE: IPv6 server addresses are not supported.</maml:para> </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>ShellAutoStartScriptLocation</maml:name> <maml:description> <maml:para>Selects the location of the Embedded UEFI Shell startup script. When UEFI Shell Script Auto-Start is enabled, this setting specifies where the shell looks for the startup.nsh file. Possible values are Auto, FileSystemOnAttachedMedia, and NetworkLocation.</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">FileSystemOnAttachedMedia</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkLocation</command:parameterValue> </command:parameterValueGroup> <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>UEFIShellScriptAutoStart</maml:name> <maml:description> <maml:para>Enables or disables automatic execution of the Embedded UEFI Shell startup script during shell startup. You can use the startup script to create a RAM disk, download files from the network, collect data, upload results back to network, and then boot to the OS without rebooting the system. You must name the script file startup.nsh and place it on local media or a network location accessible to the server. When auto-start is enabled, the Shell Auto-Start Script Location option is set to Auto. The shell looks for the script file in any of the FAT16 or FAT32 file systems available. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UEFIShellScriptVerification</maml:name> <maml:description> <maml:para>Enables or disables the shell to allow verification of UEFI shell script files when Secure Boot is enabled. For successful execution of script, make sure that UEFI shell scripts are enrolled in the Secure Boot database (db). 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UEFIShellStartupURLFromDHCP</maml:name> <maml:description> <maml:para>Enables or disables the shell to discover its startup script URL using DHCP. When set to 'Enabled', the Shell sends DHCP requests with the DHCP User Class option set to the string 'UEFIShell'. The DHCP server must be configured to provide HTTP/HTTPS or FTP URLs when this DHCP User Class string is present in the DHCP request. The User Class option is Option 77 when using DHCP over IPv4, and Option 15 when using DHCP over IPv6. URLs in HTTP/HTTPS must use either an IPv4 or IPv6 server address, or a host name. FTP formats are accepted using either an IPv4 server address or a host name. The URL provided by the DHCP server should match the 'HTTP Support' policy. When 'HTTP Support' policy is set to 'Auto', any HTTP/HTTPS or FTP URL provided by the DHCP server is used. When policy is set to 'HTTPS only', only HTTPS URLs are used, and other URLs are ignored. When policy is set to 'HTTP only', only HTTP or FTP URLs are used, and other URLs are ignored. When policy is set to 'Disabled', the Shell does not send any DHCP request. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSEmbeddedUEFIShell -EmbeddedUEFIShell Disabled -AddEmbeddedUEFIShellToBootOrder Disabled -ShellAutoStartScriptLocation Auto -UEFIShellScriptAutoStart Disabled -NetworkLocationForShellAutoStartScript ftp://remotehost/ShellScript.nsh</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedUEFIShell, AddEmbeddedUEFIShellToBootOrder, UEFIShellScriptAutoStart, ShellAutoStartLocation, and NetworkLocationForShellAutoStartScript to specified values on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSEmbeddedUEFIShell -EmbeddedUEFIShell Disabled -AddEmbeddedUEFIShellToBootOrder Disabled -ShellAutoStartScriptLocation Auto -UEFIShellScriptAutoStart Disabled -NetworkLocationForShellAutoStartScript ftp://remotehost/ShellScript.nsh -UEFIShellScriptVerification Disabled -UEFIShellStartupURLFromDHCP Disabled</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedUEFIShell, AddEmbeddedUEFIShellToBootOrder, UEFIShellScriptAutoStart, ShellAutoStartLocation, NetworkLocationForShellAutoStartScript, UEFIShellScriptVerification, and UEFIShellStartupURLFromDHCP to specified values on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSEmbeddedUEFIShell -Connection $connection -EmbeddedUEFIShell Enabled,Disabled -AddEmbeddedUEFIShellToBootOrder Enabled,Disabled -ShellAutoStartScriptLocation NetworkLocation,Auto -UEFIShellScriptAutoStart Enabled,Disabled -NetworkLocationForShellAutoStartScript ftp://remotehost1/ShellScript.nsh,ftp://remotehost2/ShellScript.nsh</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedUEFIShell, AddEmbeddedUEFIShellToBootOrder, UEFIShellScriptAutoStart, ShellAutoStartLocation, and NetworkLocationForShellAutoStartScript to specified values on Gen9 servers with a list of BIOS 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSEmbeddedUEFIShell -Connection $connection -EmbeddedUEFIShell Enabled,Disabled -AddEmbeddedUEFIShellToBootOrder Enabled,Disabled -ShellAutoStartScriptLocation NetworkLocation,Auto -UEFIShellScriptAutoStart Enabled,Disabled -NetworkLocationForShellAutoStartScript ftp://remotehost1/ShellScript.nsh,ftp://remotehost2/ShellScript.nsh -UEFIShellScriptVerification Enabled,Disabled -UEFIShellStartupURLFromDHCP Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedUEFIShell, AddEmbeddedUEFIShellToBootOrder, UEFIShellScriptAutoStart, ShellAutoStartLocation, NetworkLocationForShellAutoStartScript, UEFIShellScriptVerification, and UEFIShellStartupURLFromDHCP to specified values on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSEmbeddedUEFIShell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSEmbeddedUserPartition</command:name> <maml:description> <maml:para>The Set-HPEBIOSEmbeddedUserPartition cmdlet sets the Embedded User Partition information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSEmbeddedUserPartition</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSEmbeddedUserPartition cmdlet sets the option to control the Embedded User Partition. The Embedded User Partition is a general-purpose 1 GB disk partition on non-volatile flash memory that is embedded on the system board. This cmdlet has the following parameters.</maml:para> <maml:para>· EmbeddedUserPartition (only available on Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSEmbeddedUserPartition</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EmbeddedUserPartition</maml:name> <maml:description> <maml:para>When the value is Enabled, it allows the server both read and write access to the Embedded User Partition. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EmbeddedUserPartition</maml:name> <maml:description> <maml:para>When the value is Enabled, it allows the server both read and write access to the Embedded User Partition. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSEmbeddedUserPartition -EmbeddedUserPartition Enabled | fl</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedUserPartition to specified value on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSEmbeddedUserPartition -Connection $connection -EmbeddedUserPartition Enabled,Disabled | fl</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedUserPartition to specified values on Gen9 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSEmbeddedUserPartition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSEMSConsole</command:name> <maml:description> <maml:para>The Set-HPEBIOSEMSConsole cmdlet sets the EMS console configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSEMSConsole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSEMSConsole cmdlet sets the EMS console configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· EMSConsole</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSEMSConsole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EMSConsole</maml:name> <maml:description> <maml:para>Configures the ACPI serial port settings for redirecting the Windows Server Emergency Management (EMS) console. EMS provides input and output support for all Microsoft Windows kernel components, including the loader, setup, recovery console, OS kernel, blue screens, and the Special Administration Console. Possible values are COM1, COM2, PhysicalSerialPort, VirtualSerialPort, 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">COM1</command:parameterValue> <command:parameterValue required="false" variableLength="false">COM2</command:parameterValue> <command:parameterValue required="false" variableLength="false">PhysicalSerialPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualSerialPort</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EMSConsole</maml:name> <maml:description> <maml:para>Configures the ACPI serial port settings for redirecting the Windows Server Emergency Management (EMS) console. EMS provides input and output support for all Microsoft Windows kernel components, including the loader, setup, recovery console, OS kernel, blue screens, and the Special Administration Console. Possible values are COM1, COM2, PhysicalSerialPort, VirtualSerialPort, 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">COM1</command:parameterValue> <command:parameterValue required="false" variableLength="false">COM2</command:parameterValue> <command:parameterValue required="false" variableLength="false">PhysicalSerialPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualSerialPort</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSEMSConsole -EMSConsole COM2</dev:code> <dev:remarks> <maml:para>This example sets EMSConsole to specified value on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSEMSConsole -Connection $connection -EMSConsole VirtualSerialPort</dev:code> <dev:remarks> <maml:para>This example sets EMSConsole to specified value on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSEMSConsole -Connection $connection -EMSConsole COM2,Disabled,PhysicalSerialPort</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedUserPartition to specified values on Gen8, Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSEMSConsole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSFanOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSFanOption cmdlet sets the BIOS system fan installation and policy configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSFanOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSFanOption sets the BIOS system fan installation and policy configurations. This cmdlet has the following parameters.</maml:para> <maml:para>· FanInstallationRequirement</maml:para> <maml:para>· FanFailurePolicy</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSFanOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>FanInstallationRequirement</maml:name> <maml:description> <maml:para>Configures how the server reacts when all required fans are not installed. Possible values are EnableMessaging and DisableMessaging.</maml:para> <maml:para>NOTE: Operating the server without the required fans can result in damage to the hardware components.</maml:para> <maml:para>· Enable Messaging (default) - The server displays messages and log events to the Integrated Management Log (IML) when required fans are not installed. The server can still boot and operate. This is the recommended setting.</maml:para> <maml:para>· Disable Messaging - The server does not display message and log events when required fans are not installed. All indications that the server is operating without required fans are removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">EnableMessaging</command:parameterValue> <command:parameterValue required="false" variableLength="false">DisableMessaging</command:parameterValue> </command:parameterValueGroup> <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>FanFailurePolicy</maml:name> <maml:description> <maml:para>Configures how the server reacts when fans fail. Possible values are Shutdown and Allow.</maml:para> <maml:para>NOTE: Operating the server without the required fans installed is not recommended.</maml:para> <maml:para>· Allow - The server can boot and operate despite one or more fan failures.</maml:para> <maml:para>· Shutdown (default) - The server cannot boot or operate due to one or more fan failures. This is the recommended setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Allow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shutdown</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>FanInstallationRequirement</maml:name> <maml:description> <maml:para>Configures how the server reacts when all required fans are not installed. Possible values are EnableMessaging and DisableMessaging.</maml:para> <maml:para>NOTE: Operating the server without the required fans can result in damage to the hardware components.</maml:para> <maml:para>· Enable Messaging (default) - The server displays messages and log events to the Integrated Management Log (IML) when required fans are not installed. The server can still boot and operate. This is the recommended setting.</maml:para> <maml:para>· Disable Messaging - The server does not display message and log events when required fans are not installed. All indications that the server is operating without required fans are removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">EnableMessaging</command:parameterValue> <command:parameterValue required="false" variableLength="false">DisableMessaging</command:parameterValue> </command:parameterValueGroup> <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>FanFailurePolicy</maml:name> <maml:description> <maml:para>Configures how the server reacts when fans fail. Possible values are Shutdown and Allow.</maml:para> <maml:para>NOTE: Operating the server without the required fans installed is not recommended.</maml:para> <maml:para>· Allow - The server can boot and operate despite one or more fan failures.</maml:para> <maml:para>· Shutdown (default) - The server cannot boot or operate due to one or more fan failures. This is the recommended setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Allow</command:parameterValue> <command:parameterValue required="false" variableLength="false">Shutdown</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSFanOption -FanFailurePolicy Allow -FanInstallationRequirement EnableMessaging</dev:code> <dev:remarks> <maml:para>This example sets FanFailurePolicy and FanInstallationRequirement to specified values on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSFanOption -FanFailurePolicy Shutdown -FanInstallationRequirement DisableMessaging</dev:code> <dev:remarks> <maml:para>This example sets FanFailurePolicy and FanInstallationRequirement to specified values on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSFanOption -Connection $connection -FanFailurePolicy Allow,Shutdown -FanInstallationRequirement EnableMessaging,DisableMessaging</dev:code> <dev:remarks> <maml:para>This example sets FanFailurePolicy and FanInstallationRequirement to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSFanOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSIntelNICDMAChannel</command:name> <maml:description> <maml:para>The Set-HPEBIOSIntelNICDMAChannel cmdlet sets the BIOS Intel DMA Channel configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSIntelNICDMAChannel</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSIntelNICDMAChannel cmdlet sets the BIOS Intel DMA Channel configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· IntelNICDMAChannel (available on Gen10 with Intel processors and Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSIntelNICDMAChannel</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>IntelNICDMAChannel</maml:name> <maml:description> <maml:para>Enables or disables the DMA acceleration on Intel NICs. For servers that do not have an Intel NIC, leave this option disabled. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>IntelNICDMAChannel</maml:name> <maml:description> <maml:para>Enables or disables the DMA acceleration on Intel NICs. For servers that do not have an Intel NIC, leave this option disabled. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSIntelNICDMAChannel -IntelNICDMAChannel Disabled</dev:code> <dev:remarks> <maml:para>This example sets IntelNICDMAChannel to specified value on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSIntelNICDMAChannel -Connection $connection -IntelNICDMAChannel Enabled</dev:code> <dev:remarks> <maml:para>This example sets IntelNICDMAChannel to specified value on a Gen10 Intel server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSIntelNICDMAChannel -Connection $connection -IntelNICDMAChannel Enabled,Disabled,Enabled</dev:code> <dev:remarks> <maml:para>This example sets IntelNICDMAChannel to specified values on Gen9, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSIntelNICDMAChannel</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSIntelTurboBoost</command:name> <maml:description> <maml:para>The Set-HPEBIOSIntelTurboBoost cmdlet configures the BIOS Intel Turbo Boost.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSIntelTurboBoost</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSIntelTurboBoost cmdlet sets the BIOS Intel Turbo Boost technology option. This cmdlet has the following parameters.</maml:para> <maml:para>· IntelTurboBoost (available on Gen10 with Intel processors and Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSIntelTurboBoost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>IntelTurboBoost</maml:name> <maml:description> <maml:para>Lets the processor transition to a higher frequency than the processor's rated speed if the processor has available power and is within temperature specifications. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>IntelTurboBoost</maml:name> <maml:description> <maml:para>Lets the processor transition to a higher frequency than the processor's rated speed if the processor has available power and is within temperature specifications. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSIntelTurboBoost -IntelTurboBoost Enabled</dev:code> <dev:remarks> <maml:para>This example sets IntelTurboBoost to specified value on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSIntelTurboBoost -Connection $connection -IntelTurboBoost Enabled</dev:code> <dev:remarks> <maml:para>This example sets IntelTurboBoost to specified value on a Gen10 Intel server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSIntelTurboBoost -Connection $connection -IntelTurboBoost Enabled,Disabled,Enabled</dev:code> <dev:remarks> <maml:para>This example sets IntelTurboBoost to specified values on Gen8 Intel, Gen9, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSIntelTurboBoost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSInternalSDCardSlot</command:name> <maml:description> <maml:para>The Set-HPEBIOSInternalSDCardSlot cmdlet sets the BIOS internal Secure Digital (SD) card slot configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSInternalSDCardSlot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSInternalSDCardSlot cmdlet sets the BIOS internal SD card slot. This cmdlet has the following parameters.</maml:para> <maml:para>· InternalSDCardSlot (available on Gen9 and Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSInternalSDCardSlot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>InternalSDCardSlot</maml:name> <maml:description> <maml:para>Enables or disables the internal SD card slot. The slot holds an SD non-volatile flash memory card that is embedded on the system board. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>InternalSDCardSlot</maml:name> <maml:description> <maml:para>Enables or disables the internal SD card slot. The slot holds an SD non-volatile flash memory card that is embedded on the system board. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSInternalSDCardSlot -InternalSDCardSlot Enabled</dev:code> <dev:remarks> <maml:para>This example sets InternalSDCardSlot to specified value on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSInternalSDCardSlot -InternalSDCardSlot Disabled</dev:code> <dev:remarks> <maml:para>This example sets InternalSDCardSlot to specified value on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSInternalSDCardSlot -Connection $connection -InternalSDCardSlot Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets InternalSDCardSlot to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSInternalSDCardSlot</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSiSCSIInitiatorName</command:name> <maml:description> <maml:para>The Set-HPEBIOSiSCSIInitiatorName cmdlet sets a unique iSCSI Qualified Name (IQN) for the BIOS iSCSI initiator.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSiSCSIInitiatorName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSiSCSIInitiatorName cmdlet sets a unique iSCSI Qualified Name (IQN) for the BIOS iSCSI initiator. This cmdlet has the following parameter:</maml:para> <maml:para>· iSCSIInitiatorName (available on Gen9 and Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSiSCSIInitiatorName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>iSCSIInitiatorName</maml:name> <maml:description> <maml:para>Sets the worldwide unique iSCSI Qualified Name (IQN) for the iSCSI initiator. Only IQN format is accepted. For example, 'iqn.1986-03.com.hp:init.sn-123456'.</maml:para> <maml:para>Note: EUI format is not supported.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>iSCSIInitiatorName</maml:name> <maml:description> <maml:para>Sets the worldwide unique iSCSI Qualified Name (IQN) for the iSCSI initiator. Only IQN format is accepted. For example, 'iqn.1986-03.com.hp:init.sn-123456'.</maml:para> <maml:para>Note: EUI format is not supported.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSiSCSIInitiatorName -iSCSIInitiatorName 'iqn.1986-03.com.abc:uefi-XXX-ASD232XXXX'</dev:code> <dev:remarks> <maml:para>This example sets iSCSIInitiatorName to specified value on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSiSCSIInitiatorName -Connection $connection -iSCSIInitiatorName 'iqn.1986-03.com.abc:uefi-XXX-ASD232XXXX','iqn.1986-03.com.abc:uefi-XXX-MXX54XXXXX'</dev:code> <dev:remarks> <maml:para>This example sets iSCSIInitiatorName to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSiSCSIInitiatorName</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSLogConfig</command:name> <maml:description> <maml:para>The cmdlet Set-HPEBIOSLogConfig modifies the log configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSLogConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set-HPEBIOSLogConfig cmdlet allows the user to modify the log configuration. Logging must be enabled before using this cmdlet.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSLogConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>Sets the assigned Log Level. The values that are allowed are “DEBUG”,”ERROR”,”WARN”,”FATAL”,”INFO”.</maml:para> <maml:para>The functionality of each of the Log Level is described as below: · FATAL - Logs only messages with log level marked as FATAL. · Error - Logs messages with log level marked as FATAL and ERROR · WARN - Logs messages with log level marked as FATAL, ERROR and WARN · INFO- Logs messages with log level marked as FATAL, ERROR, WARN and INFO · DEBUG- Logs messages with log level marked as FATAL, ERROR, WARN, INFO and DEBUG</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>Sets the maximum number of backup files that are kept before the oldest is erased. If set to zero, then there will be no backup files and the log file will be truncated when it reaches MaxFileSize.</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>Sets the maximum size in KB, GB and MB that the output file is allowed to reach before being rolled over to backup files.</maml:para> </maml:description> <command:parameterValue required="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>Sets the assigned Log Level. The values that are allowed are “DEBUG”,”ERROR”,”WARN”,”FATAL”,”INFO”.</maml:para> <maml:para>The functionality of each of the Log Level is described as below: · FATAL - Logs only messages with log level marked as FATAL. · Error - Logs messages with log level marked as FATAL and ERROR · WARN - Logs messages with log level marked as FATAL, ERROR and WARN · INFO- Logs messages with log level marked as FATAL, ERROR, WARN and INFO · DEBUG- Logs messages with log level marked as FATAL, ERROR, WARN, INFO and DEBUG</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>Sets the maximum number of backup files that are kept before the oldest is erased. If set to zero, then there will be no backup files and the log file will be truncated when it reaches MaxFileSize.</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>Sets the maximum size in KB, GB and MB that the output file is allowed to reach before being rolled over to backup files.</maml:para> </maml:description> <command:parameterValue required="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></maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>C:\PS> Set-HPEBIOSLogConfig -LogLevel INFO -MaxSizeRollBackups 10 -MaxFileSize 5MB</dev:code> <dev:remarks> <maml:para>This example sets the LogLevel, MaxSizeRollBackups and MaxFileSize.</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>Set-HPEBIOSMaxThreadLimit</command:name> <maml:description> <maml:para>The Set-HPEBIOSMaxThreadLimit cmdlet sets the maximum thread limit of HPEBIOSCmdlets module for the current PowerShell session.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSMaxThreadLimit</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSMaxThreadLimit cmdlet sets the maximum thread limit of HPEBIOSCmdlets module for the current PowerShell session.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSMaxThreadLimit</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 or System.Management.Automation.PSObject[]</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 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>C:\PS> Set-HPEBIOSMaxThreadLimit -MaxThreadLimit 64</dev:code> <dev:remarks> <maml:para>This example sets MaxThreadLimit to specified value for the current PowerShell session.</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-HPEBIOSMaxThreadLimit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSMemoryConfiguration</command:name> <maml:description> <maml:para>The Set-HPEBIOSMemoryConfiguration cmdlet sets the BIOS memory configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSMemoryConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSMemoryConfiguration cmdlet sets the BIOS memory configurations. This cmdlet has the following parameters.</maml:para> <maml:para>· MemoryPatrolScrubbing (only available on Gen10 servers)</maml:para> <maml:para>· MemoryRefreshRate (only available on Gen10 servers)</maml:para> <maml:para>· MemoryMirroringMode (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· MemoryRemap (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· OpportunisticSelfRefresh (only available on Gen10 servers with Intel processors)</maml:para> <maml:para>· SecureMemoryEncryption (only available on Gen10 servers with AMD processors)</maml:para> <maml:para>· PeriodicDirectoryRinse (only available on Gen10 servers with AMD processors)</maml:para> <maml:para>· PatrolScrubDuration (only available on Gen10 servers with AMD processors)</maml:para> <maml:para>· NUMAMemoryDomainsPerSocket (only available on Gen10 servers with AMD processors)</maml:para> <maml:para>· TransparentSecureMemoryEncryption (only available on Gen10 servers with AMD processors)</maml:para> <maml:para>· LastLevelCacheAsNUMANode (only available on Gen10 servers with AMD processors)</maml:para> <maml:para>· MemoryInterleavingMode (only available on Gen10 servers with AMD processors)</maml:para> <maml:para>· MemoryIntervalSize (only available on Gen10 servers with AMD processors)</maml:para> <maml:para>· MemoryPStates (only available on Gen10 servers with AMD processors)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSMemoryConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PeriodicDirectoryRinse</maml:name> <maml:description> <maml:para>This parameter allows you to Enable or Disable the Periodic Directory Rinse. Enabling Periodic Directory Rinse may help manage directory capacity more efficiently. In workloads with significant system-wide sharing, such as databases and HPC applications, using a shorter period for a directory rinse operation may improve performance. 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>CMCI</maml:name> <maml:description> <maml:para>Enables or Disables the CMCI. 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>MemoryRefreshRate</maml:name> <maml:description> <maml:para>Controls the refresh rate of the memory controller and might affect the performance and resiliency of the server memory. Possible values are Refreshx1 and Refreshx2.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Refreshx1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Refreshx2</command:parameterValue> </command:parameterValueGroup> <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>MemoryPatrolScrubbing</maml:name> <maml:description> <maml:para>Corrects memory soft errors so that over the length of the system runtime, the risk of producing multi-bit and uncorrectable errors is reduced. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MemoryMirroringMode</maml:name> <maml:description> <maml:para>Selects the available memory for mirroring modes. Possible values are FullMirror, PartialMirrorOSConfigured, PartialMirrorBelow4GB, Partial10PercentAbove4GB, and Partial20PercentAbove4GB.</maml:para> <maml:para>FullMirror - reserves 50% of the total available memory for mirroring.</maml:para> <maml:para>Partial20PercentAbove4GB - reserves 20% of the total available Memory above 4GB for Mirroring.</maml:para> <maml:para>Partial10PercentAbove4GB - reserves 10% of the total available Memory above 4GB for Mirroring.</maml:para> <maml:para>PartialMirrorBelow4GB - depending on the memory configuration, sets up 2GB or 3GB of lower memory below 4GB for Mirroring.</maml:para> <maml:para>PartialMirrorOSConfigured - sets up the system to configure Partial Mirroring at OS level.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">FullMirror</command:parameterValue> <command:parameterValue required="false" variableLength="false">PartialMirrorOSConfigured</command:parameterValue> <command:parameterValue required="false" variableLength="false">PartialMirrorBelow4GB</command:parameterValue> <command:parameterValue required="false" variableLength="false">Partial10PercentAbove4GB</command:parameterValue> <command:parameterValue required="false" variableLength="false">Partial20PercentAbove4GB</command:parameterValue> </command:parameterValueGroup> <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>MemoryRemap</maml:name> <maml:description> <maml:para>Controls the remap memory that may have been previously disabled from the system due to a failure event, such as an uncorrectable memory error. The Remap All Memory Option causes the system to make all memory in the system available again on the next boot. The No Action option leaves any affected memory unavailable to the system. Possible values are NoAction and AllMemory.</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">AllMemory</command:parameterValue> </command:parameterValueGroup> <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>MemoryInterleavingMode</maml:name> <maml:description> <maml:para>This parameter is configurable only when the Workload Profile is set to Custom. Use this option to modify the level of interleaving for which the memory system is configured. Typically, Auto of memory interleaving results in maximum performance. 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>MemoryIntervalSize</maml:name> <maml:description> <maml:para>This parameter allows you to change the size of the memory interleave. Possible values are 256, 512, 1024, and 2048</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">256</command:parameterValue> <command:parameterValue required="false" variableLength="false">512</command:parameterValue> <command:parameterValue required="false" variableLength="false">1024</command:parameterValue> <command:parameterValue required="false" variableLength="false">2048</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MemoryPStates</maml:name> <maml:description> <maml:para>Enables or Disables memory pstates. Possible values are Auto and 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:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LastLevelCacheAsNUMANode</maml:name> <maml:description> <maml:para>When enabled, LLC As NUMA Node divides the processor's cores into an additional NUMA domain based on the L3 cache. Enabling this feature can increase performance for workloads that are NUMA aware and optimized. 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>NUMAMemoryDomainsPerSocket</maml:name> <maml:description> <maml:para>Use this parameter to configure the number of NUMA memory domains per socket.If LLC As NUMA Node is enabled, the total NUMA node number depends on total CCX number. Possible values are Auto, 1, 2, and 4.</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">1</command:parameterValue> <command:parameterValue required="false" variableLength="false">2</command:parameterValue> <command:parameterValue required="false" variableLength="false">4</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PatrolScrubDuration</maml:name> <maml:description> <maml:para>Use this parameter to configure the duration interval of when to run the patrol scrubber if patrol scrub is enabled. Value is in hours. Valid range is 0 to 24.</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>SecureMemoryEncryption</maml:name> <maml:description> <maml:para>Use this option to enable the Secure Memory Encryption (SME) which is used to protect a system against a variety of attacks. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OpportunisticSelfRefresh</maml:name> <maml:description> <maml:para>Use this option to allow the memory controller to enter self-refresh mode during periods of low memory utilization. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TransparentSecureMemoryEncryption</maml:name> <maml:description> <maml:para>Enables or Disables the Transparent Secure Memory encryption. 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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PeriodicDirectoryRinse</maml:name> <maml:description> <maml:para>This parameter allows you to Enable or Disable the Periodic Directory Rinse. Enabling Periodic Directory Rinse may help manage directory capacity more efficiently. In workloads with significant system-wide sharing, such as databases and HPC applications, using a shorter period for a directory rinse operation may improve performance. 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>CMCI</maml:name> <maml:description> <maml:para>Enables or Disables the CMCI. 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>MemoryRefreshRate</maml:name> <maml:description> <maml:para>Controls the refresh rate of the memory controller and might affect the performance and resiliency of the server memory. Possible values are Refreshx1 and Refreshx2.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Refreshx1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Refreshx2</command:parameterValue> </command:parameterValueGroup> <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>MemoryPatrolScrubbing</maml:name> <maml:description> <maml:para>Corrects memory soft errors so that over the length of the system runtime, the risk of producing multi-bit and uncorrectable errors is reduced. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MemoryMirroringMode</maml:name> <maml:description> <maml:para>Selects the available memory for mirroring modes. Possible values are FullMirror, PartialMirrorOSConfigured, PartialMirrorBelow4GB, Partial10PercentAbove4GB, and Partial20PercentAbove4GB.</maml:para> <maml:para>FullMirror - reserves 50% of the total available memory for mirroring.</maml:para> <maml:para>Partial20PercentAbove4GB - reserves 20% of the total available Memory above 4GB for Mirroring.</maml:para> <maml:para>Partial10PercentAbove4GB - reserves 10% of the total available Memory above 4GB for Mirroring.</maml:para> <maml:para>PartialMirrorBelow4GB - depending on the memory configuration, sets up 2GB or 3GB of lower memory below 4GB for Mirroring.</maml:para> <maml:para>PartialMirrorOSConfigured - sets up the system to configure Partial Mirroring at OS level.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">FullMirror</command:parameterValue> <command:parameterValue required="false" variableLength="false">PartialMirrorOSConfigured</command:parameterValue> <command:parameterValue required="false" variableLength="false">PartialMirrorBelow4GB</command:parameterValue> <command:parameterValue required="false" variableLength="false">Partial10PercentAbove4GB</command:parameterValue> <command:parameterValue required="false" variableLength="false">Partial20PercentAbove4GB</command:parameterValue> </command:parameterValueGroup> <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>MemoryRemap</maml:name> <maml:description> <maml:para>Controls the remap memory that may have been previously disabled from the system due to a failure event, such as an uncorrectable memory error. The Remap All Memory Option causes the system to make all memory in the system available again on the next boot. The No Action option leaves any affected memory unavailable to the system. Possible values are NoAction and AllMemory.</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">AllMemory</command:parameterValue> </command:parameterValueGroup> <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>MemoryInterleavingMode</maml:name> <maml:description> <maml:para>This parameter is configurable only when the Workload Profile is set to Custom. Use this option to modify the level of interleaving for which the memory system is configured. Typically, Auto of memory interleaving results in maximum performance. 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>MemoryIntervalSize</maml:name> <maml:description> <maml:para>This parameter allows you to change the size of the memory interleave. Possible values are 256, 512, 1024, and 2048</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">256</command:parameterValue> <command:parameterValue required="false" variableLength="false">512</command:parameterValue> <command:parameterValue required="false" variableLength="false">1024</command:parameterValue> <command:parameterValue required="false" variableLength="false">2048</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MemoryPStates</maml:name> <maml:description> <maml:para>Enables or Disables memory pstates. Possible values are Auto and 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:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LastLevelCacheAsNUMANode</maml:name> <maml:description> <maml:para>When enabled, LLC As NUMA Node divides the processor's cores into an additional NUMA domain based on the L3 cache. Enabling this feature can increase performance for workloads that are NUMA aware and optimized. 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>NUMAMemoryDomainsPerSocket</maml:name> <maml:description> <maml:para>Use this parameter to configure the number of NUMA memory domains per socket.If LLC As NUMA Node is enabled, the total NUMA node number depends on total CCX number. Possible values are Auto, 1, 2, and 4.</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">1</command:parameterValue> <command:parameterValue required="false" variableLength="false">2</command:parameterValue> <command:parameterValue required="false" variableLength="false">4</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PatrolScrubDuration</maml:name> <maml:description> <maml:para>Use this parameter to configure the duration interval of when to run the patrol scrubber if patrol scrub is enabled. Value is in hours. Valid range is 0 to 24.</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>SecureMemoryEncryption</maml:name> <maml:description> <maml:para>Use this option to enable the Secure Memory Encryption (SME) which is used to protect a system against a variety of attacks. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OpportunisticSelfRefresh</maml:name> <maml:description> <maml:para>Use this option to allow the memory controller to enter self-refresh mode during periods of low memory utilization. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TransparentSecureMemoryEncryption</maml:name> <maml:description> <maml:para>Enables or Disables the Transparent Secure Memory encryption. 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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSMemoryConfiguration -MemoryPatrolScrubbing Enabled -MemoryRefreshRate Refreshx2 -SecureMemoryEncryption Enabled</dev:code> <dev:remarks> <maml:para>This example sets MemoryPatrolScrubbing, MemoryRefreshRate, and SecureMemoryEncryption to specified values on a Gen10 AMD server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSMemoryConfiguration -MemoryPatrolScrubbing Disabled -MemoryRefreshRate Refreshx1 -MemoryMirroringMode Partial10PercentAbove4GB -MemoryRemap AllMemory -OpportunisticSelfRefresh Enabled</dev:code> <dev:remarks> <maml:para>This example sets MemoryPatrolScrubbing, MemoryRefreshRate, MemoryMirroringMode, MemoryRemap, and OpportunisticSelfRefresh to specified values on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSMemoryConfiguration -Connection $connection -MemoryPatrolScrubbing Enabled -MemoryRefreshRate Refreshx2 -SecureMemoryEncryption Enabled -PatrolScrubDuration 24 -NUMAMemoryDomainsPerSocket 2 -LastLevelCacheAsNUMANode Disabled -TransparentSecureMemoryEncryption Enabled -PeriodicDirectoryRinse Enabled -MemoryInterleavingMode Enabled -MemoryIntervalSize 256 -MemoryPStates Auto -CMCI Enabled</dev:code> <dev:remarks> <maml:para>This example sets the memory configuration settings to specified values on Gen10 AMD servers with a list of BIOS 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSMemoryConfiguration -Connection $connection -MemoryPatrolScrubbing Disabled,Enabled -MemoryRefreshRate Refreshx1,Refreshx2 -MemoryMirroringMode FullMirror,PartialMirrorBelow4GB -MemoryRemap AllMemory,NoAction -OpportunisticSelfRefresh Disabled,Enabled</dev:code> <dev:remarks> <maml:para>This example sets MemoryPatrolScrubbing, MemoryRefreshRate, MemoryMirroringMode, MemoryRemap, and OpportunisticSelfRefresh to specified values on Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSMemoryConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSMemoryPower</command:name> <maml:description> <maml:para>The Set-HPEBIOSMemoryPower cmdlet sets the memory related power management.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSMemoryPower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSMemoryPower cmdlet sets the memory-related power management. This cmdlet has the following parameters.</maml:para> <maml:para>· MaximumMemoryBusFrequency</maml:para> <maml:para>· ChannelInterleaving (available on Gen10 with Intel processors and Gen9 servers)</maml:para> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSMemoryPower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ChannelInterleaving</maml:name> <maml:description> <maml:para>Enables or disables the level of interleaving for the memory system configuration. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MaximumMemoryBusFrequency</maml:name> <maml:description> <maml:para>Configures the system to run memory at a lower maximum speed than what is supported by the installed processor and DIMM configuration. Possible values are Auto, 800, 1066, 1333, 1600, 1867, 2133, 2400, and 2667. Value Auto means to run memory at the maximum speed supported by the system configuration.</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">800</command:parameterValue> <command:parameterValue required="false" variableLength="false">1066</command:parameterValue> <command:parameterValue required="false" variableLength="false">1333</command:parameterValue> <command:parameterValue required="false" variableLength="false">1600</command:parameterValue> <command:parameterValue required="false" variableLength="false">1867</command:parameterValue> <command:parameterValue required="false" variableLength="false">2133</command:parameterValue> <command:parameterValue required="false" variableLength="false">2400</command:parameterValue> <command:parameterValue required="false" variableLength="false">2667</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ChannelInterleaving</maml:name> <maml:description> <maml:para>Enables or disables the level of interleaving for the memory system configuration. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MaximumMemoryBusFrequency</maml:name> <maml:description> <maml:para>Configures the system to run memory at a lower maximum speed than what is supported by the installed processor and DIMM configuration. Possible values are Auto, 800, 1066, 1333, 1600, 1867, 2133, 2400, and 2667. Value Auto means to run memory at the maximum speed supported by the system configuration.</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">800</command:parameterValue> <command:parameterValue required="false" variableLength="false">1066</command:parameterValue> <command:parameterValue required="false" variableLength="false">1333</command:parameterValue> <command:parameterValue required="false" variableLength="false">1600</command:parameterValue> <command:parameterValue required="false" variableLength="false">1867</command:parameterValue> <command:parameterValue required="false" variableLength="false">2133</command:parameterValue> <command:parameterValue required="false" variableLength="false">2400</command:parameterValue> <command:parameterValue required="false" variableLength="false">2667</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSMemoryPower -ChannelInterleaving Enabled -MaximumMemoryBusFrequency 1867</dev:code> <dev:remarks> <maml:para>This example sets ChannelInterleaving and MaximumMemoryBusFrequency to specified values on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> Set-HPEBIOSMemoryPower -Connection $connection -MaximumMemoryBusFrequency Auto</dev:code> <dev:remarks> <maml:para>This example sets ChannelInterleaving and MaximumMemoryBusFrequency to specified values on a Gen10 AMD server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.5 -Username admin -Password admin123 PS C:\> Set-HPEBIOSMemoryPower -Connection $connection -ChannelInterleaving Enabled -MaximumMemoryBusFrequency 2667</dev:code> <dev:remarks> <maml:para>This example sets ChannelInterleaving and MaximumMemoryBusFrequency to specified values on a Gen10 Intel server with connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSMemoryPower -Connection $connection -ChannelInterleaving Enabled,Disabled -DIMMVoltagePreference OptimizedForPower,OptimizedForPerformance -MaximumMemoryBusFrequency 1066,Auto -MemoryInterleaving FullInterleaving,NoInterleaving -MemoryPowerSavingsMode Balanced,MaximumPerformance</dev:code> <dev:remarks> <maml:para>This example sets ChannelInterleaving, DIMMVoltagePreference, MaximumMemoryBusFrequency, MemoryInterleaving, and MemoryPowerSavingsMode to specified values on Gen8 Intel servers with a list of BIOS 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSMemoryPower -Connection $connection -ChannelInterleaving Enabled,Disabled -MaximumMemoryBusFrequency 2667,Auto</dev:code> <dev:remarks> <maml:para>This example sets ChannelInterleaving and MaximumMemoryBusFrequency to specified values on Gen9 and Gen10 Intel servers with a list of BIOS connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 6</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSMemoryPower -Connection $connection -MaximumMemoryBusFrequency 1600,1867</dev:code> <dev:remarks> <maml:para>This example sets MaximumMemoryBusFrequency to specified values on Gen10 AMD servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSMemoryPower</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSMemoryProximityReportingForIO</command:name> <maml:description> <maml:para>The Set-HPEBIOSMemoryProximityReportingForIO cmdlet configures the BIOS Memory Proximity Reporting for I/O information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSMemoryProximityReportingForIO</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSMemoryProximityReportingForIO cmdlet sets the memory proximity settings. This cmdlet has the following parameters.</maml:para> <maml:para>· MemoryProximityReportingForIO</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSMemoryProximityReportingForIO</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>MemoryProximityReportingForIO</maml:name> <maml:description> <maml:para>Configures the system ROM to report the proximity relationship between I/O devices and system memory to the operating system. Most operating systems can use this information to efficiently assign memory resources for devices such as network controllers and storage devices. Additionally, certain I/O devices might not be able to take advantage of I/O handling benefits if their OS drivers are not properly optimized to support this feature. See your operating system and I/O device documentation for more details. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>MemoryProximityReportingForIO</maml:name> <maml:description> <maml:para>Configures the system ROM to report the proximity relationship between I/O devices and system memory to the operating system. Most operating systems can use this information to efficiently assign memory resources for devices such as network controllers and storage devices. Additionally, certain I/O devices might not be able to take advantage of I/O handling benefits if their OS drivers are not properly optimized to support this feature. See your operating system and I/O device documentation for more details. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSMemoryProximityReportingForIO -MemoryProximityReportingForIO Disabled</dev:code> <dev:remarks> <maml:para>This example sets MemoryProximityReportingForIO to specified value on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSMemoryProximityReportingForIO -Connection $connection -MemoryProximityReportingForIO Enabled</dev:code> <dev:remarks> <maml:para>This example sets MemoryProximityReportingForIO to specified value on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSMemoryProximityReportingForIO -Connection $connection -MemoryProximityReportingForIO Enabled,Disabled,Enabled</dev:code> <dev:remarks> <maml:para>This example sets MemoryProximityReportingForIO to specified values on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSMemoryProximityReportingForIO</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSNetworkBootOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSNetworkBootOption cmdlet sets the BIOS network boot and pre-boot network settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSNetworkBootOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSNetworkBootOption cmdlet sets the BIOS network boot and pre-boot network settings. This cmdlet has the following parameters.</maml:para> <maml:para>· PrebootNetworkEnvironmentPolicy</maml:para> <maml:para>· IPv6DHCPUniqueIdentifier</maml:para> <maml:para>· NetworkBootRetrySupport</maml:para> <maml:para>· NetworkBootRetryCount (only available on Gen10 servers)</maml:para> <maml:para>· HTTPSupport (only available on Gen10 servers)</maml:para> <maml:para>· iSCSIBootPolicy (only available on Gen10 with Intel processor servers)</maml:para> <maml:para>· PrebootNetworkInterface</maml:para> <maml:para>· PrebootNetworkProxy (only available on Gen10 servers)</maml:para> <maml:para>· DHCPv4</maml:para> <maml:para>· IPv4Address</maml:para> <maml:para>· IPv4SubnetMask</maml:para> <maml:para>· IPv4Gateway</maml:para> <maml:para>· IPv4PrimaryDNS</maml:para> <maml:para>· IPv4SecondaryDNS</maml:para> <maml:para>· IPv6ConfigPolicy (only available on Gen10 servers)</maml:para> <maml:para>· IPv6Address (only available on Gen10 servers)</maml:para> <maml:para>· IPv6Gateway (only available on Gen10 servers)</maml:para> <maml:para>· IPv6PrimaryDNS (only available on Gen10 servers)</maml:para> <maml:para>· IPv6SecondaryDNS (only available on Gen10 servers)</maml:para> <maml:para>· BootFromURL (only available on Gen9 servers)</maml:para> <maml:para>· BootFromURL1 (only available on Gen10 servers)</maml:para> <maml:para>· BootFromURL2 (only available on Gen10 servers)</maml:para> <maml:para>· BootFromURL3 (only available on Gen10 servers)</maml:para> <maml:para>· BootFromURL4 (only available on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSNetworkBootOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PrebootNetworkEnvironmentPolicy</maml:name> <maml:description> <maml:para>Sets the preference of network boot targets for pre-boot network in the UEFI Boot Order list.</maml:para> <maml:para>On Gen9 servers, When both IPv4 and IPv6 are enabled, each network boot target appears twice in the UEFI Boot Order list (one for IPv4 and the other for IPv6). Configure this option only when UEFI Boot Mode is set. Possible values are Auto, IPv4ThenIPv6, IPv4, IPv6, and IPv6ThenIPv4.</maml:para> <maml:para>On Gen10 servers, if configured for Auto, all the network operations initiated in the pre-boot environment occur over IPv4 or IPv6. The order of the existing network boot targets is not modified in the UEFI Boot Order list. New network boot targets are added to the end of the list using the default policy of the System BIOS. If configured for IPv4, all the network operations initiated in the pre-boot environment only occur over IPv4. All existing IPv6 network boot targets are removed in the UEFI Boot Order. No new IPv6 network boot targets are added to the list. If configured for IPv6, all the network operations initiated in the pre boot environment only occur over IPv6. All existing IPv4 network boot targets in the UEFI Boot Order are removed. No new IPv4 network boot targets are added to the list. Possible values are Auto, IPv4, and IPv6.</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">IPv4</command:parameterValue> <command:parameterValue required="false" variableLength="false">IPv4ThenIPv6</command:parameterValue> <command:parameterValue required="false" variableLength="false">IPv6</command:parameterValue> <command:parameterValue required="false" variableLength="false">IPv6ThenIPv4</command:parameterValue> </command:parameterValueGroup> <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>IPv6DHCPUniqueIdentifer</maml:name> <maml:description> <maml:para>Selects how the UEFI BIOS obtains the DHCP Unique Identifier (DUID) for IPv6 PXE Boot. DHCPv6 clients use this identifier to get an IP address from a DHCPv6 server. By default, the system uses the server's Unique Universal Identifier (UUID). Possible values are Auto and DUID-LLT.</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">DUID-LLT</command:parameterValue> </command:parameterValueGroup> <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>NetworkBootRetrySupport</maml:name> <maml:description> <maml:para>Enables or disables the network boot retry function. When enabled, the system BIOS attempts to boot the network device up to 20 times before attempting to boot the next network device on Gen8 and Gen9 servers. On Gen10 servers, the system BIOS attempts to boot the network device for the number of times configured in the Network Boot Retry Count option before attempting to boot the next network device. This setting only takes effect when attempting to boot a network device from the F12 function key and one-time boot options. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NetworkBootRetryCount</maml:name> <maml:description> <maml:para>Configures the network boot retry count to control the number of times the system BIOS attempts to boot a network device. Possible values are 0 to 20.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HTTPSupport</maml:name> <maml:description> <maml:para>Specifies the UEFI HTTP(s) boot support when in UEFI Mode. Possible values are Auto, HTTPOnly, HTTPSOnly, and Disabled.</maml:para> <maml:para>If 'Auto' is selected, the system automatically adds HTTP(S) boot options to the UEFI Boot Order list for every network port that is enabled for Network Boot. Selecting this option enables the system to boot to the HTTP or HTTPS URLs provided by the DHCP server. Any other URLs provided by the DHCP server are ignored.</maml:para> <maml:para>If 'HTTP only' is selected, the system automatically adds HTTP boot options to the UEFI Boot Order list for every network port that is enabled for Network Boot. Selecting this option enables the system to boot to the HTTP URLs provided by the DHCP server, and to ignore any HTTPS or other URLs that are provided.</maml:para> <maml:para>If 'HTTPS only' is selected, the system automatically adds HTTPS boot options to the UEFI Boot Order list for every network port that is enabled for Network Boot. Selecting this option enables the system to boot to the HTTPS URLs provided by the DHCP server, and to ignore any HTTP or other URLs that are provided. To enable HTTPS boot either by selecting 'Auto' or 'HTTPS only', you must enroll the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options.</maml:para> <maml:para>Note: This setting only affects the HTTP boot options added for the network ports, and the Discover Shell Auto-Start Script provided by the DHCP server. Other settings, such as Boot from URL, are not affected by this setting.</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">HTTPOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">HTTPSOnly</command:parameterValue> </command:parameterValueGroup> <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>iSCSIBootPolicy</maml:name> <maml:description> <maml:para>Configures the iSCSI boot policy to access the iSCSI targets. Possible values are SoftwareInitiator and AdapterInitiator.</maml:para> <maml:para>SoftwareInitiator - the iSCSI software initiator will be used to access iSCSI targets on any configured NIC ports. AdapterInitiator - the adapter-specific iSCSI initiator will be used instead. The adapter firmware must be configured to access iSCSI targets from the adapter initiator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SoftwareInitiator</command:parameterValue> <command:parameterValue required="false" variableLength="false">AdapterInitiator</command:parameterValue> </command:parameterValueGroup> <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>PrebootNetworkInterface</maml:name> <maml:description> <maml:para>Specifies the network interface used for pre-boot network connections. If the selected NIC has more than one port, only the first port with a network connection is used. When the selection is Auto, the system uses the first available port with a network connection. Devices listed vary from system to system. Possible values are Auto, EmbeddedNIC, EmbeddedNICPort1 to EmbeddedNICPort8, EmbeddedFlexLOM1, EmbeddedFlexLOM1Port1 to EmbeddedFlexLOM1Port8, PCIeSlot1 to PCIeSlot6, Slot1NICPort1 to Slot16NICPort8, and Slot21NICPort1 to Slot21NICPort8.</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">EmbeddedNIC</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port1</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port2</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port3</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port4</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port5</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port6</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port7</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port8</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot1</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot2</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot3</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot4</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot5</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot6</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot7</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot8</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot9</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort8</command:parameterValue> </command:parameterValueGroup> <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>PrebootNetworkProxy</maml:name> <maml:description> <maml:para>Configures the pre-boot network proxy for network operations. When set, network operations for 'Pre-Boot Network Interface' are attempted through the configured proxy. The proxy must be in a HTTP URL format, and can be specified as http://IPv4_address:port, http://IPv6 address:port or http://FQDN: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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4</maml:name> <maml:description> <maml:para>Enables or disables the pre-boot network IPv4 configuration from a DHCP server. By default, the system BIOS enables DHCPv4 IPv4 network address configuration and makes IPv4 address, subnet mask, gateway, and DNS settings unavailable because values are supplied automatically. 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>None</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>Sets the static IPv4 address for pre-boot network configuration. Enter a static IP address using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv4SubnetMask</maml:name> <maml:description> <maml:para>Sets the static IPv4 subnet mask for pre-boot network configuration. Enter a static IP address using dotted-decimal notation (for example, 255.255.255.0). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv4Gateway</maml:name> <maml:description> <maml:para>Sets the static gateway IPv4 address for pre-boot network configuration. Enter a static IP address using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv4PrimaryDNS</maml:name> <maml:description> <maml:para>Sets the IPv4 address of the primary DNS server for pre-boot network configuration. Enter a static IP address using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv4SecondaryDNS</maml:name> <maml:description> <maml:para>Sets the IPv4 address of the secondary DNS server for pre-boot network configuration. Enter a static IP address using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv6ConfigPolicy</maml:name> <maml:description> <maml:para>Enables or disables the pre-boot network IPv6 configuration policy. When set to Automatic, this option enables obtaining the pre-boot network IPv6 configuration automatically. Individual settings are not available. When set to Manual, you must configure static IP address settings individually. Possible values are Automatic and Manual.</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">Manual</command:parameterValue> </command:parameterValueGroup> <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>IPv6Address</maml:name> <maml:description> <maml:para>Sets the static IPv6 address for pre-boot network configuration. Enter a static IP address in the standard colon separated format (for example, 1234::1000). If IPv6 Config Policy is set to Automatic, this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv6Gateway</maml:name> <maml:description> <maml:para>Sets the static gateway IPv6 address for pre-boot network configuration. Enter a static IP address in the standard colon separated format (for example, 1234::1000). If IPv6 Config Policy is set to Automatic, this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv6PrimaryDNS</maml:name> <maml:description> <maml:para>Sets the IPv6 address of the primary DNS server for pre-boot network configuration. Enter a static IP address in the standard colon separated format (for example, 1234::1000). If IPv6 Config Policy is set to Automatic, this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv6SecondaryDNS</maml:name> <maml:description> <maml:para>Sets the IPv6 address of the secondary DNS server for pre-boot network configuration. Enter a static IP address in the standard colon separated format (for example, 1234::1000). If IPv6 Config Policy is set to Automatic, this setting is unavailable because the value is supplied automatically.</maml:para> </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>BootFromURL</maml:name> <maml:description> <maml:para>Configures a network URL to a bootable ISO or EFI file. Enter a URL in HTTP or FTP formats are accepted using either an IPv4 server address or host name. For example, this can be http://192.168.0.0/file/image.iso or http://example.com/file/image.efi. IPv6 server addresses are not supported. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting the boot option downloads the file to the system memory and attempts booting from it. This setting requires configuring the pre-boot network settings to access the URL location. It is supported only in UEFI boot mode.</maml:para> <maml:para>Note: Booting from an ISO file is limited to files that enable the system to boot a preliminary OS environment (such as WinPE or a mini Linux) where further installation can proceed over an OS network connection. ISO files that contain the full OS installation media are not supported.</maml:para> </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>BootFromURL1</maml:name> <maml:description> <maml:para>Configures a network URL 1 to a bootable ISO or EFI file. Enter a URL in HTTP/HTTPS using either an IPv4 or IPv6 server address, or using a host name. For example, the URLs can be in any of the following formats: http://192.168.0.1/file/image.iso, http://example.com/file/image.efi, https://example.com/file/image.efi, and http://[1234::1000]/image.iso. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting this boot option downloads the file to the system memory and configures the system to attempt to boot from it. There is no specific ordering on this option. It can be independently ordered in the boot menu. This setting requires configuring the 'Pre-Boot Network Interface' option if you want to access the URL location through a specific network interface. When an HTTPS URL is configured, this setting requires enrolling the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options. This is only applicable in UEFI Mode.</maml:para> <maml:para>Note: Booting from an ISO file can involve only booting a preliminary OS environment image, such as WinPE or a mini Linux, or a complete OS install image if the OS supports the HTTP Boot feature (Old OS versions may not support this). Please check your OS documentation for the HTTP Boot feature support.</maml:para> </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>BootFromURL2</maml:name> <maml:description> <maml:para>Configures a network URL 2 to a bootable ISO or EFI file. Enter a URL in HTTP/HTTPS using either an IPv4 or IPv6 server address, or using a host name. For example, the URLs can be in any of the following formats: http://192.168.0.1/file/image.iso, http://example.com/file/image.efi, https://example.com/file/image.efi, and http://[1234::1000]/image.iso. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting this boot option downloads the file to the system memory and configures the system to attempt to boot from it. There is no specific ordering on this option. It can be independently ordered in the boot menu. This setting requires configuring the 'Pre-Boot Network Interface' option if you want to access the URL location through a specific network interface. When an HTTPS URL is configured, this setting requires enrolling the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options. This is only applicable in UEFI Mode.</maml:para> <maml:para>Note: Booting from an ISO file can involve only booting a preliminary OS environment image, such as WinPE or a mini Linux, or a complete OS install image if the OS supports the HTTP Boot feature (Old OS versions may not support this). Please check your OS documentation for the HTTP Boot feature support.</maml:para> </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>BootFromURL3</maml:name> <maml:description> <maml:para>Configures a network URL 3 to a bootable ISO or EFI file. Enter a URL in HTTP/HTTPS using either an IPv4 or IPv6 server address, or using a host name. For example, the URLs can be in any of the following formats: http://192.168.0.1/file/image.iso, http://example.com/file/image.efi, https://example.com/file/image.efi, and http://[1234::1000]/image.iso. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting this boot option downloads the file to the system memory and configures the system to attempt to boot from it. There is no specific ordering on this option. It can be independently ordered in the boot menu. This setting requires configuring the 'Pre-Boot Network Interface' option if you want to access the URL location through a specific network interface. When an HTTPS URL is configured, this setting requires enrolling the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options. This is only applicable in UEFI Mode.</maml:para> <maml:para>Note: Booting from an ISO file can involve only booting a preliminary OS environment image, such as WinPE or a mini Linux, or a complete OS install image if the OS supports the HTTP Boot feature (Old OS versions may not support this). Please check your OS documentation for the HTTP Boot feature support.</maml:para> </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>BootFromURL4</maml:name> <maml:description> <maml:para>Configures a network URL 4 to a bootable ISO or EFI file. Enter a URL in HTTP/HTTPS using either an IPv4 or IPv6 server address, or using a host name. For example, the URLs can be in any of the following formats: http://192.168.0.1/file/image.iso, http://example.com/file/image.efi, https://example.com/file/image.efi, and http://[1234::1000]/image.iso. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting this boot option downloads the file to the system memory and configures the system to attempt to boot from it. There is no specific ordering on this option. It can be independently ordered in the boot menu. This setting requires configuring the 'Pre-Boot Network Interface' option if you want to access the URL location through a specific network interface. When an HTTPS URL is configured, this setting requires enrolling the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options. This is only applicable in UEFI Mode.</maml:para> <maml:para>Note: Booting from an ISO file can involve only booting a preliminary OS environment image, such as WinPE or a mini Linux, or a complete OS install image if the OS supports the HTTP Boot feature (Old OS versions may not support this). Please check your OS documentation for the HTTP Boot feature support.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PrebootNetworkEnvironmentPolicy</maml:name> <maml:description> <maml:para>Sets the preference of network boot targets for pre-boot network in the UEFI Boot Order list.</maml:para> <maml:para>On Gen9 servers, When both IPv4 and IPv6 are enabled, each network boot target appears twice in the UEFI Boot Order list (one for IPv4 and the other for IPv6). Configure this option only when UEFI Boot Mode is set. Possible values are Auto, IPv4ThenIPv6, IPv4, IPv6, and IPv6ThenIPv4.</maml:para> <maml:para>On Gen10 servers, if configured for Auto, all the network operations initiated in the pre-boot environment occur over IPv4 or IPv6. The order of the existing network boot targets is not modified in the UEFI Boot Order list. New network boot targets are added to the end of the list using the default policy of the System BIOS. If configured for IPv4, all the network operations initiated in the pre-boot environment only occur over IPv4. All existing IPv6 network boot targets are removed in the UEFI Boot Order. No new IPv6 network boot targets are added to the list. If configured for IPv6, all the network operations initiated in the pre boot environment only occur over IPv6. All existing IPv4 network boot targets in the UEFI Boot Order are removed. No new IPv4 network boot targets are added to the list. Possible values are Auto, IPv4, and IPv6.</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">IPv4</command:parameterValue> <command:parameterValue required="false" variableLength="false">IPv4ThenIPv6</command:parameterValue> <command:parameterValue required="false" variableLength="false">IPv6</command:parameterValue> <command:parameterValue required="false" variableLength="false">IPv6ThenIPv4</command:parameterValue> </command:parameterValueGroup> <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>IPv6DHCPUniqueIdentifer</maml:name> <maml:description> <maml:para>Selects how the UEFI BIOS obtains the DHCP Unique Identifier (DUID) for IPv6 PXE Boot. DHCPv6 clients use this identifier to get an IP address from a DHCPv6 server. By default, the system uses the server's Unique Universal Identifier (UUID). Possible values are Auto and DUID-LLT.</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">DUID-LLT</command:parameterValue> </command:parameterValueGroup> <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>NetworkBootRetrySupport</maml:name> <maml:description> <maml:para>Enables or disables the network boot retry function. When enabled, the system BIOS attempts to boot the network device up to 20 times before attempting to boot the next network device on Gen8 and Gen9 servers. On Gen10 servers, the system BIOS attempts to boot the network device for the number of times configured in the Network Boot Retry Count option before attempting to boot the next network device. This setting only takes effect when attempting to boot a network device from the F12 function key and one-time boot options. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NetworkBootRetryCount</maml:name> <maml:description> <maml:para>Configures the network boot retry count to control the number of times the system BIOS attempts to boot a network device. Possible values are 0 to 20.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HTTPSupport</maml:name> <maml:description> <maml:para>Specifies the UEFI HTTP(s) boot support when in UEFI Mode. Possible values are Auto, HTTPOnly, HTTPSOnly, and Disabled.</maml:para> <maml:para>If 'Auto' is selected, the system automatically adds HTTP(S) boot options to the UEFI Boot Order list for every network port that is enabled for Network Boot. Selecting this option enables the system to boot to the HTTP or HTTPS URLs provided by the DHCP server. Any other URLs provided by the DHCP server are ignored.</maml:para> <maml:para>If 'HTTP only' is selected, the system automatically adds HTTP boot options to the UEFI Boot Order list for every network port that is enabled for Network Boot. Selecting this option enables the system to boot to the HTTP URLs provided by the DHCP server, and to ignore any HTTPS or other URLs that are provided.</maml:para> <maml:para>If 'HTTPS only' is selected, the system automatically adds HTTPS boot options to the UEFI Boot Order list for every network port that is enabled for Network Boot. Selecting this option enables the system to boot to the HTTPS URLs provided by the DHCP server, and to ignore any HTTP or other URLs that are provided. To enable HTTPS boot either by selecting 'Auto' or 'HTTPS only', you must enroll the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options.</maml:para> <maml:para>Note: This setting only affects the HTTP boot options added for the network ports, and the Discover Shell Auto-Start Script provided by the DHCP server. Other settings, such as Boot from URL, are not affected by this setting.</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">HTTPOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">HTTPSOnly</command:parameterValue> </command:parameterValueGroup> <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>iSCSIBootPolicy</maml:name> <maml:description> <maml:para>Configures the iSCSI boot policy to access the iSCSI targets. Possible values are SoftwareInitiator and AdapterInitiator.</maml:para> <maml:para>SoftwareInitiator - the iSCSI software initiator will be used to access iSCSI targets on any configured NIC ports. AdapterInitiator - the adapter-specific iSCSI initiator will be used instead. The adapter firmware must be configured to access iSCSI targets from the adapter initiator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">SoftwareInitiator</command:parameterValue> <command:parameterValue required="false" variableLength="false">AdapterInitiator</command:parameterValue> </command:parameterValueGroup> <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>PrebootNetworkInterface</maml:name> <maml:description> <maml:para>Specifies the network interface used for pre-boot network connections. If the selected NIC has more than one port, only the first port with a network connection is used. When the selection is Auto, the system uses the first available port with a network connection. Devices listed vary from system to system. Possible values are Auto, EmbeddedNIC, EmbeddedNICPort1 to EmbeddedNICPort8, EmbeddedFlexLOM1, EmbeddedFlexLOM1Port1 to EmbeddedFlexLOM1Port8, PCIeSlot1 to PCIeSlot6, Slot1NICPort1 to Slot16NICPort8, and Slot21NICPort1 to Slot21NICPort8.</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">EmbeddedNIC</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedNICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port1</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port2</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port3</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port4</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port5</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port6</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port7</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedFlexLOM1Port8</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot1</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot2</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot3</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot4</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot5</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot6</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot7</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot8</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeSlot9</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot1NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot2NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot3NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot4NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot5NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot6NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot7NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot8NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot9NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot10NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot11NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot12NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot13NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot14NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot15NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot16NICPort8</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort3</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort5</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort6</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort7</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slot21NICPort8</command:parameterValue> </command:parameterValueGroup> <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>PrebootNetworkProxy</maml:name> <maml:description> <maml:para>Configures the pre-boot network proxy for network operations. When set, network operations for 'Pre-Boot Network Interface' are attempted through the configured proxy. The proxy must be in a HTTP URL format, and can be specified as http://IPv4_address:port, http://IPv6 address:port or http://FQDN: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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DHCPv4</maml:name> <maml:description> <maml:para>Enables or disables the pre-boot network IPv4 configuration from a DHCP server. By default, the system BIOS enables DHCPv4 IPv4 network address configuration and makes IPv4 address, subnet mask, gateway, and DNS settings unavailable because values are supplied automatically. 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>None</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>Sets the static IPv4 address for pre-boot network configuration. Enter a static IP address using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv4SubnetMask</maml:name> <maml:description> <maml:para>Sets the static IPv4 subnet mask for pre-boot network configuration. Enter a static IP address using dotted-decimal notation (for example, 255.255.255.0). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv4Gateway</maml:name> <maml:description> <maml:para>Sets the static gateway IPv4 address for pre-boot network configuration. Enter a static IP address using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv4PrimaryDNS</maml:name> <maml:description> <maml:para>Sets the IPv4 address of the primary DNS server for pre-boot network configuration. Enter a static IP address using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv4SecondaryDNS</maml:name> <maml:description> <maml:para>Sets the IPv4 address of the secondary DNS server for pre-boot network configuration. Enter a static IP address using dotted-decimal notation (for example, 127.0.0.1). If DHCP is used (DHCPv4 option is enabled), this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv6ConfigPolicy</maml:name> <maml:description> <maml:para>Enables or disables the pre-boot network IPv6 configuration policy. When set to Automatic, this option enables obtaining the pre-boot network IPv6 configuration automatically. Individual settings are not available. When set to Manual, you must configure static IP address settings individually. Possible values are Automatic and Manual.</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">Manual</command:parameterValue> </command:parameterValueGroup> <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>IPv6Address</maml:name> <maml:description> <maml:para>Sets the static IPv6 address for pre-boot network configuration. Enter a static IP address in the standard colon separated format (for example, 1234::1000). If IPv6 Config Policy is set to Automatic, this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv6Gateway</maml:name> <maml:description> <maml:para>Sets the static gateway IPv6 address for pre-boot network configuration. Enter a static IP address in the standard colon separated format (for example, 1234::1000). If IPv6 Config Policy is set to Automatic, this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv6PrimaryDNS</maml:name> <maml:description> <maml:para>Sets the IPv6 address of the primary DNS server for pre-boot network configuration. Enter a static IP address in the standard colon separated format (for example, 1234::1000). If IPv6 Config Policy is set to Automatic, this setting is unavailable because the value is supplied automatically.</maml:para> </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>IPv6SecondaryDNS</maml:name> <maml:description> <maml:para>Sets the IPv6 address of the secondary DNS server for pre-boot network configuration. Enter a static IP address in the standard colon separated format (for example, 1234::1000). If IPv6 Config Policy is set to Automatic, this setting is unavailable because the value is supplied automatically.</maml:para> </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>BootFromURL</maml:name> <maml:description> <maml:para>Configures a network URL to a bootable ISO or EFI file. Enter a URL in HTTP or FTP formats are accepted using either an IPv4 server address or host name. For example, this can be http://192.168.0.0/file/image.iso or http://example.com/file/image.efi. IPv6 server addresses are not supported. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting the boot option downloads the file to the system memory and attempts booting from it. This setting requires configuring the pre-boot network settings to access the URL location. It is supported only in UEFI boot mode.</maml:para> <maml:para>Note: Booting from an ISO file is limited to files that enable the system to boot a preliminary OS environment (such as WinPE or a mini Linux) where further installation can proceed over an OS network connection. ISO files that contain the full OS installation media are not supported.</maml:para> </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>BootFromURL1</maml:name> <maml:description> <maml:para>Configures a network URL 1 to a bootable ISO or EFI file. Enter a URL in HTTP/HTTPS using either an IPv4 or IPv6 server address, or using a host name. For example, the URLs can be in any of the following formats: http://192.168.0.1/file/image.iso, http://example.com/file/image.efi, https://example.com/file/image.efi, and http://[1234::1000]/image.iso. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting this boot option downloads the file to the system memory and configures the system to attempt to boot from it. There is no specific ordering on this option. It can be independently ordered in the boot menu. This setting requires configuring the 'Pre-Boot Network Interface' option if you want to access the URL location through a specific network interface. When an HTTPS URL is configured, this setting requires enrolling the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options. This is only applicable in UEFI Mode.</maml:para> <maml:para>Note: Booting from an ISO file can involve only booting a preliminary OS environment image, such as WinPE or a mini Linux, or a complete OS install image if the OS supports the HTTP Boot feature (Old OS versions may not support this). Please check your OS documentation for the HTTP Boot feature support.</maml:para> </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>BootFromURL2</maml:name> <maml:description> <maml:para>Configures a network URL 2 to a bootable ISO or EFI file. Enter a URL in HTTP/HTTPS using either an IPv4 or IPv6 server address, or using a host name. For example, the URLs can be in any of the following formats: http://192.168.0.1/file/image.iso, http://example.com/file/image.efi, https://example.com/file/image.efi, and http://[1234::1000]/image.iso. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting this boot option downloads the file to the system memory and configures the system to attempt to boot from it. There is no specific ordering on this option. It can be independently ordered in the boot menu. This setting requires configuring the 'Pre-Boot Network Interface' option if you want to access the URL location through a specific network interface. When an HTTPS URL is configured, this setting requires enrolling the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options. This is only applicable in UEFI Mode.</maml:para> <maml:para>Note: Booting from an ISO file can involve only booting a preliminary OS environment image, such as WinPE or a mini Linux, or a complete OS install image if the OS supports the HTTP Boot feature (Old OS versions may not support this). Please check your OS documentation for the HTTP Boot feature support.</maml:para> </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>BootFromURL3</maml:name> <maml:description> <maml:para>Configures a network URL 3 to a bootable ISO or EFI file. Enter a URL in HTTP/HTTPS using either an IPv4 or IPv6 server address, or using a host name. For example, the URLs can be in any of the following formats: http://192.168.0.1/file/image.iso, http://example.com/file/image.efi, https://example.com/file/image.efi, and http://[1234::1000]/image.iso. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting this boot option downloads the file to the system memory and configures the system to attempt to boot from it. There is no specific ordering on this option. It can be independently ordered in the boot menu. This setting requires configuring the 'Pre-Boot Network Interface' option if you want to access the URL location through a specific network interface. When an HTTPS URL is configured, this setting requires enrolling the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options. This is only applicable in UEFI Mode.</maml:para> <maml:para>Note: Booting from an ISO file can involve only booting a preliminary OS environment image, such as WinPE or a mini Linux, or a complete OS install image if the OS supports the HTTP Boot feature (Old OS versions may not support this). Please check your OS documentation for the HTTP Boot feature support.</maml:para> </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>BootFromURL4</maml:name> <maml:description> <maml:para>Configures a network URL 4 to a bootable ISO or EFI file. Enter a URL in HTTP/HTTPS using either an IPv4 or IPv6 server address, or using a host name. For example, the URLs can be in any of the following formats: http://192.168.0.1/file/image.iso, http://example.com/file/image.efi, https://example.com/file/image.efi, and http://[1234::1000]/image.iso. When configured, this URL is listed as a boot option in the UEFI boot menu. Selecting this boot option downloads the file to the system memory and configures the system to attempt to boot from it. There is no specific ordering on this option. It can be independently ordered in the boot menu. This setting requires configuring the 'Pre-Boot Network Interface' option if you want to access the URL location through a specific network interface. When an HTTPS URL is configured, this setting requires enrolling the respective TLS certificate of the HTTPS server under Server Security > TLS(HTTPS) Options. This is only applicable in UEFI Mode.</maml:para> <maml:para>Note: Booting from an ISO file can involve only booting a preliminary OS environment image, such as WinPE or a mini Linux, or a complete OS install image if the OS supports the HTTP Boot feature (Old OS versions may not support this). Please check your OS documentation for the HTTP Boot feature support.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSNetworkBootOption -PrebootNetworkEnvironmentPolicy Auto -IPv6DHCPUniqueIdentifer Auto -NetworkBootRetrySupport Enabled -PrebootNetworkInterface Auto -DHCPv4 Disabled -IPv4Address 192.168.20.10 -IPv4SubnetMask 255.255.255.0 -IPv4Gateway 192.168.20.1 -IPv4PrimaryDNS 10.20.30.40 -IPv4SecondaryDNS 10.20.30.41 -BootFromURL ftp://10.20.30.42/file/image.iso</dev:code> <dev:remarks> <maml:para>This example sets PrebootNetworkEnvironmentPolicy, IPv6DHCPUniqueIdentifer, NetworkBootRetrySupport, PrebootNetworkInterface, DHCPv4, IPv4Address, IPv4SubnetMask, IPv4Gateway, IPv4PrimaryDNS, IPv4SecondaryDNS, and BootFromURL to specified values on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSNetworkBootOption -PrebootNetworkEnvironmentPolicy Auto -IPv6DHCPUniqueIdentifer Auto -NetworkBootRetrySupport Enabled -NetworkBootRetryCount 2 -HTTPSupport HTTPSOnly -PrebootNetworkInterface EmbeddedNICPort1 -PrebootNetworkProxy https://10.20.30.50:1234 -DHCPv4 Disabled -IPv4Address 192.168.10.10 -IPv4SubnetMask 255.255.255.0 -IPv4Gateway 192.168.10.1 -BootFromURL1 https://example.com/image.efi</dev:code> <dev:remarks> <maml:para>This example sets PrebootNetworkEnvironmentPolicy, IPv6DHCPUniqueIdentifer, NetworkBootRetrySupport, NetworkBootRetryCount, HTTPSupport, PrebootNetworkInterface, PrebootNetworkProxy, DHCPv4, IPv4Address, IPv4SubnetMask, IPv4Gateway, and BootFromURL1 to specified values on a Gen10 AMD server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSNetworkBootOption -PrebootNetworkEnvironmentPolicy IPv6 -IPv6DHCPUniqueIdentifer DUID-LLT -NetworkBootRetrySupport Enabled -NetworkBootRetryCount 2 -HTTPSupport Auto -iSCSIBootPolicy SoftwareInitiator -PrebootNetworkInterface Auto -PrebootNetworkProxy http://[FE80::FE15:FFFF:FE00:0000]:1234 -DHCPv4 Enabled -IPv4Address 0.0.0.0 -IPv4SubnetMask 0.0.0.0 -IPv4Gateway 0.0.0.0 -IPv4PrimaryDNS 0.0.0.0 -IPv4SecondaryDNS 0.0.0.0 -IPv6ConfigPolicy Automatic -IPv6Address :: -IPv6Gateway :: -IPv6PrimaryDNS :: -IPv6SecondaryDNS :: -BootFromURL1 http://[1234::1000]/image.iso -BootFromURL2 https://example.com/image.efi -BootFromURL3 "" -BootFromURL4 ""</dev:code> <dev:remarks> <maml:para>This example sets PrebootNetworkEnvironmentPolicy, IPv6DHCPUniqueIdentifer, NetworkBootRetrySupport, NetworkBootRetryCount, HTTPSupport, iSCSIBootPolicy, PrebootNetworkInterface, PrebootNetworkProxy, DHCPv4, IPv4Address, IPv4SubnetMask, IPv4Gateway, IPv4PrimaryDNS, IPv4SecondaryDNS, IPv6ConfigPolicy, IPv6Address, IPv6Gateway, IPv6PrimaryDNS, IPv6SecondaryDNS, BootFromURL1, BootFromURL2, BootFromURL3, and BootFromURL4 to specified values on a Gen10 Intel server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSNetworkBootOption -Connection $connection -PrebootNetworkEnvironmentPolicy Auto,IPv4ThenIPv6 -IPv6DHCPUniqueIdentifer Auto,DUID-LLT -NetworkBootRetrySupport Enabled,Disabled -PrebootNetworkInterface Auto,EmbeddedFlexLOM1 -DHCPv4 Disabled,Enabled -IPv4Address 192.168.20.10,192.168.0.1 -IPv4SubnetMask 255.255.255.0,255.255.255.0 -IPv4Gateway 192.168.20.1,192.168.20.2 -IPv4PrimaryDNS 10.20.30.40,10.20.30.50 -IPv4SecondaryDNS 10.20.30.41,10.20.30.51 -BootFromURL ftp://10.20.30.42/file/image.iso,http://example.com/file/image.efi</dev:code> <dev:remarks> <maml:para>This example sets PrebootNetworkEnvironmentPolicy, IPv6DHCPUniqueIdentifer, NetworkBootRetrySupport, PrebootNetworkInterface, DHCPv4, IPv4Address, IPv4SubnetMask, IPv4Gateway, IPv4PrimaryDNS, IPv4SecondaryDNS, and BootFromURL to specified values on Gen9 servers with a list of BIOS 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSNetworkBootOption -Connection $connection -PrebootNetworkEnvironmentPolicy IPv6,IPv4 -IPv6DHCPUniqueIdentifer DUID-LLT,Auto -NetworkBootRetrySupport Enabled,Disabled -NetworkBootRetryCount 2,0 -HTTPSupport Auto,HTTPOnly -PrebootNetworkInterface Auto,EmbeddedNICPort1 -PrebootNetworkProxy http://[FE80::FE15:FFFF:FE00:0000]:1234,http://192.168.0.1:2345 -DHCPv4 Enabled,Disabled -IPv4Address 0.0.0.0,192.168.20.1 -IPv4SubnetMask 0.0.0.0,255.255.255.0 -IPv4Gateway 0.0.0.0,192.168.20.1 -IPv4PrimaryDNS 0.0.0.0,10.20.30.50 -IPv4SecondaryDNS 0.0.0.0,10.20.30.51 -IPv6ConfigPolicy Automatic,Manual -IPv6Address ::,FE80::FE15:00FF:FE97:2D00 -IPv6Gateway ::,FE80::FE15:00FF:FE97:0000 -IPv6PrimaryDNS ::,FE80::FE15:00FF:FE97:2000 -IPv6SecondaryDNS ::,FE80::FE15:00FF:FE97:2001 -BootFromURL1 http://[1234::1000]/image.iso,http://192.168.0.1/file/image.iso -BootFromURL2 https://example.com/image.efi,http://example.com/file/image.efi -BootFromURL3 "",http://[1234::1000]/image.iso -BootFromURL4 "",https://example.com/file/image.efi</dev:code> <dev:remarks> <maml:para>This example sets PrebootNetworkEnvironmentPolicy, IPv6DHCPUniqueIdentifer, NetworkBootRetrySupport, NetworkBootRetryCount, HTTPSupport, PrebootNetworkInterface, PrebootNetworkProxy, DHCPv4, IPv4Address, IPv4SubnetMask, IPv4Gateway, IPv4PrimaryDNS, IPv4SecondaryDNS, IPv6ConfigPolicy, IPv6Address, IPv6Gateway, IPv6PrimaryDNS, IPv6SecondaryDNS, BootFromURL1, BootFromURL2, BootFromURL3, and BootFromURL4 to specified values on Gen10 AMD servers with a list of BIOS connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 6</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSNetworkBootOption -Connection $connection -PrebootNetworkEnvironmentPolicy IPv6,IPv4 -IPv6DHCPUniqueIdentifer DUID-LLT,Auto -NetworkBootRetrySupport Enabled,Disabled -NetworkBootRetryCount 2,0 -HTTPSupport Auto,HTTPOnly -iSCSIBootPolicy SoftwareInitiator,AdapterInitiator -PrebootNetworkInterface Auto,EmbeddedNICPort1 -PrebootNetworkProxy http://[FE80::FE15:FFFF:FE00:0000]:1234,http://192.168.0.1:2345 -DHCPv4 Enabled,Disabled -IPv4Address 0.0.0.0,192.168.20.1 -IPv4SubnetMask 0.0.0.0,255.255.255.0 -IPv4Gateway 0.0.0.0,192.168.20.1 -IPv4PrimaryDNS 0.0.0.0,10.20.30.50 -IPv4SecondaryDNS 0.0.0.0,10.20.30.51 -IPv6ConfigPolicy Automatic,Manual -IPv6Address ::,FE80::FE15:00FF:FE97:2D00 -IPv6Gateway ::,FE80::FE15:00FF:FE97:0000 -IPv6PrimaryDNS ::,FE80::FE15:00FF:FE97:2000 -IPv6SecondaryDNS ::,FE80::FE15:00FF:FE97:2001 -BootFromURL1 http://[1234::1000]/image.iso,http://192.168.0.1/file/image.iso -BootFromURL2 https://example.com/image.efi,http://example.com/file/image.efi -BootFromURL3 "",http://[1234::1000]/image.iso -BootFromURL4 "",https://example.com/file/image.efi</dev:code> <dev:remarks> <maml:para>This example sets PrebootNetworkEnvironmentPolicy, IPv6DHCPUniqueIdentifer, NetworkBootRetrySupport, NetworkBootRetryCount, HTTPSupport, iSCSIBootPolicy, PrebootNetworkInterface, PrebootNetworkProxy, DHCPv4, IPv4Address, IPv4SubnetMask, IPv4Gateway, IPv4PrimaryDNS, IPv4SecondaryDNS, IPv6ConfigPolicy, IPv6Address, IPv6Gateway, IPv6PrimaryDNS, IPv6SecondaryDNS, BootFromURL1, BootFromURL2, BootFromURL3, and BootFromURL4 to specified values on Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSNetworkBootOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSNodeInterleaving</command:name> <maml:description> <maml:para>The Set-HPEBIOSNodeInterleaving cmdlet sets the BIOS Node Interleaving configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSNodeInterleaving</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSNodeInterleaving cmdlet sets the BIOS Node Interleaving configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· NodeInterleaving</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSNodeInterleaving</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>NodeInterleaving</maml:name> <maml:description> <maml:para>Enables or disables NUMA node interleaving. Typically, you can obtain optimum performance on NUMA nodes by leaving this option disabled (the default setting). When this option is enabled, memory addresses are interleaved across the memory installed for each processor and some workloads might experience improved performance. Enabling Node Interleaving can impact operating system performance. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>NodeInterleaving</maml:name> <maml:description> <maml:para>Enables or disables NUMA node interleaving. Typically, you can obtain optimum performance on NUMA nodes by leaving this option disabled (the default setting). When this option is enabled, memory addresses are interleaved across the memory installed for each processor and some workloads might experience improved performance. Enabling Node Interleaving can impact operating system performance. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSNodeInterleaving -NodeInterleaving Disabled</dev:code> <dev:remarks> <maml:para>This example sets NodeInterleaving to specified value on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSNodeInterleaving -Connection $connection -NodeInterleaving Enabled</dev:code> <dev:remarks> <maml:para>This example sets NodeInterleaving to specified value on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSNodeInterleaving -Connection $connection -NodeInterleaving Enabled,Disabled,Enabled</dev:code> <dev:remarks> <maml:para>This example sets NodeInterleaving to specified values on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSNodeInterleaving</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSNVDIMMConfiguration</command:name> <maml:description> <maml:para>The Set-HPEBIOSNVDIMMConfiguration cmdlet sets the BIOS NVDIMM configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSNVDIMMConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSNVDIMMConfiguration cmdlet sets the BIOS NVDIMM configuration. This cmdlet has the following parameters:</maml:para> <maml:para>· NVDIMMFunctionality (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· NVDIMMMemoryInterleaving (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· NVDIMMSanitizePolicy (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· NVDIMMIntegrityChecking (only available on Gen9 servers)</maml:para> <maml:para>· NVDIMMForcedRecovery (only available on Gen9 servers)</maml:para> <maml:para>· NVDIMMOSLabelSupport (only available on Gen10 with Intel processor servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSNVDIMMConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>NVDIMMFunctionality</maml:name> <maml:description> <maml:para>Enables or Disables the NVDIMM-N support. If this option is Enabled, the NVDIMM of type NVDIMM-N is used for backing up the contents of the memory to flash on power down or reset. If this option is Disabled, the NVDIMMs of type NVDIMM-N in the system are NOT used by the operating system as persistent storage, and are NOT used by the operating system as system memory. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NVDIMMMemoryInterleaving</maml:name> <maml:description> <maml:para>Controls whether the NVDIMMs of type NVDIMM-N installed on a particular processor will be interleaved with each other in the memory map. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note:- If this setting is changed, all installed NVDIMMs of type NVDIMM-N must be sanitized.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NVDIMMSanitizePolicy</maml:name> <maml:description> <maml:para>Sanitize/Erase all user data and error status data saved in the selected NVDIMMs of type NVDIMM-N. Possible values are Disabled, SanitizeAndBootToFirmwareUI, SanitizeAndRebootSystem, SanitizeAndShutdownSystem, and SanitizeToFactoryDefaults.</maml:para> <maml:para>There are 3 policies which control the action of the system after NVDIMMs of type NVDIMM-N are sanitized/erased. The options are to power off the system after sanitizing/erasing NVDIMMs (SanitizeAndShutdownSystem), to allow the system to boot to the operating system after sanitizing/erasing NVDIMMs (SanitizeAndRebootSystem), to boot to the System Utilities after sanitizing/erasing NVDIMMs (SanitizeAndBootToFirmwareUI), or to sanitize/erase the NVDIMMs back to the factory default settings and power off the system. 'Sanitize/Erase to Factory Defaults and Power System Off' is recommended when retiring the NVDIMMs with no intention of reuse.</maml:para> <maml:para>Note: After reboot and NVDIMM sanitization, it restores the NVDIMM Sanitize policy 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">SanitizeAndRebootSystem</command:parameterValue> <command:parameterValue required="false" variableLength="false">SanitizeAndShutdownSystem</command:parameterValue> <command:parameterValue required="false" variableLength="false">SanitizeAndBootToFirmwareUI</command:parameterValue> <command:parameterValue required="false" variableLength="false">SanitizeToFactoryDefaults</command:parameterValue> </command:parameterValueGroup> <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>NVDIMMIntegrityChecking</maml:name> <maml:description> <maml:para>Enables or disables the integrity of the data check that is stored on the NVDIMM-N during system boot. If any data cannot be read, the NVDIMM-N will be mapped out (not usable by the operating system).If this option is disabled, an NVDIMM-N that has problems reading data or that has bad data may result in the system getting uncorrectable errors that result in machine checks or system resets. Enable this option to ensure any NVDIMM-Ns which are made visible to the operating system operate appropriately. Enabling this option increases system boot time. Each installed NVDIMM-N results in an increased boot time of several seconds. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NVDIMMForcedRecovery</maml:name> <maml:description> <maml:para>Enables or disables all NVDIMM-N devices which had been mapped out of the system (and thus not available to the operating system) due to uncorrectable errors. The devices are mapped back in on the next boot. This option only takes effect on the next reboot. If an NVDIMM-N experiences any additional uncorrectable errors, it will be mapped out again. This option can be utilized to assist in recovery of data on an NVDIMM-N that had experienced an error but may be functional again. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NVDIMMOSLabelSupport</maml:name> <maml:description> <maml:para>Enables or disables enable NVDIMM OS Label support through _LSI, _LSR, and _LSW ACPI methods. When this option is enabled, the ACPI methods is generated for each active NVDIMM in the system. When this option is disabled, those methods are not generated. This option does NOT apply to Intel Optane Memory devices. Possible 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>NVDIMMFunctionality</maml:name> <maml:description> <maml:para>Enables or Disables the NVDIMM-N support. If this option is Enabled, the NVDIMM of type NVDIMM-N is used for backing up the contents of the memory to flash on power down or reset. If this option is Disabled, the NVDIMMs of type NVDIMM-N in the system are NOT used by the operating system as persistent storage, and are NOT used by the operating system as system memory. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NVDIMMMemoryInterleaving</maml:name> <maml:description> <maml:para>Controls whether the NVDIMMs of type NVDIMM-N installed on a particular processor will be interleaved with each other in the memory map. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note:- If this setting is changed, all installed NVDIMMs of type NVDIMM-N must be sanitized.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NVDIMMSanitizePolicy</maml:name> <maml:description> <maml:para>Sanitize/Erase all user data and error status data saved in the selected NVDIMMs of type NVDIMM-N. Possible values are Disabled, SanitizeAndBootToFirmwareUI, SanitizeAndRebootSystem, SanitizeAndShutdownSystem, and SanitizeToFactoryDefaults.</maml:para> <maml:para>There are 3 policies which control the action of the system after NVDIMMs of type NVDIMM-N are sanitized/erased. The options are to power off the system after sanitizing/erasing NVDIMMs (SanitizeAndShutdownSystem), to allow the system to boot to the operating system after sanitizing/erasing NVDIMMs (SanitizeAndRebootSystem), to boot to the System Utilities after sanitizing/erasing NVDIMMs (SanitizeAndBootToFirmwareUI), or to sanitize/erase the NVDIMMs back to the factory default settings and power off the system. 'Sanitize/Erase to Factory Defaults and Power System Off' is recommended when retiring the NVDIMMs with no intention of reuse.</maml:para> <maml:para>Note: After reboot and NVDIMM sanitization, it restores the NVDIMM Sanitize policy 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">SanitizeAndRebootSystem</command:parameterValue> <command:parameterValue required="false" variableLength="false">SanitizeAndShutdownSystem</command:parameterValue> <command:parameterValue required="false" variableLength="false">SanitizeAndBootToFirmwareUI</command:parameterValue> <command:parameterValue required="false" variableLength="false">SanitizeToFactoryDefaults</command:parameterValue> </command:parameterValueGroup> <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>NVDIMMIntegrityChecking</maml:name> <maml:description> <maml:para>Enables or disables the integrity of the data check that is stored on the NVDIMM-N during system boot. If any data cannot be read, the NVDIMM-N will be mapped out (not usable by the operating system).If this option is disabled, an NVDIMM-N that has problems reading data or that has bad data may result in the system getting uncorrectable errors that result in machine checks or system resets. Enable this option to ensure any NVDIMM-Ns which are made visible to the operating system operate appropriately. Enabling this option increases system boot time. Each installed NVDIMM-N results in an increased boot time of several seconds. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NVDIMMForcedRecovery</maml:name> <maml:description> <maml:para>Enables or disables all NVDIMM-N devices which had been mapped out of the system (and thus not available to the operating system) due to uncorrectable errors. The devices are mapped back in on the next boot. This option only takes effect on the next reboot. If an NVDIMM-N experiences any additional uncorrectable errors, it will be mapped out again. This option can be utilized to assist in recovery of data on an NVDIMM-N that had experienced an error but may be functional again. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NVDIMMOSLabelSupport</maml:name> <maml:description> <maml:para>Enables or disables enable NVDIMM OS Label support through _LSI, _LSR, and _LSW ACPI methods. When this option is enabled, the ACPI methods is generated for each active NVDIMM in the system. When this option is disabled, those methods are not generated. This option does NOT apply to Intel Optane Memory devices. Possible 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSNVDIMMConfiguration -NVDIMMFunctionality Enabled -NVDIMMMemoryInterleaving Enabled -NVDIMMSanitizePolicy SanitizeAndRebootSystem -NVDIMMIntegrityChecking Enabled -NVDIMMForcedRecovery Enabled | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=The feature(s) listed in AffectedAttribute might get modified to specified values due to dependency on NVDIMMFunctionality,NVDIMMSanitizePolicy.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]}</dev:code> <dev:remarks> <maml:para>This example sets NVDIMMFunctionality, NVDIMMMemoryInterleaving, NVDIMMSanitizePolicy, NVDIMMIntegrityChecking, and NVDIMMForcedRecovery to specified values on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSNVDIMMConfiguration -NVDIMMFunctionality Enabled -NVDIMMMemoryInterleaving Disabled -NVDIMMSanitizePolicy SanitizeToFactoryDefaults -NVDIMMOSLabelSupport Enabled | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=The feature(s) listed in AffectedAttribute might get modified to specified values due to dependency on NVDIMMFunctionality.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]}</dev:code> <dev:remarks> <maml:para>This example sets NVDIMMFunctionality, NVDIMMMemoryInterleaving, NVDIMMSanitizePolicy, and NVDIMMOSLabelSupport to specified values on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSNVDIMMConfiguration -Connection $connection -NVDIMMFunctionality Enabled -NVDIMMMemoryInterleaving Enabled,Disabled -NVDIMMSanitizePolicy SanitizeAndRebootSystem,Disabled -NVDIMMIntegrityChecking Enabled,Disabled -NVDIMMForcedRecovery Enabled,Disabled | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=The feature(s) listed in AffectedAttribute might get modified to specified values due to dependency on NVDIMMFunctionality,NVDIMMSanitizePolicy.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]} IP : 10.20.30.2 Hostname : abc2.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=The feature(s) listed in AffectedAttribute might get modified to specified values due to dependency on NVDIMMFunctionality,NVDIMMSanitizePolicy.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]}</dev:code> <dev:remarks> <maml:para>This example sets NVDIMMFunctionality, NVDIMMMemoryInterleaving, NVDIMMSanitizePolicy, NVDIMMIntegrityChecking, and NVDIMMForcedRecovery to specified values on Gen9 servers with a list of BIOS 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSNVDIMMConfiguration -Connection $connection -NVDIMMFunctionality Enabled -NVDIMMMemoryInterleaving Enabled,Disabled -NVDIMMSanitizePolicy Disabled,SanitizeAndRebootSystem -NVDIMMOSLabelSupport Enabled,Disabled | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=The feature(s) listed in AffectedAttribute might get modified to specified values due to dependency on NVDIMMFunctionality,NVDIMMSanitizePolicy.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]} IP : 10.20.30.2 Hostname : abc2.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=The feature(s) listed in AffectedAttribute might get modified to specified values due to dependency on NVDIMMFunctionality.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]}</dev:code> <dev:remarks> <maml:para>This example sets NVDIMMFunctionality, NVDIMMMemoryInterleaving, NVDIMMSanitizePolicy, and NVDIMMOSLabelSupport to specified values on Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSNVDIMMConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPCIDeviceConfiguration</command:name> <maml:description> <maml:para>The Set-HPEBIOSPCIDeviceConfiguration cmdlet sets the BIOS PCI device configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSPCIDeviceConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSPCIDeviceConfiguration cmdlet sets the BIOS PCI device configuration. This cmdlet has the following parameters:</maml:para> <maml:para>. PCIDevice (only available on Gen10 servers)</maml:para> <maml:para>. PCIeLinkSpeed (only available on Gen10 servers)</maml:para> <maml:para>. PCIePowerManagement (only available on Gen10 servers)</maml:para> <maml:para>. PCIeOptionROM (only available on Gen10 servers)</maml:para> <maml:para>. Bifurcation (only available on Gen10 servers)</maml:para> <maml:para>. EnablePCIDevice (only available on Gen10 servers)</maml:para> <maml:para>. DisablePCIDevice (only available on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="EnablePCIDeviceSet" default="true"> <!--NAME: EnablePCIDeviceSet--> <!--TAG: DEFAULT--> <maml:name>Set-HPEBIOSPCIDeviceConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PCIDevice</maml:name> <maml:description> <maml:para>Specify PCI Device name to set the configuration. Possible values are EmbeddedSAS1, EmbeddedNIC, FlexibleLOM1, FlexibleLOM2, EmbeddedSATA1, EmbeddedSATA2, EmbeddedSATA3, EmbeddedSATA4, PCISlot1, PCISlot2, PCISlot3, PCISlot4, PCISlot5, PCISlot6, PCISlot7, PCISlot8, PCISlot9, PCISlot10, PCISlot11, PCISlot12, PCISlot13, PCISlot14, PCISlot15, and PCISlot16.</maml:para> <maml:para>Note: Use [HPE.BIOS.PCIDeviceForGen10] enum to get all possible values.</maml:para> <maml:para>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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIeLinkSpeed</maml:name> <maml:description> <maml:para>Configure the PCIe link speed for corresponding PCI device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. Possible values are Auto, PCIeGeneration1, and PCIeGeneration2. EmbeddedSATA does not support this parameter.</maml:para> <maml:para>Note: Use [HPE.BIOS.PCIeLinkSpeed] enum to get all possible values.</maml:para> <maml:para>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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIePowerManagement</maml:name> <maml:description> <maml:para>Configure the PCIe Link Power Management (ASPM) support for the selected device. Possible values are Auto, Disabled, and L1Enabled.</maml:para> <maml:para>Note: Use [HPE.BIOS.PCIePowerManagement] enum to get all possible values.</maml:para> <maml:para>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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIeOptionROM</maml:name> <maml:description> <maml:para>Enables or Disables the PCI Device Option ROM. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note: Use [HPE.BIOS.PCIeOptionROM] enum to get all possible values.</maml:para> <maml:para>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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Bifurcation</maml:name> <maml:description> <maml:para>Selects to bifurcate the selected PCIe slot. Possible values are Auto and SlotBifurcated. When Auto is selected, the PCIe slot trains at the maximum width supported by the slot and end point. When Slot Bifurcated is selected, the PCIe slot is bifurcated into two equal width slots. Note: Select Slot Bifurcated only if the device installed in the slot supports this capability.</maml:para> </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="false" position="named"> <maml:name>EnablePCIDevice</maml:name> <maml:description> <maml:para>Enables the PCI device.</maml:para> <maml:para>ParameterSetName: EnablePCIDeviceSet</maml:para> </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="DisablePCIDeviceSet"> <!--NAME: DisablePCIDeviceSet--> <maml:name>Set-HPEBIOSPCIDeviceConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PCIDevice</maml:name> <maml:description> <maml:para>Specify PCI Device name to set the configuration. Possible values are EmbeddedSAS1, EmbeddedNIC, FlexibleLOM1, FlexibleLOM2, EmbeddedSATA1, EmbeddedSATA2, EmbeddedSATA3, EmbeddedSATA4, PCISlot1, PCISlot2, PCISlot3, PCISlot4, PCISlot5, PCISlot6, PCISlot7, PCISlot8, PCISlot9, PCISlot10, PCISlot11, PCISlot12, PCISlot13, PCISlot14, PCISlot15, and PCISlot16.</maml:para> <maml:para>Note: Use [HPE.BIOS.PCIDeviceForGen10] enum to get all possible values.</maml:para> <maml:para>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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIeLinkSpeed</maml:name> <maml:description> <maml:para>Configure the PCIe link speed for corresponding PCI device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. Possible values are Auto, PCIeGeneration1, and PCIeGeneration2. EmbeddedSATA does not support this parameter.</maml:para> <maml:para>Note: Use [HPE.BIOS.PCIeLinkSpeed] enum to get all possible values.</maml:para> <maml:para>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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIePowerManagement</maml:name> <maml:description> <maml:para>Configure the PCIe Link Power Management (ASPM) support for the selected device. Possible values are Auto, Disabled, and L1Enabled.</maml:para> <maml:para>Note: Use [HPE.BIOS.PCIePowerManagement] enum to get all possible values.</maml:para> <maml:para>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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIeOptionROM</maml:name> <maml:description> <maml:para>Enables or Disables the PCI Device Option ROM. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note: Use [HPE.BIOS.PCIeOptionROM] enum to get all possible values.</maml:para> <maml:para>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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Bifurcation</maml:name> <maml:description> <maml:para>Selects to bifurcate the selected PCIe slot. Possible values are Auto and SlotBifurcated. When Auto is selected, the PCIe slot trains at the maximum width supported by the slot and end point. When Slot Bifurcated is selected, the PCIe slot is bifurcated into two equal width slots. Note: Select Slot Bifurcated only if the device installed in the slot supports this capability.</maml:para> </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="false" position="named"> <maml:name>DisablePCIDevice</maml:name> <maml:description> <maml:para>Disables the PCI device.</maml:para> <maml:para>ParameterSetName: DisablePCIDeviceSet</maml:para> </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" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session ParameterSetName: (All)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PCIDevice</maml:name> <maml:description> <maml:para>Specify PCI Device name to set the configuration. Possible values are EmbeddedSAS1, EmbeddedNIC, FlexibleLOM1, FlexibleLOM2, EmbeddedSATA1, EmbeddedSATA2, EmbeddedSATA3, EmbeddedSATA4, PCISlot1, PCISlot2, PCISlot3, PCISlot4, PCISlot5, PCISlot6, PCISlot7, PCISlot8, PCISlot9, PCISlot10, PCISlot11, PCISlot12, PCISlot13, PCISlot14, PCISlot15, and PCISlot16.</maml:para> <maml:para>Note: Use [HPE.BIOS.PCIDeviceForGen10] enum to get all possible values.</maml:para> <maml:para>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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIeLinkSpeed</maml:name> <maml:description> <maml:para>Configure the PCIe link speed for corresponding PCI device. When configured for Auto, the selected device trains at the maximum supported speed of the PCIe link. When configured for PCIe Generation 2 Link Speed, the selected device trains at a maximum of PCIe Generation 2 speed. Possible values are Auto, PCIeGeneration1, and PCIeGeneration2. EmbeddedSATA does not support this parameter.</maml:para> <maml:para>Note: Use [HPE.BIOS.PCIeLinkSpeed] enum to get all possible values.</maml:para> <maml:para>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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIePowerManagement</maml:name> <maml:description> <maml:para>Configure the PCIe Link Power Management (ASPM) support for the selected device. Possible values are Auto, Disabled, and L1Enabled.</maml:para> <maml:para>Note: Use [HPE.BIOS.PCIePowerManagement] enum to get all possible values.</maml:para> <maml:para>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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIeOptionROM</maml:name> <maml:description> <maml:para>Enables or Disables the PCI Device Option ROM. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note: Use [HPE.BIOS.PCIeOptionROM] enum to get all possible values.</maml:para> <maml:para>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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Bifurcation</maml:name> <maml:description> <maml:para>Selects to bifurcate the selected PCIe slot. Possible values are Auto and SlotBifurcated. When Auto is selected, the PCIe slot trains at the maximum width supported by the slot and end point. When Slot Bifurcated is selected, the PCIe slot is bifurcated into two equal width slots. Note: Select Slot Bifurcated only if the device installed in the slot supports this capability.</maml:para> </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="false" position="named"> <maml:name>EnablePCIDevice</maml:name> <maml:description> <maml:para>Enables the PCI device.</maml:para> <maml:para>ParameterSetName: EnablePCIDeviceSet</maml:para> </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>DisablePCIDevice</maml:name> <maml:description> <maml:para>Disables the PCI device.</maml:para> <maml:para>ParameterSetName: DisablePCIDeviceSet</maml:para> </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>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSPCIDeviceConfiguration -PCIDevice EmbeddedNIC -PCIeLinkSpeed Auto -PCIePowerManagement L1Enabled -PCIeOptionROM Enabled -EnablePCIDevice</dev:code> <dev:remarks> <maml:para>This example sets one PCI device configuration to specified values on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $pciDevice = ,@("EmbeddedNIC","EmbeddedSAS1","PCISlot1") PS C:\> $connection | Set-HPEBIOSPCIDeviceConfiguration -PCIDevice $pciDevice -Bifurcation Auto -DisablePCIDevice</dev:code> <dev:remarks> <maml:para>This example disables multiple PCI device configurations to specified values on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $pciDevice = ,@("EmbeddedNIC","EmbeddedSAS1","PCISlot4") PS C:\> $linkSpeed = ,@("PCIeGeneration1","PCIeGeneration2","Auto") PS C:\> $powerManagement = ,@("Auto","L1Enabled","Disabled") PS C:\> $optionROM = ,@("Enabled","Disabled","Enabled") PS C:\> Set-HPEBIOSPCIDeviceConfiguration -Connection $connection -PCIDevice $pciDevice -PCIeLinkSpeed $linkSpeed -PCIePowerManagement $powerManagement -PCIeOptionROM $optionROM -Bifurcation SlotBifurcated -EnablePCIDevice</dev:code> <dev:remarks> <maml:para>This example sets multiple PCI device configurations to specified values on a Gen10 server with connection object 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $pciDevice = @(@(EmbeddedNIC,EmbeddedSATA1,EmbeddedSATA2),@("EmbeddedNIC","EmbeddedSAS1","PCISlot3")) PS C:\> $linkSpeed = @(@(Auto),@("PCIeGeneration1","PCIeGeneration2","Auto")) PS C:\> $powerManagement = @(@(Auto),@("Auto","L1Enabled","Disabled")) PS C:\> $optionROM = @(@(Enabled),@("Enabled","Disabled","Enabled") PS C:\> Set-HPEBIOSPCIDeviceConfiguration -Connection $connection -PCIDevice $pciDevice -PCIeLinkSpeed $linkSpeed -PCIePowerManagement $powerManagement -PCIeOptionROM $optionROM</dev:code> <dev:remarks> <maml:para>This example sets multiple PCI device configurations to specified values on Gen10 servers with list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSPCIDeviceConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPCIePower</command:name> <maml:description> <maml:para>The Set-HPEBIOSPCIePower cmdlet sets the embedded PCI power configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSPCIePower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSPCIePower cmdlet sets the embedded PCI power configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· PCIeExpressECRCSupport (only available on Gen9 servers)</maml:para> <maml:para>· PCIExpressSupport</maml:para> <maml:para>· PCIeIOAllocation (only available on Gen9 servers)</maml:para> <maml:para>· PCIeResourcePadding (only available on Gen10 with Intel processor servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSPCIePower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PCIeExpressECRCSupport</maml:name> <maml:description> <maml:para>Controls the PCI Express End-to-End CRC (ECRC) policy for all installed PCIe Devices. When set to enabled, a PCI Express device that supports this option can take advantage of end-to-end CRC checking to increase the reliability of data transfers. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIExpressSupport</maml:name> <maml:description> <maml:para>Specifies the PCI-express speed for the server to lower the maximum PCI Express speed at which the server allows PCI Express devices to operate. Doing so can resolve issues with problematic PCI-express devices. Possible values for Gen8 AMD servers are Auto, PCIeGeneration1, and PCIeGeneration2. Possible values for Gen8 Intel servers and Gen9 servers are MaximumSupported and PCIeGeneration1. Possible values for Gen10 servers are PCIeGeneration1 and PerPortControl.</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">MaximumSupported</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeGeneration1</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeGeneration2</command:parameterValue> <command:parameterValue required="false" variableLength="false">PerPortControl</command:parameterValue> </command:parameterValueGroup> <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>PCIeIOAllocation</maml:name> <maml:description> <maml:para>Configures the allocation of PCIe I/O resources to each processor socket. When Balanced is selected, PCIe I/O resources are allocated equally between the processor sockets. When Unbalanced is selected, PCIe I/O resources are divided to provide more I/O resources to processors 1 and 4. Systems configured with a large number of PCIe adapters, such as GPUs, might require this option to be set to Unbalanced. Possible values are Balanced and Unbalanced.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Balanced</command:parameterValue> <command:parameterValue required="false" variableLength="false">Unbalanced</command:parameterValue> </command:parameterValueGroup> <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>PCIeResourcePadding</maml:name> <maml:description> <maml:para>Configures PCIe resources to support PCIe hot-add for NVMe drives. Possible values are Normal, Medium and High.</maml:para> <maml:para>Normal - PCIe resources are only allocated to devices installed at boot time, and PCIe hot-add is not supported.</maml:para> <maml:para>Medium - Additional PCIe resources are allocated for each PCIe Root Port, which might enable a PCIe hot-add event to work without requiring a system reboot to enumerate the device.</maml:para> <maml:para>High - A maximum amount of PCIe resources are set aside to allow for the best chance of supporting a PCIe hot-add event.</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">Medium</command:parameterValue> <command:parameterValue required="false" variableLength="false">High</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PCIeExpressECRCSupport</maml:name> <maml:description> <maml:para>Controls the PCI Express End-to-End CRC (ECRC) policy for all installed PCIe Devices. When set to enabled, a PCI Express device that supports this option can take advantage of end-to-end CRC checking to increase the reliability of data transfers. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PCIExpressSupport</maml:name> <maml:description> <maml:para>Specifies the PCI-express speed for the server to lower the maximum PCI Express speed at which the server allows PCI Express devices to operate. Doing so can resolve issues with problematic PCI-express devices. Possible values for Gen8 AMD servers are Auto, PCIeGeneration1, and PCIeGeneration2. Possible values for Gen8 Intel servers and Gen9 servers are MaximumSupported and PCIeGeneration1. Possible values for Gen10 servers are PCIeGeneration1 and PerPortControl.</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">MaximumSupported</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeGeneration1</command:parameterValue> <command:parameterValue required="false" variableLength="false">PCIeGeneration2</command:parameterValue> <command:parameterValue required="false" variableLength="false">PerPortControl</command:parameterValue> </command:parameterValueGroup> <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>PCIeIOAllocation</maml:name> <maml:description> <maml:para>Configures the allocation of PCIe I/O resources to each processor socket. When Balanced is selected, PCIe I/O resources are allocated equally between the processor sockets. When Unbalanced is selected, PCIe I/O resources are divided to provide more I/O resources to processors 1 and 4. Systems configured with a large number of PCIe adapters, such as GPUs, might require this option to be set to Unbalanced. Possible values are Balanced and Unbalanced.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Balanced</command:parameterValue> <command:parameterValue required="false" variableLength="false">Unbalanced</command:parameterValue> </command:parameterValueGroup> <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>PCIeResourcePadding</maml:name> <maml:description> <maml:para>Configures PCIe resources to support PCIe hot-add for NVMe drives. Possible values are Normal, Medium and High.</maml:para> <maml:para>Normal - PCIe resources are only allocated to devices installed at boot time, and PCIe hot-add is not supported.</maml:para> <maml:para>Medium - Additional PCIe resources are allocated for each PCIe Root Port, which might enable a PCIe hot-add event to work without requiring a system reboot to enumerate the device.</maml:para> <maml:para>High - A maximum amount of PCIe resources are set aside to allow for the best chance of supporting a PCIe hot-add event.</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">Medium</command:parameterValue> <command:parameterValue required="false" variableLength="false">High</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPCIePower -Connection $connection -PCIeExpressECRCSupport Enabled -PCIExpressSupport PCIeGeneration1 -PCIeIOAllocation Balanced</dev:code> <dev:remarks> <maml:para>This example sets PCIeExpressECRCSupport, PCIExpressSupport, and PCIeIOAllocation to specified values on a Gen9 server with 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPCIePower -Connection $connection -PCIExpressSupport PerPortControl -PCIeResourcePadding Normal</dev:code> <dev:remarks> <maml:para>This example sets PCIExpressSupport and to specified values on a Gen10 Intel server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPCIePower -Connection $connection -PCIeExpressECRCSupport Enabled,Disabled -PCIExpressSupport PCIeGeneration1,MaximumSupported -PCIeIOAllocation Balanced,Unbalanced</dev:code> <dev:remarks> <maml:para>This example sets PCIeExpressECRCSupport, PCIExpressSupport, and PCIeIOAllocation to specified values on Gen9 servers with list of BIOS 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPCIePower -Connection $connection -PCIExpressSupport PerPortControl,MaximumSupported -PCIeResourcePadding Medium,High</dev:code> <dev:remarks> <maml:para>This example sets PCIExpressSupport and PCIeResourcePadding to specified values on Gen10 Intel servers with list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSPCIePower</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPersistentMemoryConfiguration</command:name> <maml:description> <maml:para>The Set-HPEBIOSPersistentMemoryConfiguration cmdlet sets the persistent memory configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSPersistentMemoryConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSPersistentMemoryConfiguration cmdlet sets the persistent memory configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· PersistentMemoryAddressRangeScrub (only available on Gen10 with Intel processor servers)</maml:para> <maml:para>· PersistentMemoryBackupPowerPolicy (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· PersistentMemoryIntegrityCheck (only available on Gen10 with Intel processor servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSPersistentMemoryConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PersistentMemoryBackupPowerPolicy</maml:name> <maml:description> <maml:para>Controls whether the system waits during system boot for batteries to charge if sufficient battery backup power for the installed persistent memory is not available. If this option is configured for 'Continue Boot without Backup Power', the server boots even if sufficient battery backup power is not installed. In this case, if sufficient battery backup power is not enabled, the configured memory will not be used by the operating system as persistent storage or as system memory. Possible values are WaitForBackupPowerOnBoot and ContinueBootWithoutBackupPower.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">WaitForBackupPowerOnBoot</command:parameterValue> <command:parameterValue required="false" variableLength="false">ContinueBootWithoutBackupPower</command:parameterValue> </command:parameterValueGroup> <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>PersistentMemoryIntegrityCheck</maml:name> <maml:description> <maml:para>Enables or disables persistent memory scan during system boot to determine data integrity. Depending on the persistent memory address range scrub setting, discovered errors during the data integrity check will either be presented to the operating system for recovery or cause the persistent memory to be mapped out and unavailable to the operating system. If this option is disabled, any persistent memory that has problems reading data or which has bad data may result in uncorrectable errors that result in a system crash. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PersistentMemoryAddressRangeScrub</maml:name> <maml:description> <maml:para>Configures the NVDIMM memory Address Range Scrub support. When enabled, this option allows a supported OS to attempt recovery from an uncorrectable memory error detected in the NVDIMM memory. When disabled, the NVDIMM memory will be disabled on the following boot after detecting an uncorrectable memory error in the NVDIMM. If the NVDIMM memory Memory Interleaving option is enabled, a disabled NVDIMM will include all the modules or regions within the set. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PersistentMemoryBackupPowerPolicy</maml:name> <maml:description> <maml:para>Controls whether the system waits during system boot for batteries to charge if sufficient battery backup power for the installed persistent memory is not available. If this option is configured for 'Continue Boot without Backup Power', the server boots even if sufficient battery backup power is not installed. In this case, if sufficient battery backup power is not enabled, the configured memory will not be used by the operating system as persistent storage or as system memory. Possible values are WaitForBackupPowerOnBoot and ContinueBootWithoutBackupPower.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">WaitForBackupPowerOnBoot</command:parameterValue> <command:parameterValue required="false" variableLength="false">ContinueBootWithoutBackupPower</command:parameterValue> </command:parameterValueGroup> <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>PersistentMemoryIntegrityCheck</maml:name> <maml:description> <maml:para>Enables or disables persistent memory scan during system boot to determine data integrity. Depending on the persistent memory address range scrub setting, discovered errors during the data integrity check will either be presented to the operating system for recovery or cause the persistent memory to be mapped out and unavailable to the operating system. If this option is disabled, any persistent memory that has problems reading data or which has bad data may result in uncorrectable errors that result in a system crash. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PersistentMemoryAddressRangeScrub</maml:name> <maml:description> <maml:para>Configures the NVDIMM memory Address Range Scrub support. When enabled, this option allows a supported OS to attempt recovery from an uncorrectable memory error detected in the NVDIMM memory. When disabled, the NVDIMM memory will be disabled on the following boot after detecting an uncorrectable memory error in the NVDIMM. If the NVDIMM memory Memory Interleaving option is enabled, a disabled NVDIMM will include all the modules or regions within the set. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSPersistentMemoryConfiguration -PersistentMemoryBackupPowerPolicy WaitForBackupPowerOnBoot</dev:code> <dev:remarks> <maml:para>This example sets PersistentMemoryBackupPowerPolicy to specified value on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSPersistentMemoryConfiguration -PersistentMemoryBackupPowerPolicy WaitForBackupPowerOnBoot -PersistentMemoryIntegrityCheck Enabled -PersistentMemoryAddressRangeScrub Enabled</dev:code> <dev:remarks> <maml:para>This example sets PersistentMemoryBackupPowerPolicy, PersistentMemoryIntegrityCheck, and PersistentMemoryAddressRangeScrub to specified values on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPersistentMemoryConfiguration -Connection $connection -PersistentMemoryBackupPowerPolicy WaitForBackupPowerOnBoot,ContinueBootWithoutBackupPower</dev:code> <dev:remarks> <maml:para>This example sets PersistentMemoryBackupPowerPolicy to specified values on Gen9 servers with list of BIOS 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPersistentMemoryConfiguration -Connection $connection -PersistentMemoryBackupPowerPolicy WaitForBackupPowerOnBoot,ContinueBootWithoutBackupPower -PersistentMemoryIntegrityCheck Enabled,Disabled -PersistentMemoryAddressRangeScrub Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets PersistentMemoryBackupPowerPolicy, PersistentMemoryIntegrityCheck, and PersistentMemoryAddressRangeScrub to specified values on Gen10 Intel servers with list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSPersistentMemoryConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPowerCapping</command:name> <maml:description> <maml:para>The Set-HPEBIOSPowerCapping cmdlet sets the BIOS Dynamic Power Capping functionality.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSPowerCapping</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSPowerCapping cmdlet configures the BIOS Dynamic Power Capping functionality. This cmdlet has the following parameters.</maml:para> <maml:para>· DynamicPowerCappingFunctionality</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSPowerCapping</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>DynamicPowerCappingFunctionality</maml:name> <maml:description> <maml:para>Configures when the system ROM executes power calibration during the boot process. Possible values are Auto, Enabled, and Disabled.</maml:para> <maml:para>· Auto (available on Gen9 and Gen10 servers) - Power calibration runs the first time the server is booted and is only run again when the server’s hardware configuration settings change.</maml:para> <maml:para>· Enabled - Power calibration runs on every system boot.</maml:para> <maml:para>· Disabled - Power calibration does not run, and Dynamic Power Capping is not supported.</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">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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>DynamicPowerCappingFunctionality</maml:name> <maml:description> <maml:para>Configures when the system ROM executes power calibration during the boot process. Possible values are Auto, Enabled, and Disabled.</maml:para> <maml:para>· Auto (available on Gen9 and Gen10 servers) - Power calibration runs the first time the server is booted and is only run again when the server’s hardware configuration settings change.</maml:para> <maml:para>· Enabled - Power calibration runs on every system boot.</maml:para> <maml:para>· Disabled - Power calibration does not run, and Dynamic Power Capping is not supported.</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">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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSPowerCapping -DynamicPowerCappingFunctionality Disabled</dev:code> <dev:remarks> <maml:para>This example sets DynamicPowerCappingFunctionality to specified value on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPowerCapping -Connection $connection -DynamicPowerCappingFunctionality Enabled</dev:code> <dev:remarks> <maml:para>This example sets DynamicPowerCappingFunctionality to specified value on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPowerCapping -Connection $connection -DynamicPowerCappingFunctionality Enabled,Disabled,Auto</dev:code> <dev:remarks> <maml:para>This example sets DynamicPowerCappingFunctionality to specified values on Gen8, Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSPowerCapping</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPowerOnPassword</command:name> <maml:description> <maml:para>The Set-HPEBIOSPowerOnPassword cmdlet sets the BIOS Power On Password.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSPowerOnPassword</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSPowerOnPassword cmdlet sets a password for continuing the boot process. When rebooting the server, a prompt appears at the server boot screen to enter your password. This cmdlet is supported only on Gen9 and Gen10 servers. This cmdlet has the following parameters.</maml:para> <maml:para>· OldPowerOnPassword</maml:para> <maml:para>· NewPowerOnPassword</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSPowerOnPassword</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>NewPowerOnPassword</maml:name> <maml:description> <maml:para>Specifies the new BIOS Power On Password as input. The maximum password length is 31 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OldPowerOnPassword</maml:name> <maml:description> <maml:para>Specifies the current BIOS Power On Password. It provides an empty string as input for OldPowerOnPassword when setting the BIOS Power On Password for the first time. Otherwise, the current password is used as input for OldPowerOnPassword. The maximum password length is 31 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>NewPowerOnPassword</maml:name> <maml:description> <maml:para>Specifies the new BIOS Power On Password as input. The maximum password length is 31 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OldPowerOnPassword</maml:name> <maml:description> <maml:para>Specifies the current BIOS Power On Password. It provides an empty string as input for OldPowerOnPassword when setting the BIOS Power On Password for the first time. Otherwise, the current password is used as input for OldPowerOnPassword. The maximum password length is 31 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[]</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>• Rebooting the server is strongly recommended to apply password changes in BIOS. • For Gen10 servers, a new mechanism will throw an error for incorrect current admin password, if the password is already set. • For Gen9 servers, there is no mechanism to authenticate whether the entered current admin password is correct.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSPowerOnPassword -OldPowerOnPassword "" -NewPowerOnPassword test123 | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.}</dev:code> <dev:remarks> <maml:para>The BIOS power on password is not set. This example sets the BIOS power on password for the first time on a Gen9 or Gen10 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>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSPowerOnPassword -OldPowerOnPassword test123 -NewPowerOnPassword test456 | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.}</dev:code> <dev:remarks> <maml:para>The BIOS power on password is already set. This example shows how to modify or change the BIOS power on password on a Gen9 or Gen10 server.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPowerOnPassword -Connection $connection -OldPowerOnPassword test123,admin123 -NewPowerOnPassword test456,admin456 | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.} IP : 10.20.30.2 Hostname : abc2.domain.com Status : Information StatusInfo : @{Category=Usability; Message=HPE strongly recommend to reboot the system to apply password changes in BIOS.}</dev:code> <dev:remarks> <maml:para>The BIOS power on password is already set. This example shows how to modify or change the BIOS power on password on Gen9 and Gen10 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-HPEBIOSPowerOnPassword</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPowerProfile</command:name> <maml:description> <maml:para>The Set-HPEBIOSPowerProfile cmdlet sets the BIOS Power Profile configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSPowerProfile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSPowerProfile cmdlet sets the BIOS Power Profile configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· PowerProfile (available on Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSPowerProfile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PowerProfile</maml:name> <maml:description> <maml:para>Enables the user to select the appropriate power profile based on power and performance characteristics. Possible values are BalancedPowerAndPerformance, MinimumPowerUsage, MaximumPerformance, and Custom.</maml:para> <maml:para>· BalancedPowerAndPerformance - Provides optimum settings to maximize power savings with minimal impact to performance for most operating systems and applications.</maml:para> <maml:para>· MinimumPowerUsage - Enables power reduction mechanisms. This mode guarantees a lower maximum power usage by the system.</maml:para> <maml:para>· MaximumPerformance - Disables all power management options that can negatively affect performance.</maml:para> <maml:para>· Custom - Enables custom profile configuration. This mode makes all available settings for the power management options available.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BalancedPowerAndPerformance</command:parameterValue> <command:parameterValue required="false" variableLength="false">MinimumPowerUsage</command:parameterValue> <command:parameterValue required="false" variableLength="false">MaximumPerformance</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PowerProfile</maml:name> <maml:description> <maml:para>Enables the user to select the appropriate power profile based on power and performance characteristics. Possible values are BalancedPowerAndPerformance, MinimumPowerUsage, MaximumPerformance, and Custom.</maml:para> <maml:para>· BalancedPowerAndPerformance - Provides optimum settings to maximize power savings with minimal impact to performance for most operating systems and applications.</maml:para> <maml:para>· MinimumPowerUsage - Enables power reduction mechanisms. This mode guarantees a lower maximum power usage by the system.</maml:para> <maml:para>· MaximumPerformance - Disables all power management options that can negatively affect performance.</maml:para> <maml:para>· Custom - Enables custom profile configuration. This mode makes all available settings for the power management options available.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BalancedPowerAndPerformance</command:parameterValue> <command:parameterValue required="false" variableLength="false">MinimumPowerUsage</command:parameterValue> <command:parameterValue required="false" variableLength="false">MaximumPerformance</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[]</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $result = Set-HPEBIOSPowerProfile -Connection $connection -PowerProfile BalancedPowerAndPerformance PS C:\> $result | fl IP : 10.20.30.2 Hostname : abc2.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on PowerProfile.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]} PS C:\> $result.StatusInfo | fl Category : Dependency Message : Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on PowerProfile. AffectedAttribute : {[PowerRegulator, DynamicPowerSavingsMode], [IntelQPILinkPowerManagement, Enabled], [IntelQPILinkFrequency, Auto], [MinimumProcessorIdlePowerCoreState, C6State]...} PS C:\> $result.StatusInfo.AffectedAttribute Key Value --- ----- PowerRegulator DynamicPowerSavingsMode IntelQPILinkPowerManagement Enabled IntelQPILinkFrequency Auto MinimumProcessorIdlePowerCoreState C6State MinimumProcessorIdlePowerPackageState PackageC6State EnergyPerformanceBias BalancedPerformance MaximumMemoryBusFrequency Auto ChannelInterleaving Enabled PCIExpressSupport MaximumSupported</dev:code> <dev:remarks> <maml:para>This example sets PowerProfile to specified value on a Gen9 server with 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPowerProfile -Connection $connection -PowerProfile MinimumPowerUsage,MaximumPerformance | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on PowerProfile.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]} IP : 10.20.30.2 Hostname : abc2.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on PowerProfile.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]}</dev:code> <dev:remarks> <maml:para>This example sets PowerProfile to specified values on Gen9 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSPowerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPowerRegulator</command:name> <maml:description> <maml:para>The Set-HPEBIOSPowerRegulator cmdlet sets the BIOS Power Regulator configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSPowerRegulator</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSPowerRegulator cmdlet sets the BIOS Power Regulator configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· PowerRegulator (available on Gen10 with Intel processor and Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSPowerRegulator</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PowerRegulator</maml:name> <maml:description> <maml:para>Sets the Power Regulator mode for ProLiant support. These settings can help to increase server efficiency and manage power consumption. Possible values are DynamicPowerSavingsMode, OSControlMode, StaticHighPerformanceMode, and StaticLowPowerMode.</maml:para> <maml:para>· DynamicPowerSavingsMode - Automatically varies processor speed and power usage based on processor utilization. This mode uses an HP ROM-based algorithm to monitor processor activity. It can reduce overall power consumption with little or no impact to performance, and does not require OS support.</maml:para> <maml:para>· OSControlMode - Processors run in their maximum power and performance state at all times, unless the OS enables a power management policy.</maml:para> <maml:para>· StaticHighPerformanceMode - Processors run in the maximum power and performance state, regardless of the OS power management policy. This mode is useful in environments where performance is critical and power consumption is less important.</maml:para> <maml:para>· StaticLowPowerMode - Reduces processor speed and power usage. Guarantees a lower maximum power usage for the system. This mode is useful in environments where power availability is constrained and it is critical to lower the maximum power use of the system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DynamicPowerSavingsMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">OSControlMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">StaticHighPerformanceMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">StaticLowPowerMode</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>PowerRegulator</maml:name> <maml:description> <maml:para>Sets the Power Regulator mode for ProLiant support. These settings can help to increase server efficiency and manage power consumption. Possible values are DynamicPowerSavingsMode, OSControlMode, StaticHighPerformanceMode, and StaticLowPowerMode.</maml:para> <maml:para>· DynamicPowerSavingsMode - Automatically varies processor speed and power usage based on processor utilization. This mode uses an HP ROM-based algorithm to monitor processor activity. It can reduce overall power consumption with little or no impact to performance, and does not require OS support.</maml:para> <maml:para>· OSControlMode - Processors run in their maximum power and performance state at all times, unless the OS enables a power management policy.</maml:para> <maml:para>· StaticHighPerformanceMode - Processors run in the maximum power and performance state, regardless of the OS power management policy. This mode is useful in environments where performance is critical and power consumption is less important.</maml:para> <maml:para>· StaticLowPowerMode - Reduces processor speed and power usage. Guarantees a lower maximum power usage for the system. This mode is useful in environments where power availability is constrained and it is critical to lower the maximum power use of the system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DynamicPowerSavingsMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">OSControlMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">StaticHighPerformanceMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">StaticLowPowerMode</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSPowerRegulator -PowerRegulator StaticHighPerformanceMode</dev:code> <dev:remarks> <maml:para>This example sets PowerRegulator to specified value on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPowerRegulator -Connection $connection -PowerRegulator DynamicPowerSavingsMode</dev:code> <dev:remarks> <maml:para>This example sets PowerRegulator to specified value on a Gen10 Intel server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPowerRegulator -Connection $connection -PowerRegulator StaticHighPerformanceMode,DynamicPowerSavingsMode,OSControlMode</dev:code> <dev:remarks> <maml:para>This example sets PowerRegulator to specified values on Gen9, and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSPowerRegulator</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSPreferredIOOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSPreferredIOOption cmdlet sets the IO options.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSPreferredIOOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSPreferredIOOption cmdlet sets the IO options. This cmdlet has the following parameters.</maml:para> <maml:para>· IOBus- Specifies the bus number of the preferred IO device.</maml:para> <maml:para>· IODevice- Specifies the device number of the preferred IO device.</maml:para> <maml:para>· IOFunction - Specifies the function number of the preferred IO device.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSPreferredIOOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <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>IOBus</maml:name> <maml:description> <maml:para>Specifies the bus number of your preferred IO device. The valid range is 0 to 255.</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>IODevice</maml:name> <maml:description> <maml:para>Specifies the device number of your preferred IO device. The valid range is 0 to 31.</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>IOFunction</maml:name> <maml:description> <maml:para>Specifies the function number of your preferred IO device. The valid range is 0 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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <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>IOBus</maml:name> <maml:description> <maml:para>Specifies the bus number of your preferred IO device. The valid range is 0 to 255.</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>IODevice</maml:name> <maml:description> <maml:para>Specifies the device number of your preferred IO device. The valid range is 0 to 31.</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>IOFunction</maml:name> <maml:description> <maml:para>Specifies the function number of your preferred IO device. The valid range is 0 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: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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 C:\PS> $connection | Set-HPEBIOSPreferredIOOption -IOBus 2 -IODevice 5 -IOfunction 6 C:\PS></dev:code> <dev:remarks> <maml:para>This example sets IOBus, IODevice, and IOFunction to specified values on a Gen10 Plus AMD server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1, 10.20.30.2 -Username admin -Password admin123 C:\PS> Set-HPEBIOSPreferredIOOption -Connection $connection -IOBus 2 ,3 -IODevice 5,3 -IOfunction 6,1 C:\PS></dev:code> <dev:remarks> <maml:para>This example sets IOBus, IODevice, and IOFunction to specified values on a Gen10 Plus AMD server with the array of connection object passed as named parameter.</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>Set-HPEBIOSPrefetcher</command:name> <maml:description> <maml:para>The Set-HPEBIOSPrefectcher cmdlet sets the BIOS prefetching configuration of the processor.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSPrefetcher</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSPrefectcher cmdlet sets the BIOS prefetching configuration of the processor. This cmdlet has the following parameters.</maml:para> <maml:para>· AdjacentSectorPrefetch (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· DCUIPPrefetcher (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· DCUStreamerPrefetcher (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· HWPrefetcher (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· L1StreamHWPrefetcher (only available on Gen10 with AMD processor servers)</maml:para> <maml:para>· L2StreamHWPrefetcher (only available on Gen10 with AMD processor servers)</maml:para> <maml:para>· LLCPrefetcher (only available on Gen10 with Intel processor servers)</maml:para> <maml:para>· UPIPrefetcher (only available on Gen10 with Intel processor servers)</maml:para> <maml:para>· XPTPrefetcher (only available on Gen10 with Intel processor servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSPrefetcher</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AdjacentSectorPrefetch</maml:name> <maml:description> <maml:para>Controls processor prefetch features. This is a BIOS feature specific to the Intel Pentium 4 or newer processors, including Intel Xeon processors. When enabled, the processor will fetch the cache line containing the currently requested data, and prefetch the following cache line. When Disabled, the processor will only fetch the cache line containing the currently requested data. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DCUIPPrefetcher</maml:name> <maml:description> <maml:para>Controls DCU (Data Unit Cache) processor prefetching. Set this feature to Enabled to activate the L1 Data Prefetcher based on sequential load history. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DCUStreamerPrefetcher</maml:name> <maml:description> <maml:para>Controls DUC (Data Unit Cache) streamer processor prefetching. It is intended to speed up data accessed by a program by prefetching to the L1 data cache. DCU prefetching improves performance if data in large structures is arranged sequentially in the order used by the program. However, if data access patterns are sparse instead of local, some performance degradation can occur under high CPU load due to bandwidth issues. In such cases, disabling DCU Prefetcher may improve performance. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HWPrefetcher</maml:name> <maml:description> <maml:para>Controls processor prefetch features. The hardware prefetcher operates transparently, without programmer intervention, to fetch streams of data and instruction from memory into the unified second-level cache. The prefetcher is capable of handling multiple streams in either the forward or backward direction. It is triggered when successive cache misses occur in the last-level cache and a stride in the access pattern is detected, such as in the case of loop iterations that access array elements. The prefetching occurs up to a page boundary. This feature can be disabled through the BIOS. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>L1StreamHWPrefetcher</maml:name> <maml:description> <maml:para>Configures the L1 Stream HW prefetch feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>L2StreamHWPrefetcher</maml:name> <maml:description> <maml:para>Configures the L2 Stream HW prefetch feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LLCPrefetcher</maml:name> <maml:description> <maml:para>Configures the processor Last Level Cache (LLC) prefetch feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UPIPrefetcher</maml:name> <maml:description> <maml:para>Controls processor UPI prefetch features. In some cases, setting this option to disabled can improve performance. In most cases, the default value of enabled provides optimal performance. Only disable this option after performing application benchmarking to verify improved performance in the environment. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>XPTPrefetcher</maml:name> <maml:description> <maml:para>Controls processor XPT prefetch features. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment. This option must be enabled when Sub-Numa Clustering (SNC) is enabled. Possible values are Auto, Enabled and 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">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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AdjacentSectorPrefetch</maml:name> <maml:description> <maml:para>Controls processor prefetch features. This is a BIOS feature specific to the Intel Pentium 4 or newer processors, including Intel Xeon processors. When enabled, the processor will fetch the cache line containing the currently requested data, and prefetch the following cache line. When Disabled, the processor will only fetch the cache line containing the currently requested data. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DCUIPPrefetcher</maml:name> <maml:description> <maml:para>Controls DCU (Data Unit Cache) processor prefetching. Set this feature to Enabled to activate the L1 Data Prefetcher based on sequential load history. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DCUStreamerPrefetcher</maml:name> <maml:description> <maml:para>Controls DUC (Data Unit Cache) streamer processor prefetching. It is intended to speed up data accessed by a program by prefetching to the L1 data cache. DCU prefetching improves performance if data in large structures is arranged sequentially in the order used by the program. However, if data access patterns are sparse instead of local, some performance degradation can occur under high CPU load due to bandwidth issues. In such cases, disabling DCU Prefetcher may improve performance. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>HWPrefetcher</maml:name> <maml:description> <maml:para>Controls processor prefetch features. The hardware prefetcher operates transparently, without programmer intervention, to fetch streams of data and instruction from memory into the unified second-level cache. The prefetcher is capable of handling multiple streams in either the forward or backward direction. It is triggered when successive cache misses occur in the last-level cache and a stride in the access pattern is detected, such as in the case of loop iterations that access array elements. The prefetching occurs up to a page boundary. This feature can be disabled through the BIOS. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>L1StreamHWPrefetcher</maml:name> <maml:description> <maml:para>Configures the L1 Stream HW prefetch feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>L2StreamHWPrefetcher</maml:name> <maml:description> <maml:para>Configures the L2 Stream HW prefetch feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LLCPrefetcher</maml:name> <maml:description> <maml:para>Configures the processor Last Level Cache (LLC) prefetch feature. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>UPIPrefetcher</maml:name> <maml:description> <maml:para>Controls processor UPI prefetch features. In some cases, setting this option to disabled can improve performance. In most cases, the default value of enabled provides optimal performance. Only disable this option after performing application benchmarking to verify improved performance in the environment. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>XPTPrefetcher</maml:name> <maml:description> <maml:para>Controls processor XPT prefetch features. In some cases, setting this option to disabled can improve performance. Typically, setting this option to enabled provides better performance. Only disable this option after performing application benchmarking to verify improved performance in the environment. This option must be enabled when Sub-Numa Clustering (SNC) is enabled. Possible values are Auto, Enabled and 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">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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPrefetcher -Connection $connection -AdjacentSectorPrefetch Disabled -DCUIPPrefetcher Disabled -DCUStreamerPrefetcher Enabled -HWPrefetcher Enabled</dev:code> <dev:remarks> <maml:para>This example sets AdjacentSectorPrefetch, DCUIPPrefetcher, DCUStreamerPrefetcher, and HWPrefetcher to specified values on a Gen9 server with 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPrefetcher -Connection $connection -L1StreamHWPrefetcher Enabled -L2StreamHWPrefetcher Disabled</dev:code> <dev:remarks> <maml:para>This example sets L1StreamHWPrefetcher, and L2StreamHWPrefetcher to specified values on a Gen10 AMD server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.5 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPrefetcher -Connection $connection -AdjacentSectorPrefetch Enabled -DCUIPPrefetcher Enabled -DCUStreamerPrefetcher Enabled -HWPrefetcher Enabled -LLCPrefetcher Enabled -UPIPrefetcher Enabled -XPTPrefetcher Enabled</dev:code> <dev:remarks> <maml:para>This example sets AdjacentSectorPrefetch, DCUIPPrefetcher, DCUStreamerPrefetcher, HWPrefetcher, UPIPrefetcher, and XPTPrefetcher to specified values on a Gen10 Intel server with connection object passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPrefetcher -Connection $connection -AdjacentSectorPrefetch Enabled,Disabled -DCUIPPrefetcher Enabled,Disabled -DCUStreamerPrefetcher Enabled,Disabled -HWPrefetcher Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets AdjacentSectorPrefetch, DCUIPPrefetcher, DCUStreamerPrefetcher, and HWPrefetcher to specified values on Gen9 servers with a list of BIOS 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPrefetcher -Connection $connection -L1StreamHWPrefetcher Disabled,Enabled -L2StreamHWPrefetcher Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets L1StreamHWPrefetcher, and L2StreamHWPrefetcher to specified values on Gen10 AMD servers with a list of BIOS connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 6</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSPrefetcher -Connection $connection -AdjacentSectorPrefetch Enabled,Disabled -DCUIPPrefetcher Enabled,Disabled -DCUStreamerPrefetcher Enabled,Disabled -HWPrefetcher Enabled,Disabled -LLCPrefetcher Enabled,Disabled -UPIPrefetcher Enabled,Disabled -XPTPrefetcher Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets AdjacentSectorPrefetch, DCUIPPrefetcher, DCUStreamerPrefetcher, HWPrefetcher, LLCPrefetcher, UPIPrefetcher, and XPTPrefetcher to specified values on Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSPrefetcher</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSProcessorOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSProcessorOption cmdlet sets the BIOS configuration for the processor.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSProcessorOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSProcessorOption cmdlet sets the BIOS configuration for the processor. This cmdlet has the following parameters:</maml:para> <maml:para>· AMDCorePerformanceBoost (available on Gen10 with AMD processor servers)</maml:para> <maml:para>· IntelHyperthreading (available on Gen10 with Intel processor, and Gen8 servers)</maml:para> <maml:para>· NoExecuteMemoryProtection (available on Gen9 servers)</maml:para> <maml:para>· PerformanceDeterminism (only available on Gen10 servers with AMD processors)</maml:para> <maml:para>· ProcessorCoreEnable</maml:para> <maml:para>· ProcessorSMT (only available on Gen10 servers with AMD processors)</maml:para> <maml:para>· Processorx2APICSupport (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· SpeculativeLockScheduling (only available on Gen10 servers with AMD processors)</maml:para> <maml:para>· DeterminismControl (only available on Gen10 servers with AMD processors)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSProcessorOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AMDCorePerformanceBoost</maml:name> <maml:description> <maml:para>Enables the processor to transition to a higher frequency than the processor`s rated speed if the processor has available power headroom and is within temperature specifications. Disabling this feature reduces power usage, but also reduces the maximum achievable system performance under some workloads. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntelHyperthreading</maml:name> <maml:description> <maml:para>Allows Intel Hyperthreading Technology to be enabled or disabled. When enabled, each physical processor core operates as two logical processor cores. When disabled, each physical processor core operates as only one logical processor core. Enabling this option can improve overall performance for applications that benefit from a higher processor core count. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoExecuteMemoryProtection</maml:name> <maml:description> <maml:para>Enables to protect the systems against malicious code and viruses. Memory is marked as non-executable unless the location contains executable code. Some viruses attempt to insert and execute code from non-executable memory locations. Attacks are intercepted and an exception is generated. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note: The Operating system must support this option. Certain operating systems (including Windows 2012 and Windows 2012 R2) require this option to be enabled and override this setting. See your operating system documentation for more details.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PerformanceDeterminism</maml:name> <maml:description> <maml:para>Configures the AMD Processor for Performance or Power Determinism. Possible values are PerformanceDeterministic and PowerDeterministic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PerformanceDeterministic</command:parameterValue> <command:parameterValue required="false" variableLength="false">PowerDeterministic</command:parameterValue> </command:parameterValueGroup> <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>ProcessorCoreEnable</maml:name> <maml:description> <maml:para>Selects the number of cores that will be enabled per processor socket on server. Accepted values range from 0 to 28.</maml:para> <maml:para>Note: Entering an incorrect value results in no cores being disabled. 0 = Enable All Cores.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProcessorSMT</maml:name> <maml:description> <maml:para>Configures the AMD processor SMT. When enabled, each physical processor core operates as two logical processor cores. When disabled, each physical processor core operates as only one logical processor core. Enabling this option can improve overall performance for applications that benefit from a higher processor core count. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProcessorX2ApicSupport</maml:name> <maml:description> <maml:para>Allows operating systems to run more efficiently on high core count configurations and optimize interrupt distribution in virtualized environments. In most cases, set this option to enabled. This configures the operating system to optionally enable x2APIC support when it loads. Some older hypervisors and operating systems might have issues with optional x2APIC support, in which case disabling x2APIC might be necessary to address those issues. Additionally, some hypervisors and operating systems do not use X2APIC unless this option is set to Force Enabled prior to booting. Possible values are Enabled, Disabled, and ForceEnabled.</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:parameterValue required="false" variableLength="false">ForceEnabled</command:parameterValue> </command:parameterValueGroup> <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>SpeculativeLockScheduling</maml:name> <maml:description> <maml:para>Enables or disables the page table entry locks. Disabling this forces Page Table Entry locks to only be scheduled non-speculatively. Disabling this feature will impact performance. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DeterminismControl</maml:name> <maml:description> <maml:para>Use this option to configure AMD determinism control. Auto uses the processor fused values. Possible values are Auto and Manual.</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">Manual</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" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AMDCorePerformanceBoost</maml:name> <maml:description> <maml:para>Enables the processor to transition to a higher frequency than the processor`s rated speed if the processor has available power headroom and is within temperature specifications. Disabling this feature reduces power usage, but also reduces the maximum achievable system performance under some workloads. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntelHyperthreading</maml:name> <maml:description> <maml:para>Allows Intel Hyperthreading Technology to be enabled or disabled. When enabled, each physical processor core operates as two logical processor cores. When disabled, each physical processor core operates as only one logical processor core. Enabling this option can improve overall performance for applications that benefit from a higher processor core count. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoExecuteMemoryProtection</maml:name> <maml:description> <maml:para>Enables to protect the systems against malicious code and viruses. Memory is marked as non-executable unless the location contains executable code. Some viruses attempt to insert and execute code from non-executable memory locations. Attacks are intercepted and an exception is generated. Possible values are Enabled and Disabled.</maml:para> <maml:para>Note: The Operating system must support this option. Certain operating systems (including Windows 2012 and Windows 2012 R2) require this option to be enabled and override this setting. See your operating system documentation for more details.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>PerformanceDeterminism</maml:name> <maml:description> <maml:para>Configures the AMD Processor for Performance or Power Determinism. Possible values are PerformanceDeterministic and PowerDeterministic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">PerformanceDeterministic</command:parameterValue> <command:parameterValue required="false" variableLength="false">PowerDeterministic</command:parameterValue> </command:parameterValueGroup> <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>ProcessorCoreEnable</maml:name> <maml:description> <maml:para>Selects the number of cores that will be enabled per processor socket on server. Accepted values range from 0 to 28.</maml:para> <maml:para>Note: Entering an incorrect value results in no cores being disabled. 0 = Enable All Cores.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProcessorSMT</maml:name> <maml:description> <maml:para>Configures the AMD processor SMT. When enabled, each physical processor core operates as two logical processor cores. When disabled, each physical processor core operates as only one logical processor core. Enabling this option can improve overall performance for applications that benefit from a higher processor core count. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProcessorX2ApicSupport</maml:name> <maml:description> <maml:para>Allows operating systems to run more efficiently on high core count configurations and optimize interrupt distribution in virtualized environments. In most cases, set this option to enabled. This configures the operating system to optionally enable x2APIC support when it loads. Some older hypervisors and operating systems might have issues with optional x2APIC support, in which case disabling x2APIC might be necessary to address those issues. Additionally, some hypervisors and operating systems do not use X2APIC unless this option is set to Force Enabled prior to booting. Possible values are Enabled, Disabled, and ForceEnabled.</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:parameterValue required="false" variableLength="false">ForceEnabled</command:parameterValue> </command:parameterValueGroup> <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>SpeculativeLockScheduling</maml:name> <maml:description> <maml:para>Enables or disables the page table entry locks. Disabling this forces Page Table Entry locks to only be scheduled non-speculatively. Disabling this feature will impact performance. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DeterminismControl</maml:name> <maml:description> <maml:para>Use this option to configure AMD determinism control. Auto uses the processor fused values. Possible values are Auto and Manual.</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">Manual</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>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSProcessorOption -IntelHyperthreading Enabled -NoExecuteMemoryProtection Disabled -ProcessorCoreEnable 16 -ProcessorX2ApicSupport ForceEnabled</dev:code> <dev:remarks> <maml:para>This example sets IntelHyperthreading, NoExecuteMemoryProtection, ProcessorCoreEnable, and ProcessorX2ApicSupport to specified values on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> $connection = Set-HPEBIOSProcessorOption -AMDCorePerformanceBoost Enabled -PerformanceDeterminism PerformanceDeterministic -ProcessorCoreEnable 0 -ProcessorSMT Enabled -SpeculativeLockScheduling Enabled</dev:code> <dev:remarks> <maml:para>This example sets AMDCorePerformanceBoost, PerformanceDeterminism, ProcessorCoreEnable, ProcessorSMT, and SpeculativeLockScheduling to specified values on a Gen10 AMD server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.5 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSProcessorOption -IntelHyperthreading Enabled -ProcessorCoreEnable 0 -ProcessorX2ApicSupport Enabled</dev:code> <dev:remarks> <maml:para>This example sets IntelHyperthreading, ProcessorCoreEnable, and ProcessorX2ApicSupport to specified values on a Gen10 Intel server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSProcessorOption -Connection $connection -IntelHyperthreading Enabled,Disabled -NoExecuteMemoryProtection Disabled,Enabled -ProcessorCoreEnable 16,8 -ProcessorX2ApicSupport ForceEnabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets IntelHyperthreading, NoExecuteMemoryProtection, ProcessorCoreEnable, and ProcessorX2ApicSupport to specified values on Gen9 servers with a list of BIOS 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSProcessorOption -Connection $connection -AMDCorePerformanceBoost Enabled,Disabled -PerformanceDeterminism PerformanceDeterministic,PowerDeterministic -ProcessorCoreEnable 0,16 -ProcessorSMT Enabled,Disabled -SpeculativeLockScheduling Enabled,Disabled -DeterminismControl Auto</dev:code> <dev:remarks> <maml:para>This example sets AMDCorePerformanceBoost, PerformanceDeterminism, ProcessorCoreEnable, ProcessorSMT, SpeculativeLockScheduling, and DeterminismControl to specified values on Gen10 AMD servers with a list of BIOS connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 6</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSProcessorOption -Connection $connection -IntelHyperthreading Enabled,Disabled -ProcessorCoreEnable 0,8 -ProcessorX2ApicSupport Disabled,ForceEnabled</dev:code> <dev:remarks> <maml:para>This example sets IntelHyperthreading, ProcessorCoreEnable, and ProcessorX2ApicSupport to specified values on Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSProcessorOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSProcessorPower</command:name> <maml:description> <maml:para>The Set-HPEBIOSProcessorPower cmdlet sets the processor related power management settings.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSProcessorPower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSProcessorPower cmdlet sets the processor-related power management settings. This cmdlet has the following parameters:</maml:para> <maml:para>· CollaborativePowerControl (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· DynamicPowerSavingsModeResponse (available on Gen9 servers)</maml:para> <maml:para>· EnergyPerformanceBias (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· IntelDMILinkFrequency (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· MinimumProcessorIdlePowerCoreState (available on Gen9, and Gen10 servers)</maml:para> <maml:para>· MinimumProcessorIdlePowerPackageState (available on Gen10 with Intel processor and Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSProcessorPower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>CollaborativePowerControl</maml:name> <maml:description> <maml:para>Enables or disables the processor frequency changes even when the server has the Power Regulator option configured for Dynamic Power Savings Mode. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DynamicPowerSavingsModeResponse</maml:name> <maml:description> <maml:para>Selects the response time for switching between processor performance and power state depending on the processor workload. Possible values are Fast and Slow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fast</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slow</command:parameterValue> </command:parameterValueGroup> <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>EnergyPerformanceBias</maml:name> <maml:description> <maml:para>Selects the performance and power usage of the processor. Possible values are MaximumPerformance, BalancedPerformance, BalancedPower, and PowerSavingsMode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MaximumPerformance</command:parameterValue> <command:parameterValue required="false" variableLength="false">BalancedPerformance</command:parameterValue> <command:parameterValue required="false" variableLength="false">BalancedPower</command:parameterValue> <command:parameterValue required="false" variableLength="false">PowerSavingsMode</command:parameterValue> </command:parameterValueGroup> <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>IntelDMILinkFrequency</maml:name> <maml:description> <maml:para>Forces the link speed between the processor and south bridge to run at slower speeds. Doing so can reduce power consumption but can also impact system performance. Possible values are Auto, GEN1Speed, and GEN2Speed.</maml:para> <maml:para>Note: GEN2Speed is only available on Gen10 servers.</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">GEN1Speed</command:parameterValue> <command:parameterValue required="false" variableLength="false">GEN2Speed</command:parameterValue> </command:parameterValueGroup> <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>MinimumProcessorIdlePowerCoreState</maml:name> <maml:description> <maml:para>Selects the lowest idle power (C-State) of the processor that the operating system uses. The higher the C-State, the lower the power usage of that idle state. Possible values are C6State, C3State, C1EState, and NoCStates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">C6State</command:parameterValue> <command:parameterValue required="false" variableLength="false">C3State</command:parameterValue> <command:parameterValue required="false" variableLength="false">C1EState</command:parameterValue> <command:parameterValue required="false" variableLength="false">NoCStates</command:parameterValue> </command:parameterValueGroup> <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>MinimumProcessorIdlePowerPackageState</maml:name> <maml:description> <maml:para>Configures the lowest processor idle power state (C-State). The processor automatically transitions into package C-States based on the Core C-States in which cores on the processor have transitioned. The higher the package C-State, the lower the power usage of that idle package state. Possible values are NoPackageState, PackageC3State, and PackageC6State.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NoPackageState</command:parameterValue> <command:parameterValue required="false" variableLength="false">PackageC3State</command:parameterValue> <command:parameterValue required="false" variableLength="false">PackageC6State</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>CollaborativePowerControl</maml:name> <maml:description> <maml:para>Enables or disables the processor frequency changes even when the server has the Power Regulator option configured for Dynamic Power Savings Mode. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>DynamicPowerSavingsModeResponse</maml:name> <maml:description> <maml:para>Selects the response time for switching between processor performance and power state depending on the processor workload. Possible values are Fast and Slow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Fast</command:parameterValue> <command:parameterValue required="false" variableLength="false">Slow</command:parameterValue> </command:parameterValueGroup> <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>EnergyPerformanceBias</maml:name> <maml:description> <maml:para>Selects the performance and power usage of the processor. Possible values are MaximumPerformance, BalancedPerformance, BalancedPower, and PowerSavingsMode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MaximumPerformance</command:parameterValue> <command:parameterValue required="false" variableLength="false">BalancedPerformance</command:parameterValue> <command:parameterValue required="false" variableLength="false">BalancedPower</command:parameterValue> <command:parameterValue required="false" variableLength="false">PowerSavingsMode</command:parameterValue> </command:parameterValueGroup> <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>IntelDMILinkFrequency</maml:name> <maml:description> <maml:para>Forces the link speed between the processor and south bridge to run at slower speeds. Doing so can reduce power consumption but can also impact system performance. Possible values are Auto, GEN1Speed, and GEN2Speed.</maml:para> <maml:para>Note: GEN2Speed is only available on Gen10 servers.</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">GEN1Speed</command:parameterValue> <command:parameterValue required="false" variableLength="false">GEN2Speed</command:parameterValue> </command:parameterValueGroup> <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>MinimumProcessorIdlePowerCoreState</maml:name> <maml:description> <maml:para>Selects the lowest idle power (C-State) of the processor that the operating system uses. The higher the C-State, the lower the power usage of that idle state. Possible values are C6State, C3State, C1EState, and NoCStates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">C6State</command:parameterValue> <command:parameterValue required="false" variableLength="false">C3State</command:parameterValue> <command:parameterValue required="false" variableLength="false">C1EState</command:parameterValue> <command:parameterValue required="false" variableLength="false">NoCStates</command:parameterValue> </command:parameterValueGroup> <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>MinimumProcessorIdlePowerPackageState</maml:name> <maml:description> <maml:para>Configures the lowest processor idle power state (C-State). The processor automatically transitions into package C-States based on the Core C-States in which cores on the processor have transitioned. The higher the package C-State, the lower the power usage of that idle package state. Possible values are NoPackageState, PackageC3State, and PackageC6State.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NoPackageState</command:parameterValue> <command:parameterValue required="false" variableLength="false">PackageC3State</command:parameterValue> <command:parameterValue required="false" variableLength="false">PackageC6State</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSProcessorPower -CollaborativePowerControl Disabled -DynamicPowerSavingsModeResponse Slow -EnergyPerformanceBias PowerSavingsMode -IntelDMILinkFrequency Auto -MinimumProcessorIdlePowerCoreState C3State -MinimumProcessorIdlePowerPackageState PackageC3State</dev:code> <dev:remarks> <maml:para>This example sets CollaborativePowerControl, DynamicPowerSavingsModeResponse, EnergyPerformanceBias, IntelDMILinkFrequency, MinimumProcessorIdlePowerCoreState, and MinimumProcessorIdlePowerPackageState to specified values on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSProcessorPower -MinimumProcessorIdlePowerCoreState C6State</dev:code> <dev:remarks> <maml:para>This example sets MinimumProcessorIdlePowerCoreState to specified values on a Gen10 AMD or Gen10 Intel server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSProcessorPower -CollaborativePowerControl Disabled,Enabled -DynamicPowerSavingsModeResponse Slow,Fast -EnergyPerformanceBias PowerSavingsMode,MaximumPerformance -IntelDMILinkFrequency Auto,GEN1Speed -MinimumProcessorIdlePowerCoreState C3State,C6State -MinimumProcessorIdlePowerPackageState PackageC3State,PackageC6State</dev:code> <dev:remarks> <maml:para>This example sets CollaborativePowerControl, DynamicPowerSavingsModeResponse, EnergyPerformanceBias, IntelDMILinkFrequency, MinimumProcessorIdlePowerCoreState, and MinimumProcessorIdlePowerPackageState to specified values on Gen9 servers with a list of BIOS 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSProcessorPower -Connection $connection -MinimumProcessorIdlePowerCoreState NoCStates,C6State</dev:code> <dev:remarks> <maml:para>This example sets MinimumProcessorIdlePowerCoreState to specified values on Gen10 AMD and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSProcessorPower</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSQPI</command:name> <maml:description> <maml:para>The Set-HPEBIOSQPI cmdlet sets the BIOS QPI (QuickPath Interconnect) configuration of the processor.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSQPI</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSQPI cmdlet sets the BIOS QPI (QuickPath Interconnect) configuration of the processor as follows:</maml:para> <maml:para>· QPIBandwidthOptimization (available on Gen9 servers)</maml:para> <maml:para>· QPIHomeSnoopOptimization (only available on Gen9 servers)</maml:para> <maml:para>· QPISnoopConfiguration (only available on Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSQPI</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>QPIBandwidthOptimization</maml:name> <maml:description> <maml:para>Configures the QPI link between two processor for optimal performance. The Balanced option provides the best performance for most applications and benchmarks. The Optimized for IO option can increase bandwidth from I/O devices such as GPUs that rely on direct access to system memory. This option is only configurable if two or more CPUs are present. Possible values are Balanced and OptimizedForIO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Balanced</command:parameterValue> <command:parameterValue required="false" variableLength="false">OptimizedForIO</command:parameterValue> </command:parameterValueGroup> <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>QPIHomeSnoopOptimization</maml:name> <maml:description> <maml:para>Enables or disables the Directory and Opportunistic Snoop Broadcast (OSB) functionality that is available when the QPI snoop mode is set to Home Snoop. Directory and OSB provides better memory latency and increased bandwidth and is recommended for the vast majority of workloads that benefit from Home Snoop. Possible values are DirectoryOSBEnabled and DirectoryOSBDisabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DirectoryOSBEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">DirectoryOSBDisabled</command:parameterValue> </command:parameterValueGroup> <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>QPISnoopConfiguration</maml:name> <maml:description> <maml:para>Configures the snoop mode used by the processor and QPI bus. Changing this option can have an impact on memory performance. The Home Snoop option provides high-memory bandwidth in an average NUMA environment. The Cluster on Die option can provide increased memory bandwidth in highly optimized NUMA workloads. The Early Snoop option can decrease memory latency but can also result in lower overall bandwidth compared to the other modes. Possible values are Standard, EarlySnoop and ClusterOnDie.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Standard</command:parameterValue> <command:parameterValue required="false" variableLength="false">EarlySnoop</command:parameterValue> <command:parameterValue required="false" variableLength="false">ClusterOnDie</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>QPIBandwidthOptimization</maml:name> <maml:description> <maml:para>Configures the QPI link between two processor for optimal performance. The Balanced option provides the best performance for most applications and benchmarks. The Optimized for IO option can increase bandwidth from I/O devices such as GPUs that rely on direct access to system memory. This option is only configurable if two or more CPUs are present. Possible values are Balanced and OptimizedForIO.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Balanced</command:parameterValue> <command:parameterValue required="false" variableLength="false">OptimizedForIO</command:parameterValue> </command:parameterValueGroup> <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>QPIHomeSnoopOptimization</maml:name> <maml:description> <maml:para>Enables or disables the Directory and Opportunistic Snoop Broadcast (OSB) functionality that is available when the QPI snoop mode is set to Home Snoop. Directory and OSB provides better memory latency and increased bandwidth and is recommended for the vast majority of workloads that benefit from Home Snoop. Possible values are DirectoryOSBEnabled and DirectoryOSBDisabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DirectoryOSBEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">DirectoryOSBDisabled</command:parameterValue> </command:parameterValueGroup> <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>QPISnoopConfiguration</maml:name> <maml:description> <maml:para>Configures the snoop mode used by the processor and QPI bus. Changing this option can have an impact on memory performance. The Home Snoop option provides high-memory bandwidth in an average NUMA environment. The Cluster on Die option can provide increased memory bandwidth in highly optimized NUMA workloads. The Early Snoop option can decrease memory latency but can also result in lower overall bandwidth compared to the other modes. Possible values are Standard, EarlySnoop and ClusterOnDie.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Standard</command:parameterValue> <command:parameterValue required="false" variableLength="false">EarlySnoop</command:parameterValue> <command:parameterValue required="false" variableLength="false">ClusterOnDie</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSQPI -QPIBandwidthOptimization OptimizedForIO -QPIHomeSnoopOptimization DirectoryOSBEnabled -QPISnoopConfiguration ClusterOnDie</dev:code> <dev:remarks> <maml:para>This example sets QPIBandwidthOptimization, QPIHomeSnoopOptimization, and QPISnoopConfiguration to specified values on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSQPI -Connection $connection -QPIBandwidthOptimization OptimizedForIO,Balanced -QPIHomeSnoopOptimization DirectoryOSBEnabled,DirectoryOSBDisabled -QPISnoopConfiguration ClusterOnDie,EarlySnoop</dev:code> <dev:remarks> <maml:para>This example sets QPIBandwidthOptimization, QPIHomeSnoopOptimization, and QPISnoopConfiguration to specified values on Gen9 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSQPI</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSQPILinkPower</command:name> <maml:description> <maml:para>The Set-HPEBIOSQPILinkPower cmdlet sets the Intel QPI link power configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSQPILinkPower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSQPILinkPower cmdlet sets the Intel QPI link power configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· IntelQPILinkEnablement (only available on Gen9 servers)</maml:para> <maml:para>· IntelQPILinkFrequency (available on Gen9 servers)</maml:para> <maml:para>· IntelQPILinkPowerManagement (available on Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSQPILinkPower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>IntelQPILinkEnablement</maml:name> <maml:description> <maml:para>Configures the QPI topology to use fewer links between processors, when available. Changing from the default can reduce QPI bandwidth performance in exchange for less power consumption. Possible values are Auto and SingleLink.</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">SingleLink</command:parameterValue> </command:parameterValueGroup> <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>IntelQPILinkFrequency</maml:name> <maml:description> <maml:para>Setting the Intel QPI Link Frequency to a low speed may reduce power consumption but may also impact system performance. Possible values are Auto and MinQPISpeed.</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">MinQPISpeed</command:parameterValue> </command:parameterValueGroup> <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>IntelQPILinkPowerManagement</maml:name> <maml:description> <maml:para>Enables or disables the Intel QPI Link Power Management. It places the Quick Path Interconnect links into a low power state when the links are not in use. This reduces power usage with minimal performance impact. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>IntelQPILinkEnablement</maml:name> <maml:description> <maml:para>Configures the QPI topology to use fewer links between processors, when available. Changing from the default can reduce QPI bandwidth performance in exchange for less power consumption. Possible values are Auto and SingleLink.</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">SingleLink</command:parameterValue> </command:parameterValueGroup> <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>IntelQPILinkFrequency</maml:name> <maml:description> <maml:para>Setting the Intel QPI Link Frequency to a low speed may reduce power consumption but may also impact system performance. Possible values are Auto and MinQPISpeed.</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">MinQPISpeed</command:parameterValue> </command:parameterValueGroup> <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>IntelQPILinkPowerManagement</maml:name> <maml:description> <maml:para>Enables or disables the Intel QPI Link Power Management. It places the Quick Path Interconnect links into a low power state when the links are not in use. This reduces power usage with minimal performance impact. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSQPILinkPower -IntelQPILinkEnablement Auto -IntelQPILinkFrequency Auto -IntelQPILinkPowerManagement Enabled</dev:code> <dev:remarks> <maml:para>This example sets IntelQPILinkEnablement, IntelQPILinkFrequency, and IntelQPILinkPowerManagement to specified values on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSQPILinkPower -Connection $connection -IntelQPILinkEnablement Auto,SingleLink -IntelQPILinkFrequency Auto,MinQPISpeed -IntelQPILinkPowerManagement Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets IntelQPILinkEnablement, IntelQPILinkFrequency, and IntelQPILinkPowerManagement to specified values on Gen9 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSQPILinkPower</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSRedundantPowerSupply</command:name> <maml:description> <maml:para>The Set-HPEBIOSRedundantPowerSupply cmdlet sets the BIOS redundant power supply configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSRedundantPowerSupply</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSRedundantPowerSupply cmdlet sets the BIOS redundant power supply configurations. This cmdlet has the following parameters.</maml:para> <maml:para>· RedundantPowerSupplyMode (not available on SL and BL servers)</maml:para> <maml:para>· RedundantPowerSupplyLogic (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· PowerSupplyRequirementOverride (only available on Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSRedundantPowerSupply</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>RedundantPowerSupplyMode</maml:name> <maml:description> <maml:para>Configures how the system handles redundant power supply configurations. Possible values are Auto, BalancedMode, HighEfficiencyEvenStandby, and HighEfficiencyOddStandby.</maml:para> <maml:para>Balanced Mode shares the power delivery equally among all installed power supplies. All High Efficiency Mode options provide the most power efficient operation with redundant power supplies by keeping half of the power supplies in standby mode at lower power usage levels. The High Efficiency Mode options enable the system to select which power supply to place in standby. Auto enables the system to select between the odd or even power supply based on a semi-random distribution within a group of systems.</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">BalancedMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">HighEfficiencyEvenStandby</command:parameterValue> <command:parameterValue required="false" variableLength="false">HighEfficiencyOddStandby</command:parameterValue> </command:parameterValueGroup> <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>RedundantPowerSupplyLogic</maml:name> <maml:description> <maml:para>Configures the the power supply redundancy logic. When configured for 1+1 Redundancy, one supply is minimally required and an additional one is required for a redundant configuration. When configured for 2+2 Redundancy, two supplies are minimally required and an additional two are required for a redundant configuration. When configured for 3+1 Redundancy, three supplies are minimally required and an additional power supply is required for a redundant configuration. When configured for 4+0 Redundancy, four supplies are minimally required with no redundancy. The server can operate with various workloads and configurations with the required power supplies installed. When configuring the power supply redundancy, it is recommended that you use the Power Advisor to confirm that the system's configuration can operate with the selected power supply requirements. Possible values are ConfiguredFor1+1Redundancy, ConfiguredFor2+2Redundancy, ConfiguredFor3+1Redundancy and ConfiguredFor4+0Redundancy</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ConfiguredFor1+1Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor2+2Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor3+1Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor4+0Redundancy</command:parameterValue> </command:parameterValueGroup> <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>PowerSupplyRequirementOverride</maml:name> <maml:description> <maml:para>Overrides the normal power supply requirements of the system. The server can operate with various workloads and configurations with the required power supplies installed. This option modifies the power supply requirements of the system to enable operation with one power supply and redundancy, or operation with two power supplies and redundancy with three power supplies. Only override the normal power supply requirements if they use the Power Advisor to confirm that their system's configuration can operate with the selected power supply requirements. Possible values are Default, ConfiguredFor1-2Redundancy, ConfiguredFor2-3Redundancy, ConfiguredFor2-4Redundancy, ConfiguredFor3-4Redundancy and ConfiguredFor4-NoneRedundancy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor1-2Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor2-3Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor2-4Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor3-4Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor4-NoneRedundancy</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>RedundantPowerSupplyMode</maml:name> <maml:description> <maml:para>Configures how the system handles redundant power supply configurations. Possible values are Auto, BalancedMode, HighEfficiencyEvenStandby, and HighEfficiencyOddStandby.</maml:para> <maml:para>Balanced Mode shares the power delivery equally among all installed power supplies. All High Efficiency Mode options provide the most power efficient operation with redundant power supplies by keeping half of the power supplies in standby mode at lower power usage levels. The High Efficiency Mode options enable the system to select which power supply to place in standby. Auto enables the system to select between the odd or even power supply based on a semi-random distribution within a group of systems.</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">BalancedMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">HighEfficiencyEvenStandby</command:parameterValue> <command:parameterValue required="false" variableLength="false">HighEfficiencyOddStandby</command:parameterValue> </command:parameterValueGroup> <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>RedundantPowerSupplyLogic</maml:name> <maml:description> <maml:para>Configures the the power supply redundancy logic. When configured for 1+1 Redundancy, one supply is minimally required and an additional one is required for a redundant configuration. When configured for 2+2 Redundancy, two supplies are minimally required and an additional two are required for a redundant configuration. When configured for 3+1 Redundancy, three supplies are minimally required and an additional power supply is required for a redundant configuration. When configured for 4+0 Redundancy, four supplies are minimally required with no redundancy. The server can operate with various workloads and configurations with the required power supplies installed. When configuring the power supply redundancy, it is recommended that you use the Power Advisor to confirm that the system's configuration can operate with the selected power supply requirements. Possible values are ConfiguredFor1+1Redundancy, ConfiguredFor2+2Redundancy, ConfiguredFor3+1Redundancy and ConfiguredFor4+0Redundancy</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ConfiguredFor1+1Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor2+2Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor3+1Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor4+0Redundancy</command:parameterValue> </command:parameterValueGroup> <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>PowerSupplyRequirementOverride</maml:name> <maml:description> <maml:para>Overrides the normal power supply requirements of the system. The server can operate with various workloads and configurations with the required power supplies installed. This option modifies the power supply requirements of the system to enable operation with one power supply and redundancy, or operation with two power supplies and redundancy with three power supplies. Only override the normal power supply requirements if they use the Power Advisor to confirm that their system's configuration can operate with the selected power supply requirements. Possible values are Default, ConfiguredFor1-2Redundancy, ConfiguredFor2-3Redundancy, ConfiguredFor2-4Redundancy, ConfiguredFor3-4Redundancy and ConfiguredFor4-NoneRedundancy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor1-2Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor2-3Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor2-4Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor3-4Redundancy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ConfiguredFor4-NoneRedundancy</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSRedundantPowerSupplyMode -RedundantPowerSupplyMode BalancedMode -RedundantPowerSupplyLogic ConfiguredFor2+2Redundancy</dev:code> <dev:remarks> <maml:para>This example sets RedundantPowerSupplyMode and RedundantPowerSupplyLogic to specified values on a Gen9 or Gen10 Intel server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSRedundantPowerSupplyMode -Connection $connection -RedundantPowerSupplyMode HighEfficiencyOddStandby</dev:code> <dev:remarks> <maml:para>This example sets RedundantPowerSupplyMode to specified values on a Gen10 AMD server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSRedundantPowerSupplyMode -Connection $connection -RedundantPowerSupplyMode BalancedMode,HighEfficiencyEvenStandby -PowerSupplyRequirementOverride ConfiguredFor2-3Redundancy,Default</dev:code> <dev:remarks> <maml:para>This example sets RedundantPowerSupplyMode and PowerSupplyRequirementOverride to specified values on Gen9 servers with a list of BIOS 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSRedundantPowerSupplyMode -Connection $connection -RedundantPowerSupplyMode BalancedMode,HighEfficiencyEvenStandby</dev:code> <dev:remarks> <maml:para>This example sets RedundantPowerSupplyMode to specified values on Gen10 AMD and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSRedundantPowerSupply</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSRemovableFlashMediaBootSequence</command:name> <maml:description> <maml:para>The Set-HPEBIOSRemovableFlashMediaBootSequence cmdlet sets the BIOS removable flash media boot sequence.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSRemovableFlashMediaBootSequence</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSRemovableFlashMediaBootSequence cmdlet sets the BIOS removable flash media boot sequence. This cmdlet has the following parameters.</maml:para> <maml:para>· RemovableFlashMediaBootSequence</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSRemovableFlashMediaBootSequence</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>RemovableFlashMediaBootSequence</maml:name> <maml:description> <maml:para>Allows the user to select which USB or SD card devices to search first when enumerating boot devices. This includes choosing whether the system attempts to boot the external USB drive keys, internal USB drive keys, or the internal SD card slot first. The Removable Flash Media Boot Sequence does not override the device boot order in the Standard Boot Order (IPL) option. Configure this option when boot mode is set to Legacy BIOS Mode. Possible values are InternalSDCardFirst, InternalDriveKeysFirst, and ExternalDriveKeysFirst.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">InternalSDCardFirst</command:parameterValue> <command:parameterValue required="false" variableLength="false">InternalDriveKeysFirst</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExternalDriveKeysFirst</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>RemovableFlashMediaBootSequence</maml:name> <maml:description> <maml:para>Allows the user to select which USB or SD card devices to search first when enumerating boot devices. This includes choosing whether the system attempts to boot the external USB drive keys, internal USB drive keys, or the internal SD card slot first. The Removable Flash Media Boot Sequence does not override the device boot order in the Standard Boot Order (IPL) option. Configure this option when boot mode is set to Legacy BIOS Mode. Possible values are InternalSDCardFirst, InternalDriveKeysFirst, and ExternalDriveKeysFirst.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">InternalSDCardFirst</command:parameterValue> <command:parameterValue required="false" variableLength="false">InternalDriveKeysFirst</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExternalDriveKeysFirst</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSRemovableFlashMediaBootSequence -RemovableFlashMediaBootSequence InternalDriveKeysFirst</dev:code> <dev:remarks> <maml:para>This example sets RemovableFlashMediaBootSequence to specified values on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSRemovableFlashMediaBootSequence -Connection $connection -RemovableFlashMediaBootSequence ExternalDriveKeysFirst</dev:code> <dev:remarks> <maml:para>This example sets RemovableFlashMediaBootSequence to specified values on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSRemovableFlashMediaBootSequence -Connection $connection -RemovableFlashMediaBootSequence ExternalDriveKeysFirst,InternalDriveKeysFirst,InternalSDCardFirst</dev:code> <dev:remarks> <maml:para>This example sets RemovableFlashMediaBootSequence to specified values on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSRemovableFlashMediaBootSequence</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSSATAControllerOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSSATAControllerOption cmdlet sets the BIOS SATA controller configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSSATAControllerOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSSATAControllerOption cmdlet sets the SATA (Serial Advanced Technology Attachment) configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· EmbeddedSATAConfiguration</maml:para> <maml:para>· SATASecureErase (available on Gen9 and Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSSATAControllerOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EmbeddedSATAConfiguration</maml:name> <maml:description> <maml:para>Configures the embedded chipset of the SATA controller. When selecting the Advanced Host Controller Interface (AHCI) or RAID (if supported), make sure the proper operating system drivers are used. Depending on your server model, either SATA AHCI or HP Dynamic Smart Array RAID support are enabled by default. See your operating system documentation before enabling SATA AHCI support to ensure your base media drivers support this feature. Possible values are EnableSATAAHCISupport, EnableSATALegacySupport (only available on Gen8 servers), and EnableDynamicSmartArrayRAIDSupport.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">EnableDynamicSmartArrayRAIDSupport</command:parameterValue> <command:parameterValue required="false" variableLength="false">EnableSATAAHCISupport</command:parameterValue> <command:parameterValue required="false" variableLength="false">EnableSATALegacySupport</command:parameterValue> </command:parameterValueGroup> <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>SATASecureErase</maml:name> <maml:description> <maml:para>The Security Freeze Lock command, which prevents password setting attacks on the security system, is not sent to supported SATA hard drives and thus enables Secure Erase to function. This option is supported only when the SATA controller is in AHCI mode. Secure Erase only operates with hard drives that support the Secure Erase Command. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EmbeddedSATAConfiguration</maml:name> <maml:description> <maml:para>Configures the embedded chipset of the SATA controller. When selecting the Advanced Host Controller Interface (AHCI) or RAID (if supported), make sure the proper operating system drivers are used. Depending on your server model, either SATA AHCI or HP Dynamic Smart Array RAID support are enabled by default. See your operating system documentation before enabling SATA AHCI support to ensure your base media drivers support this feature. Possible values are EnableSATAAHCISupport, EnableSATALegacySupport (only available on Gen8 servers), and EnableDynamicSmartArrayRAIDSupport.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">EnableDynamicSmartArrayRAIDSupport</command:parameterValue> <command:parameterValue required="false" variableLength="false">EnableSATAAHCISupport</command:parameterValue> <command:parameterValue required="false" variableLength="false">EnableSATALegacySupport</command:parameterValue> </command:parameterValueGroup> <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>SATASecureErase</maml:name> <maml:description> <maml:para>The Security Freeze Lock command, which prevents password setting attacks on the security system, is not sent to supported SATA hard drives and thus enables Secure Erase to function. This option is supported only when the SATA controller is in AHCI mode. Secure Erase only operates with hard drives that support the Secure Erase Command. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSSATAControllerOption -EmbeddedSATAConfiguration EnableSATAAHCISupport -SATASecureErase Enabled</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedSATAConfiguration and SATASecureErase to specified values on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSSATAControllerOption -Connection $connection -EmbeddedSATAConfiguration EnableDynamicSmartArrayRAIDSupport -SATASecureErase Disabled</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedSATAConfiguration and SATASecureErase to specified values on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSSATAControllerOption -Connection $connection -EmbeddedSATAConfiguration EnableDynamicSmartArrayRAIDSupport,EnableSATAAHCISupport -SATASecureErase Disabled,Enabled</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedSATAConfiguration and SATASecureErase to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSSATAControllerOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSSecureBootState</command:name> <maml:description> <maml:para>The Set-HPEBIOSSecureBootState cmdlet sets the BIOS Secure Boot configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSSecureBootState</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSSecureBootState cmdlet sets the BIOS Secure Boot configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· SecureBootState</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSSecureBootState</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>SecureBootState</maml:name> <maml:description> <maml:para>Allows user to enable or disable the Secure Boot state of the system. Secure Boot ensures that each component launched during the boot process is digitally signed and that the signature is validated against a set of trusted certificates embedded in the UEFI BIOS. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>SecureBootState</maml:name> <maml:description> <maml:para>Allows user to enable or disable the Secure Boot state of the system. Secure Boot ensures that each component launched during the boot process is digitally signed and that the signature is validated against a set of trusted certificates embedded in the UEFI BIOS. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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 SecureBootState value cannot be changed while the computer system BIOS is in POST. · Like other cmdlets, the reboot is mandatory to apply the changes into BIOS.</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSSecureBootState -SecureBootState Enabled</dev:code> <dev:remarks> <maml:para>This example sets SecureBootState to specified values on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSSecureBootState -Connection $connection -SecureBootState Disabled</dev:code> <dev:remarks> <maml:para>This example sets SecureBootState to specified values on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSSecureBootState -Connection $connection -SecureBootState Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets SecureBootState to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSSecureBootState</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSSerialConsole</command:name> <maml:description> <maml:para>The Set-HPEBIOSSerialConsole cmdlet sets the serial console configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSSerialConsole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSSerialConsole cmdlet sets the serial console configurations. This cmdlet has the following parameters.</maml:para> <maml:para>· SerialConsolePort</maml:para> <maml:para>· SerialConsoleEmulationMode</maml:para> <maml:para>· SerialConsoleBaudRate</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSSerialConsole</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>SerialConsoleBaudRate</maml:name> <maml:description> <maml:para>Controls transfer rate at which data is transmitted through the serial port. Possible values are 9600, 19200, 38400, 57600, and 115200.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</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>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>SerialConsoleEmulationMode</maml:name> <maml:description> <maml:para>Selects an emulation mode type used for serial terminal program (for example, Hyperterminal or Putty). The BIOS emulation mode must match the selected mode in the terminal program. Possible values are VT100, ANSI, VT100+ and VT-UTF8.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">VT100</command:parameterValue> <command:parameterValue required="false" variableLength="false">ANSI</command:parameterValue> <command:parameterValue required="false" variableLength="false">VT100+</command:parameterValue> <command:parameterValue required="false" variableLength="false">VT-UTF8</command:parameterValue> </command:parameterValueGroup> <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>SerialConsolePort</maml:name> <maml:description> <maml:para>Controls re-directing the video and keystrokes through the serial port to OS boot. Possible values are Auto, Disabled, COM1, COM2, PhysicalSerialPort, and VirtualSerialPort.</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">COM1</command:parameterValue> <command:parameterValue required="false" variableLength="false">COM2</command:parameterValue> <command:parameterValue required="false" variableLength="false">PhysicalSerialPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualSerialPort</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>SerialConsoleBaudRate</maml:name> <maml:description> <maml:para>Controls transfer rate at which data is transmitted through the serial port. Possible values are 9600, 19200, 38400, 57600, and 115200.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</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>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>SerialConsoleEmulationMode</maml:name> <maml:description> <maml:para>Selects an emulation mode type used for serial terminal program (for example, Hyperterminal or Putty). The BIOS emulation mode must match the selected mode in the terminal program. Possible values are VT100, ANSI, VT100+ and VT-UTF8.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">VT100</command:parameterValue> <command:parameterValue required="false" variableLength="false">ANSI</command:parameterValue> <command:parameterValue required="false" variableLength="false">VT100+</command:parameterValue> <command:parameterValue required="false" variableLength="false">VT-UTF8</command:parameterValue> </command:parameterValueGroup> <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>SerialConsolePort</maml:name> <maml:description> <maml:para>Controls re-directing the video and keystrokes through the serial port to OS boot. Possible values are Auto, Disabled, COM1, COM2, PhysicalSerialPort, and VirtualSerialPort.</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">COM1</command:parameterValue> <command:parameterValue required="false" variableLength="false">COM2</command:parameterValue> <command:parameterValue required="false" variableLength="false">PhysicalSerialPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualSerialPort</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSSerialConsole -SerialConsoleBaudRate 9600 -SerialConsoleEmulationMode VT100 -SerialConsolePort Auto</dev:code> <dev:remarks> <maml:para>This example sets SerialConsoleBaudRate, SerialConsoleEmulationMode, and SerialConsolePort to specified values on a Gen9 or Gen10 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSSerialConsole -Connection $connection -SerialConsoleBaudRate 9600,19200 -SerialConsoleEmulationMode VT100+,VT-UTF8 -SerialConsolePort COM1,VirtualSerialPort</dev:code> <dev:remarks> <maml:para>This example sets SerialConsoleBaudRate, SerialConsoleEmulationMode, and SerialConsolePort to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSSerialConsole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSSerialPort</command:name> <maml:description> <maml:para>The Set-HPEBIOSSerialPort cmdlet sets the serial port configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSSerialPort</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSSerialPort cmdlet sets the serial port configurations. This cmdlet has the following parameters.</maml:para> <maml:para>· EmbeddedSerialPort</maml:para> <maml:para>· VirtualSerialPort</maml:para> <maml:para></maml:para> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSSerialPort</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EmbeddedSerialPort</maml:name> <maml:description> <maml:para>Assigns the logical COM port number and associated default resources to the selected physical serial port. This setting may be overwritten by the operating system. Possible values are COM1_IRQ4, COM2_IRQ3, COM3_IRQ5, and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">COM1_IRQ4</command:parameterValue> <command:parameterValue required="false" variableLength="false">COM2_IRQ3</command:parameterValue> <command:parameterValue required="false" variableLength="false">COM3_IRQ5</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualSerialPort</maml:name> <maml:description> <maml:para>Assigns the logical COM port number and associated default resources used by the VSP. The VSP enables the iLO Management Controller to appear as a physical serial port to support the BIOS Serial Console and the OS serial console. Possible values are COM1_IRQ4, COM2_IRQ3, COM3_IRQ5, and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">COM1_IRQ4</command:parameterValue> <command:parameterValue required="false" variableLength="false">COM2_IRQ3</command:parameterValue> <command:parameterValue required="false" variableLength="false">COM3_IRQ5</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EmbeddedSerialPort</maml:name> <maml:description> <maml:para>Assigns the logical COM port number and associated default resources to the selected physical serial port. This setting may be overwritten by the operating system. Possible values are COM1_IRQ4, COM2_IRQ3, COM3_IRQ5, and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">COM1_IRQ4</command:parameterValue> <command:parameterValue required="false" variableLength="false">COM2_IRQ3</command:parameterValue> <command:parameterValue required="false" variableLength="false">COM3_IRQ5</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VirtualSerialPort</maml:name> <maml:description> <maml:para>Assigns the logical COM port number and associated default resources used by the VSP. The VSP enables the iLO Management Controller to appear as a physical serial port to support the BIOS Serial Console and the OS serial console. Possible values are COM1_IRQ4, COM2_IRQ3, COM3_IRQ5, and Disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">COM1_IRQ4</command:parameterValue> <command:parameterValue required="false" variableLength="false">COM2_IRQ3</command:parameterValue> <command:parameterValue required="false" variableLength="false">COM3_IRQ5</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSSerialPort –Connection $connection -EmbeddedSerialPort COM1_IRQ4 -VirtualSerialPort COM2_IRQ3</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedSerialPort and VirtualSerialPort to specified values on a Gen9 server with 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSSerialPort –Connection $connection -EmbeddedSerialPort COM2_IRQ3 -VirtualSerialPort COM1_IRQ4</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedSerialPort and VirtualSerialPort to specified values on a Gen10 server 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSSerialPort -Connection $connection -EmbeddedSerialPort COM1_IRQ4,Disabled -VirtualSerialPort COM2_IRQ3,COM1_IRQ4</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedSerialPort and VirtualSerialPort to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSSerialPort</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSServerAvailability</command:name> <maml:description> <maml:para>The Set-HPEBIOSServerAvailability cmdlet sets the BIOS Server Availability configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSServerAvailability</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSServerAvailability cmdlet sets the BIOS Server Availability configurations. This cmdlet has the following parameters.</maml:para> <maml:para>· ACPIWatchdogTimer (only available on Gen10 servers)</maml:para> <maml:para>· ASR</maml:para> <maml:para>· ASRTimeout</maml:para> <maml:para>· WakeOnLAN</maml:para> <maml:para>· PowerButton</maml:para> <maml:para>· PowerOnDelay</maml:para> <maml:para>· POSTF1Prompt</maml:para> <maml:para>· AutomaticPowerOn</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSServerAvailability</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ACPIWatchdogTimer</maml:name> <maml:description> <maml:para>Enables or disables ACPI Watchdog Timer. When enabled, Automatic Server Recovery will be disabled. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ASR</maml:name> <maml:description> <maml:para>Enables or disables ASR (Automatic Server Recovery), which enables the system to automatically reboot if the server locks up. When enabled, ACPI watchdog timer will be disabled. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ASRTimeout</maml:name> <maml:description> <maml:para>Sets a timeout limit for resetting an unresponsive server when Automatic Server Recovery is enabled. When the server has not responded in the selected amount of time, the server automatically resets. Possible values are 5Minutes, 10Minutes, 15Minutes, 20Minutes, and 30Minutes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">5Minutes</command:parameterValue> <command:parameterValue required="false" variableLength="false">10Minutes</command:parameterValue> <command:parameterValue required="false" variableLength="false">15Minutes</command:parameterValue> <command:parameterValue required="false" variableLength="false">20Minutes</command:parameterValue> <command:parameterValue required="false" variableLength="false">30Minutes</command:parameterValue> </command:parameterValueGroup> <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>AutomaticPowerOn</maml:name> <maml:description> <maml:para>Configures the server power state to achieve when power is applied to the system that had experienced an unexpected power outage. Possible values are AlwaysPowerOn, AlwaysPowerOff, and RestoreLastPowerState.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AlwaysPowerOn</command:parameterValue> <command:parameterValue required="false" variableLength="false">AlwaysPowerOff</command:parameterValue> <command:parameterValue required="false" variableLength="false">RestoreLastPowerState</command:parameterValue> </command:parameterValueGroup> <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>POSTF1Prompt</maml:name> <maml:description> <maml:para>Configures the system to display the F1 key on the server POST screen. If an error is encountered, press the F1 key to continue with the server power-up sequence. Possible values are Enabled, Disabled, Delayed20Sec, Delayed2Sec, and Delayed.</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:parameterValue required="false" variableLength="false">Delayed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Delayed20Sec</command:parameterValue> <command:parameterValue required="false" variableLength="false">Delayed2Sec</command:parameterValue> </command:parameterValueGroup> <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>PowerButton</maml:name> <maml:description> <maml:para>Enables or disables the momentary power button. 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>None</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>Delays the server from turning on for a specified time. When multiple servers power up after a power loss, the Power-On Delay feature allows you to delay the server from powering on, to prevent power usage spikes. Possible values are NoDelay, Random, 15Second, 30Second, 45Second, and 60Second.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NoDelay</command:parameterValue> <command:parameterValue required="false" variableLength="false">Random</command:parameterValue> <command:parameterValue required="false" variableLength="false">15Second</command:parameterValue> <command:parameterValue required="false" variableLength="false">30Second</command:parameterValue> <command:parameterValue required="false" variableLength="false">45Second</command:parameterValue> <command:parameterValue required="false" variableLength="false">60Second</command:parameterValue> </command:parameterValueGroup> <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>WakeOnLAN</maml:name> <maml:description> <maml:para>Configures the server to be powered on remotely using a network controller. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ACPIWatchdogTimer</maml:name> <maml:description> <maml:para>Enables or disables ACPI Watchdog Timer. When enabled, Automatic Server Recovery will be disabled. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ASR</maml:name> <maml:description> <maml:para>Enables or disables ASR (Automatic Server Recovery), which enables the system to automatically reboot if the server locks up. When enabled, ACPI watchdog timer will be disabled. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ASRTimeout</maml:name> <maml:description> <maml:para>Sets a timeout limit for resetting an unresponsive server when Automatic Server Recovery is enabled. When the server has not responded in the selected amount of time, the server automatically resets. Possible values are 5Minutes, 10Minutes, 15Minutes, 20Minutes, and 30Minutes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">5Minutes</command:parameterValue> <command:parameterValue required="false" variableLength="false">10Minutes</command:parameterValue> <command:parameterValue required="false" variableLength="false">15Minutes</command:parameterValue> <command:parameterValue required="false" variableLength="false">20Minutes</command:parameterValue> <command:parameterValue required="false" variableLength="false">30Minutes</command:parameterValue> </command:parameterValueGroup> <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>AutomaticPowerOn</maml:name> <maml:description> <maml:para>Configures the server power state to achieve when power is applied to the system that had experienced an unexpected power outage. Possible values are AlwaysPowerOn, AlwaysPowerOff, and RestoreLastPowerState.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AlwaysPowerOn</command:parameterValue> <command:parameterValue required="false" variableLength="false">AlwaysPowerOff</command:parameterValue> <command:parameterValue required="false" variableLength="false">RestoreLastPowerState</command:parameterValue> </command:parameterValueGroup> <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>POSTF1Prompt</maml:name> <maml:description> <maml:para>Configures the system to display the F1 key on the server POST screen. If an error is encountered, press the F1 key to continue with the server power-up sequence. Possible values are Enabled, Disabled, Delayed20Sec, Delayed2Sec, and Delayed.</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:parameterValue required="false" variableLength="false">Delayed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Delayed20Sec</command:parameterValue> <command:parameterValue required="false" variableLength="false">Delayed2Sec</command:parameterValue> </command:parameterValueGroup> <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>PowerButton</maml:name> <maml:description> <maml:para>Enables or disables the momentary power button. 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>None</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>Delays the server from turning on for a specified time. When multiple servers power up after a power loss, the Power-On Delay feature allows you to delay the server from powering on, to prevent power usage spikes. Possible values are NoDelay, Random, 15Second, 30Second, 45Second, and 60Second.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">NoDelay</command:parameterValue> <command:parameterValue required="false" variableLength="false">Random</command:parameterValue> <command:parameterValue required="false" variableLength="false">15Second</command:parameterValue> <command:parameterValue required="false" variableLength="false">30Second</command:parameterValue> <command:parameterValue required="false" variableLength="false">45Second</command:parameterValue> <command:parameterValue required="false" variableLength="false">60Second</command:parameterValue> </command:parameterValueGroup> <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>WakeOnLAN</maml:name> <maml:description> <maml:para>Configures the server to be powered on remotely using a network controller. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSServerAvailability -ASR Enabled -ASRTimeout 5Minutes -AutomaticPowerOn AlwaysPowerOn -POSTF1Prompt Disabled -PowerButton Enabled -PowerOnDelay NoDelay -WakeOnLAN Enabled</dev:code> <dev:remarks> <maml:para>This example sets ASR, ASRTimeout, AutomaticPowerOn, POSTF1Prompt, PowerButton, PowerOnDelay, and WakeOnLAN to specified values on Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSServerAvailability -ACPIWatchdogTimer Enabled -ASR Disabled -ASRTimeout 15Minutes -AutomaticPowerOn RestoreLastPowerState -POSTF1Prompt Enabled -PowerButton Disabled -PowerOnDelay Random -WakeOnLAN Disabled</dev:code> <dev:remarks> <maml:para>This example sets ACPIWatchdogTimer, ASR, ASRTimeout, AutomaticPowerOn, POSTF1Prompt, PowerButton, PowerOnDelay, and WakeOnLAN to specified values on a Gen10 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSServerAvailability -Connection $connection -ASR Enabled,Disabled,Enabled -ASRTimeout 5Minutes,10Minutes,15Minutes -AutomaticPowerOn AlwaysPowerOn,AlwaysPowerOff,RestoreLastPowerState -POSTF1Prompt Disabled,Enabled,Delayed2Sec -PowerButton Enabled,Disabled,Enabled -PowerOnDelay NoDelay,15Second,Random -WakeOnLAN Enabled,Disabled,Enabled</dev:code> <dev:remarks> <maml:para>This example sets ASR, ASRTimeout, AutomaticPowerOn, POSTF1Prompt, PowerButton, PowerOnDelay, and WakeOnLAN to specified values on Gen9 servers with a list of BIOS 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSServerAvailability -Connection $connection -ACPIWatchdogTimer Enabled,Disabled -ASR Disabled,Enabled -ASRTimeout 15Minutes,10Minutes -AutomaticPowerOn AlwaysPowerOn,AlwaysPowerOff -POSTF1Prompt Disabled,Delayed2Sec -PowerButton Enabled,Disabled -PowerOnDelay 15Second,Random -WakeOnLAN Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets ACPIWatchdogTimer, ASR, ASRTimeout, AutomaticPowerOn, POSTF1Prompt, PowerButton, PowerOnDelay, and WakeOnLAN to specified values on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSServerAvailability</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSServerInfo</command:name> <maml:description> <maml:para>The Set-HPEBIOSServerInfo cmdlet sets the server administrator information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSServerInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSServerInfo cmdlet sets the server administrator information. This cmdlet has the following parameters.</maml:para> <maml:para>· AssetTagProtection</maml:para> <maml:para>· PowerOnLogo</maml:para> <maml:para>· ServerName</maml:para> <maml:para>· ServerAssetTag</maml:para> <maml:para>· ServerOtherInfo</maml:para> <maml:para>· ServerPrimaryOS</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSServerInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AssetTagProtection</maml:name> <maml:description> <maml:para>Locks or unlocks Asset Tag information. Possible values are Locked and Unlocked. When set to Locked, the Asset Tag is not erased if the default system settings are restored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Locked</command:parameterValue> <command:parameterValue required="false" variableLength="false">Unlocked</command:parameterValue> </command:parameterValueGroup> <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>PowerOnLogo</maml:name> <maml:description> <maml:para>Enables or disables the display of the logo during system boot. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ServerAssetTag</maml:name> <maml:description> <maml:para>Sets the server asset number. The valid length is 0 to 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>None</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>Sets the server name. The valid length is 0 to 28.</maml:para> </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>ServerOtherInfo</maml:name> <maml:description> <maml:para>Sets the addtional text describing the server. The valid length is 0 to 28.</maml:para> </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>ServerPrimaryOS</maml:name> <maml:description> <maml:para>Describes the primary OS of the server. The valid length is 0 to 42.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AssetTagProtection</maml:name> <maml:description> <maml:para>Locks or unlocks Asset Tag information. Possible values are Locked and Unlocked. When set to Locked, the Asset Tag is not erased if the default system settings are restored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Locked</command:parameterValue> <command:parameterValue required="false" variableLength="false">Unlocked</command:parameterValue> </command:parameterValueGroup> <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>PowerOnLogo</maml:name> <maml:description> <maml:para>Enables or disables the display of the logo during system boot. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ServerAssetTag</maml:name> <maml:description> <maml:para>Sets the server asset number. The valid length is 0 to 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>None</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>Sets the server name. The valid length is 0 to 28.</maml:para> </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>ServerOtherInfo</maml:name> <maml:description> <maml:para>Sets the addtional text describing the server. The valid length is 0 to 28.</maml:para> </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>ServerPrimaryOS</maml:name> <maml:description> <maml:para>Describes the primary OS of the server. The valid length is 0 to 42.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSServerInfo -ServerAssetTag 'HPE Proliant Server1' -ServerName 'ABC-WINDOWS-01' -ServerOtherInfo 'HPE Data Centre 1' -ServerPrimaryOS 'Windows Server 2008 R2' -AssetTagProtection Locked -PowerOnLogo Enabled</dev:code> <dev:remarks> <maml:para>This example sets ServerAssetTag, ServerName, ServerOtherInfo, ServerPrimaryOS, AssetTagProtection, and PowerOnLogo to specified values on a Gen9 or Gen10 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSServerInfo -Connection $connection -ServerAssetTag 'HPE Proliant Server1','HPE Proliant Server2' -ServerName 'ABC-WINDOWS-01','ABC-WINDOWS-02' -ServerOtherInfo 'HPE Data Centre 1','HPE Data Centre 2' -ServerPrimaryOS 'Windows Server 2008 R2','Windows Server 2012 R2' -AssetTagProtection Locked,Unlocked -PowerOnLogo Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets ServerAssetTag, ServerName, ServerOtherInfo, ServerPrimaryOS, AssetTagProtection, and PowerOnLogo to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSServerInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSServerSecurity</command:name> <maml:description> <maml:para>The Set-HPEBIOSServerSecurity cmdlet sets the BIOS server security configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSServerSecurity</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSServerSecurity cmdlet sets the BIOS server security configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· BackupROMImageAuthentication (only available on Gen10 servers)</maml:para> <maml:para>· F11BootMenuPrompt</maml:para> <maml:para>· IntelligentProvisioningF10Prompt</maml:para> <maml:para>· IntelTxtSupport (available on Gen10 with Intel processor and Gen9 servers)</maml:para> <maml:para>· ProcessorAESNISupport (available on Gen9 and Gen10 servers)</maml:para> <maml:para>·AllowLoginWithiLOAccount (available on Gen10 AMD servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSServerSecurity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>BackupROMImageAuthentication</maml:name> <maml:description> <maml:para>Enables or disables cryptographic authentication of the backup ROM image on startup. When this option is disabled, only the primary image is authenticated on each startup. Enable this option to also perform cryptographic authentication of the backup ROM image. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>F11BootMenuPrompt</maml:name> <maml:description> <maml:para>Controls access to One-Time Boot Menu F11 prompt by pressing F11 during server boot. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntelligentProvisioningF10Prompt</maml:name> <maml:description> <maml:para>Controls access to Intelligent Provisioning by pressing F10 during server boot. When disabled, this option prevents the user from entering the Intelligent Provisioning environment. This option must be enabled to use Intelligent Provisioning functionality. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntelTxtSupport</maml:name> <maml:description> <maml:para>Enables or disables the Intel TXT (Trusted Execution Technology) support for servers. Enabling the TXT support option automatically enables all processor cores, Hyper-Threading, VT-d is enabled and TPM (Trusted Platform Module). 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProcessorAESNISupport</maml:name> <maml:description> <maml:para>Enables or disables the Advanced Encryption Standard New Instruction Set (AES-NI) in the processor. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AllowLoginWithiLO</maml:name> <maml:description> <maml:para>Allows users to login with an iLO account when the Host BIOS privilege is set. 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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>BackupROMImageAuthentication</maml:name> <maml:description> <maml:para>Enables or disables cryptographic authentication of the backup ROM image on startup. When this option is disabled, only the primary image is authenticated on each startup. Enable this option to also perform cryptographic authentication of the backup ROM image. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>F11BootMenuPrompt</maml:name> <maml:description> <maml:para>Controls access to One-Time Boot Menu F11 prompt by pressing F11 during server boot. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntelligentProvisioningF10Prompt</maml:name> <maml:description> <maml:para>Controls access to Intelligent Provisioning by pressing F10 during server boot. When disabled, this option prevents the user from entering the Intelligent Provisioning environment. This option must be enabled to use Intelligent Provisioning functionality. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntelTxtSupport</maml:name> <maml:description> <maml:para>Enables or disables the Intel TXT (Trusted Execution Technology) support for servers. Enabling the TXT support option automatically enables all processor cores, Hyper-Threading, VT-d is enabled and TPM (Trusted Platform Module). 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProcessorAESNISupport</maml:name> <maml:description> <maml:para>Enables or disables the Advanced Encryption Standard New Instruction Set (AES-NI) in the processor. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AllowLoginWithiLO</maml:name> <maml:description> <maml:para>Allows users to login with an iLO account when the Host BIOS privilege is set. 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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSServerSecurity -F11BootMenuPrompt Enabled -IntelligentProvisioningF10Prompt Enabled -IntelTxtSupport Enabled -ProcessorAESNISupport Enabled</dev:code> <dev:remarks> <maml:para>This example sets F11BootMenuPrompt, IntelligentProvisioningF10Prompt, IntelTxtSupport, and ProcessorAESNISupport to specified values on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSServerSecurity -F11BootMenuPrompt Enabled -IntelligentProvisioningF10Prompt Enabled -ProcessorAESNISupport Enabled -BackupROMImageAuthentication Enabled</dev:code> <dev:remarks> <maml:para>This example sets F11BootMenuPrompt, IntelligentProvisioningF10Prompt, ProcessorAESNISupport, and BackupROMImageAuthentication to specified values on a Gen10 AMD server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSServerSecurity -F11BootMenuPrompt Enabled -IntelligentProvisioningF10Prompt Enabled -IntelTxtSupport Enabled -ProcessorAESNISupport Enabled -BackupROMImageAuthentication Enabled</dev:code> <dev:remarks> <maml:para>This example sets F11BootMenuPrompt, IntelligentProvisioningF10Prompt, IntelTxtSupport, ProcessorAESNISupport, and BackupROMImageAuthentication to specified values on a Gen10 Intel server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSServerSecurity -Connection $connection -F11BootMenuPrompt Enabled,Disabled -IntelligentProvisioningF10Prompt Enabled,Disabled -IntelTxtSupport Enabled,Disabled -ProcessorAESNISupport Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets F11BootMenuPrompt, IntelligentProvisioningF10Prompt, IntelTxtSupport, and ProcessorAESNISupport to specified values on Gen9 servers with a list of BIOS 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSServerSecurity -Connection $connection -F11BootMenuPrompt Enabled,Disabled -IntelligentProvisioningF10Prompt Enabled,Disabled -ProcessorAESNISupport Enabled,Disabled -BackupROMImageAuthentication Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets F11BootMenuPrompt, IntelligentProvisioningF10Prompt, ProcessorAESNISupport, and BackupROMImageAuthentication to specified values on Gen10 AMD servers with a list of BIOS connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 6</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSServerSecurity -Connection $connection -F11BootMenuPrompt Enabled,Disabled -IntelligentProvisioningF10Prompt Enabled,Disabled -IntelTxtSupport Enabled,Disabled -ProcessorAESNISupport Enabled,Disabled -BackupROMImageAuthentication Enabled,Disabled -SecureTransitStatus Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets F11BootMenuPrompt, IntelligentProvisioningF10Prompt, IntelTxtSupport, ProcessorAESNISupport, and BackupROMImageAuthentication to specified values on Gen10 Intel servers with a list of BIOS connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 7</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSServerSecurity -Connection $connection -F11BootMenuPrompt Enabled -IntelligentProvisioningF10Prompt Enabled -AllowLoginWithiLO Enabled -ProcessorAESNISupport Enabled -BackupROMImageAuthentication Disabled PS C:\></dev:code> <dev:remarks> <maml:para>This example sets F11BootMenuPrompt, IntelligentProvisioningF10Prompt, ProcessorAESNISupport, AllowLoginWithiLO, and BackupROMImageAuthentication to specified values on Gen10 Plus AMD servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSServerSecurity</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSServiceContact</command:name> <maml:description> <maml:para>The Set-HPEBIOSServiceContact cmdlet sets the reference information for the server service.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSServiceContact</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSServiceContact cmdlet sets the reference information for the server service. This cmdlet has the following parameters.</maml:para> <maml:para>· ServiceContactName</maml:para> <maml:para>· ServiceContactOtherInfo</maml:para> <maml:para>· ServicePhoneNumber</maml:para> <maml:para>· ServiceContactEmailAddress (available on Gen9 and Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSServiceContact</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ServiceContactName</maml:name> <maml:description> <maml:para>Defines the service contact’s name. The valid length is 0 to 28.</maml:para> </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>ServiceContactOtherInfo</maml:name> <maml:description> <maml:para>Defines additional text relating to the service contact. The valid length is 0 to 28.</maml:para> </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>ServicePagerNumber</maml:name> <maml:description> <maml:para>Defines the service contact’s pager number. The valid length is 0 to 28.</maml:para> </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>ServicePhoneNumber</maml:name> <maml:description> <maml:para>Defines the service contact’s phone number. The valid length is 0 to 28.</maml:para> </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>ServiceContactEmailAddress</maml:name> <maml:description> <maml:para>Defines the service contact’s email address. The valid length is 0 to 28.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ServiceContactName</maml:name> <maml:description> <maml:para>Defines the service contact’s name. The valid length is 0 to 28.</maml:para> </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>ServiceContactOtherInfo</maml:name> <maml:description> <maml:para>Defines additional text relating to the service contact. The valid length is 0 to 28.</maml:para> </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>ServicePagerNumber</maml:name> <maml:description> <maml:para>Defines the service contact’s pager number. The valid length is 0 to 28.</maml:para> </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>ServicePhoneNumber</maml:name> <maml:description> <maml:para>Defines the service contact’s phone number. The valid length is 0 to 28.</maml:para> </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>ServiceContactEmailAddress</maml:name> <maml:description> <maml:para>Defines the service contact’s email address. The valid length is 0 to 28.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSServiceContact -ServiceContactName 'XYZ' -ServicePhoneNumber '1234598765' -ServiceContactEmailAddress 'xyz@hpe.com' -ServiceContactOtherInfo 'Alternate : 0123456789'</dev:code> <dev:remarks> <maml:para>This example sets ServiceContactName, ServicePhoneNumber, ServiceContactEmailAddress, and ServiceContactOtherInfo to specified values on a Gen9 or Gen10 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSServiceContact -Connection $connection -ServiceContactName 'XYZ' -ServicePhoneNumber '987654321' -ServiceContactEmailAddress 'xyz@hpe.com' -ServiceContactOtherInfo 'Alternate : 9876556789'</dev:code> <dev:remarks> <maml:para>This example sets ServiceContactName, ServicePhoneNumber, ServiceContactEmailAddress, and ServiceContactOtherInfo to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSServiceContact</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSStorageOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSStorageOption cmdlet sets the storage boot policy for storage controllers.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSStorageOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSStorageOption cmdlet sets the storage boot policy for storage controllers. This cmdlet has the following parameters:</maml:para> <maml:para>· FibreChannelScanPolicy</maml:para> <maml:para>· EmbeddedStorageBootPolicy</maml:para> <maml:para>· Slot1StorageBoot</maml:para> <maml:para>· Slot2StorageBoot</maml:para> <maml:para>· Slot3StorageBoot</maml:para> <maml:para>· Slot4StorageBoot</maml:para> <maml:para>· Slot5StorageBoot</maml:para> <maml:para>· Slot6StorageBoot</maml:para> <maml:para>· Slot7StorageBoot</maml:para> <maml:para>· Slot8StorageBoot</maml:para> <maml:para>· Slot9StorageBoot</maml:para> <maml:para>· Slot10StorageBoot</maml:para> <maml:para>· Slot11StorageBoot</maml:para> <maml:para>· Slot12StorageBoot</maml:para> <maml:para>· Slot13StorageBoot</maml:para> <maml:para>· Slot14StorageBoot</maml:para> <maml:para>· Slot15StorageBoot</maml:para> <maml:para>· Slot16StorageBoot</maml:para> <maml:para>· Slot21StorageBoot</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSStorageOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EmbeddedStorageBootPolicy</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controllers. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>FibreChannelScanPolicy</maml:name> <maml:description> <maml:para>Configures the Fibre Channel or FCoE scan policy for boot targets. Possible values are ScanAllTargets and ScanConfiguredTargetsOnly.</maml:para> <maml:para>· ScanAllTargets - Each installed FC/FCoE adapter scans all available targets.</maml:para> <maml:para>· ScanConfiguredTargetsOnly - Each installed FC/FCoE adapter only scans targets that are preconfigured in the device settings. This setting overrides any individual device settings configured in the device-specific setup.</maml:para> <maml:para>Note: · For Fibre Channel controllers in PCIe slots, this setting is overridden by the PCIe Storage Boot Policy setting.</maml:para> <maml:para>· Changing the Fibre Channel boot scan setting from the default setting might significantly increase boot time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ScanAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">ScanConfiguredTargetsOnly</command:parameterValue> </command:parameterValueGroup> <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>Slot1StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 1. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot2StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 2. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot3StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 3. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot4StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 4. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot5StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 5. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot6StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 6. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot7StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 7. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot8StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 8. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot9StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 9. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot10StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 10. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot11StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 11. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot12StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 12. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot13StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 13. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot14StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 14. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot15StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 15. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot16StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 16. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot21StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 21. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EmbeddedStorageBootPolicy</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controllers. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>FibreChannelScanPolicy</maml:name> <maml:description> <maml:para>Configures the Fibre Channel or FCoE scan policy for boot targets. Possible values are ScanAllTargets and ScanConfiguredTargetsOnly.</maml:para> <maml:para>· ScanAllTargets - Each installed FC/FCoE adapter scans all available targets.</maml:para> <maml:para>· ScanConfiguredTargetsOnly - Each installed FC/FCoE adapter only scans targets that are preconfigured in the device settings. This setting overrides any individual device settings configured in the device-specific setup.</maml:para> <maml:para>Note: · For Fibre Channel controllers in PCIe slots, this setting is overridden by the PCIe Storage Boot Policy setting.</maml:para> <maml:para>· Changing the Fibre Channel boot scan setting from the default setting might significantly increase boot time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ScanAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">ScanConfiguredTargetsOnly</command:parameterValue> </command:parameterValueGroup> <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>Slot1StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 1. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot2StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 2. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot3StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 3. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot4StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 4. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot5StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 5. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot6StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 6. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot7StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 7. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot8StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 8. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot9StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 9. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo3Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot10StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 10. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot11StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 11. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot12StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 12. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot13StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 13. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot14StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 14. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot15StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 15. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot16StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 16. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <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>Slot21StorageBoot</maml:name> <maml:description> <maml:para>Selects the UEFI BIOS boot targets for embedded storage controller connected in PCIe slot 21. Possible values are BootAllTargets, BootLimitTo3Targets, BootLimitTo24Targets, and BootNoTargets.</maml:para> <maml:para>· BootAllTargets - All valid boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo3Targets (only applicable on Gen9 servers) - A maximum of three boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootLimitTo24Targets (only applicable on Gen10 servers) - A maximum of 24 boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> <maml:para>· BootNoTargets - No boot targets attached to the storage controller are available to the UEFI Boot Order list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BootAllTargets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootLimitTo24Targets</command:parameterValue> <command:parameterValue required="false" variableLength="false">BootNoTargets</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSStorageOption -EmbeddedStorageBootPolicy BootAllTargets -FibreChannelScanPolicy ScanConfiguredTargetsOnly -Slot1StorageBoot BootAllTargets -Slot2StorageBoot BootLimitTo3Targets -Slot3StorageBoot BootNoTargets -Slot4StorageBoot BootAllTargets -Slot5StorageBoot BootLimitTo3Targets -Slot6StorageBoot BootAllTargets -Slot7StorageBoot BootNoTargets -Slot8StorageBoot BootAllTargets -Slot9StorageBoot BootNoTargets</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedStorageBootPolicy, FibreChannelScanPolicy, Slot1StorageBoot, Slot2StorageBoot, Slot3StorageBoot, Slot4StorageBoot , Slot5StorageBoot, Slot6StorageBoot, Slot7StorageBoot, Slot8StorageBoot, and Slot9StorageBoot to specified values on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSStorageOption -Connection $connection -EmbeddedStorageBootPolicy BootAllTargets -FibreChannelScanPolicy ScanConfiguredTargetsOnly -Slot1StorageBoot BootAllTargets -Slot2StorageBoot BootLimitTo24Targets -Slot3StorageBoot BootNoTargets -Slot4StorageBoot BootAllTargets -Slot5StorageBoot BootLimitTo24Targets -Slot6StorageBoot BootAllTargets -Slot7StorageBoot BootNoTargets -Slot8StorageBoot BootAllTargets -Slot9StorageBoot BootLimitTo24Targets -Slot10StorageBoot BootLimitTo24Targets -Slot11StorageBoot BootAllTargets -Slot12StorageBoot BootNoTargets -Slot13StorageBoot BootLimitTo24Targets -Slot14StorageBoot BootLimitTo24Targets -Slot15StorageBoot BootLimitTo24Targets -Slot16StorageBoot BootLimitTo24Targets</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedStorageBootPolicy, FibreChannelScanPolicy, Slot1StorageBoot, Slot2StorageBoot, Slot3StorageBoot, Slot4StorageBoot , Slot5StorageBoot, Slot6StorageBoot, Slot7StorageBoot, Slot8StorageBoot, Slot9StorageBoot, Slot10StorageBoot, Slot11StorageBoot, Slot12StorageBoot, Slot13StorageBoot, Slot14StorageBoot , Slot15StorageBoot, and Slot16StorageBoot to specified values on a Gen10 server 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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSStorageOption -Connection $connection -EmbeddedStorageBootPolicy BootLimitTo3Targets,BootLimitTo24Targets -FibreChannelScanPolicy ScanAllTargets,ScanConfiguredTargetsOnly -Slot1StorageBoot BootAllTargets,BootLimitTo24Targets -Slot2StorageBoot BootLimitTo3Targets,BootNoTargets -Slot3StorageBoot BootNoTargets,BootAllTargets</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedStorageBootPolicy, FibreChannelScanPolicy, Slot1StorageBoot, Slot2StorageBoot, and Slot3StorageBoot to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSStorageOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSSystemInfo</command:name> <maml:description> <maml:para>The Set-HPEBIOSSystemInfo cmdlet sets the BIOS system information.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSSystemInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSSystemInfo cmdlet sets the BIOS system information. This cmdlet has the following parameters.</maml:para> <maml:para>· SerialNumber</maml:para> <maml:para>· ProductID</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSSystemInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ProductID</maml:name> <maml:description> <maml:para>Allows user to re-enter the server product ID after replacing the system board. This ID must match the ID located on the chassis.</maml:para> </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>SerialNumber</maml:name> <maml:description> <maml:para>Allows user to re-enter the server serial number after replacing the system board. Consult a qualified IT service specialist for assistance in modifying this value. This ID must match the ID located on the chassis.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ProductID</maml:name> <maml:description> <maml:para>Allows user to re-enter the server product ID after replacing the system board. This ID must match the ID located on the chassis.</maml:para> </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>SerialNumber</maml:name> <maml:description> <maml:para>Allows user to re-enter the server serial number after replacing the system board. Consult a qualified IT service specialist for assistance in modifying this value. This ID must match the ID located on the chassis.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSSystemInfo -ProductID DL180ABCDEF -SerialNumber MX12345678</dev:code> <dev:remarks> <maml:para>This example sets ProductID and SerialNumber to specified values on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSSystemInfo -Connection $connection -ProductID BL460C10ABC -SerialNumber CE123456ZW</dev:code> <dev:remarks> <maml:para>This example sets ProductID and SerialNumber to specified values on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSSystemInfo -Connection $connection -ProductID DL180ABCDEF,BL460C10ABC -SerialNumber MX12345678,CE123456ZW</dev:code> <dev:remarks> <maml:para>This example sets ProductID and SerialNumber to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSSystemInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSThermalOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSThermalOption cmdlet sets the fan cooling solution for the system.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSThermalOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSThermalOption cmdlet sets the fan cooling solution for the system. This cmdlet has the following parameters:</maml:para> <maml:para>· ThermalConfiguration</maml:para> <maml:para>· ExtendedAmbientTemperatureSupport</maml:para> <maml:para>· ThermalShutdown</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSThermalOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ExtendedAmbientTemperatureSupport</maml:name> <maml:description> <maml:para>Enables the server to operate at higher ambient temperatures than are normally supported. Possible values are Disabled, ASHRAE3, and ASHRAE4.</maml:para> <maml:para>· ASHRAE3 - Enables the server to operate in ambient temperatures up to 40 degrees Celsius.</maml:para> <maml:para>· ASHRAE4 - Enables the server to operate in ambient temperatures up to 45 degrees Celsius.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ASHRAE3</command:parameterValue> <command:parameterValue required="false" variableLength="false">ASHRAE4</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ThermalConfiguration</maml:name> <maml:description> <maml:para>Selects the fan cooling method for the system. Possible values are OptimalCooling, IncreasedCooling, MaximumCooling, and EnhancedCPUCooling.</maml:para> <maml:para>· OptimalCooling (default) - Operates fans at minimum required speeds to provide adequate cooling.</maml:para> <maml:para>· IncreasedCooling - Operates fans at a higher speed. This setting is only advised for configurations that differ from typical HP-supported configurations that cannot be cooled adequately with Optimal Cooling. This option is recommended when the system is experiencing thermal issues that cannot be resolved in another manner. Larger scale application of Increased Cooling over multiple systems may be necessary in a closed cooling loop rack, POD, or data center near the limits of its cooling capacity.</maml:para> <maml:para>· MaximumCooling - Operates fans at maximum speeds to provide greatest cooling.</maml:para> <maml:para>· EnhancedCPUCooling (Gen10 server) - Operates fans at a higher speed to provide additional cooling to the processors.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">OptimalCooling</command:parameterValue> <command:parameterValue required="false" variableLength="false">IncreasedCooling</command:parameterValue> <command:parameterValue required="false" variableLength="false">MaximumCooling</command:parameterValue> <command:parameterValue required="false" variableLength="false">EnhancedCPUCooling</command:parameterValue> </command:parameterValueGroup> <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>ThermalShutdown</maml:name> <maml:description> <maml:para>A toggle setting that determines when the server automatically powers down due to dangerous temperatures. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>ExtendedAmbientTemperatureSupport</maml:name> <maml:description> <maml:para>Enables the server to operate at higher ambient temperatures than are normally supported. Possible values are Disabled, ASHRAE3, and ASHRAE4.</maml:para> <maml:para>· ASHRAE3 - Enables the server to operate in ambient temperatures up to 40 degrees Celsius.</maml:para> <maml:para>· ASHRAE4 - Enables the server to operate in ambient temperatures up to 45 degrees Celsius.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ASHRAE3</command:parameterValue> <command:parameterValue required="false" variableLength="false">ASHRAE4</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ThermalConfiguration</maml:name> <maml:description> <maml:para>Selects the fan cooling method for the system. Possible values are OptimalCooling, IncreasedCooling, MaximumCooling, and EnhancedCPUCooling.</maml:para> <maml:para>· OptimalCooling (default) - Operates fans at minimum required speeds to provide adequate cooling.</maml:para> <maml:para>· IncreasedCooling - Operates fans at a higher speed. This setting is only advised for configurations that differ from typical HP-supported configurations that cannot be cooled adequately with Optimal Cooling. This option is recommended when the system is experiencing thermal issues that cannot be resolved in another manner. Larger scale application of Increased Cooling over multiple systems may be necessary in a closed cooling loop rack, POD, or data center near the limits of its cooling capacity.</maml:para> <maml:para>· MaximumCooling - Operates fans at maximum speeds to provide greatest cooling.</maml:para> <maml:para>· EnhancedCPUCooling (Gen10 server) - Operates fans at a higher speed to provide additional cooling to the processors.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">OptimalCooling</command:parameterValue> <command:parameterValue required="false" variableLength="false">IncreasedCooling</command:parameterValue> <command:parameterValue required="false" variableLength="false">MaximumCooling</command:parameterValue> <command:parameterValue required="false" variableLength="false">EnhancedCPUCooling</command:parameterValue> </command:parameterValueGroup> <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>ThermalShutdown</maml:name> <maml:description> <maml:para>A toggle setting that determines when the server automatically powers down due to dangerous temperatures. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSThermalOption -ExtendedAmbientTemperatureSupport ASHRAE3 -ThermalConfiguration OptimalCooling -ThermalShutdown Enabled</dev:code> <dev:remarks> <maml:para>This example sets ExtendedAmbientTemperatureSupport, ThermalConfiguration, and ThermalShutdown to specified values on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSThermalOption -ExtendedAmbientTemperatureSupport ASHRAE4 -ThermalConfiguration EnhancedCPUCooling -ThermalShutdown Disabled</dev:code> <dev:remarks> <maml:para>This example sets ExtendedAmbientTemperatureSupport, ThermalConfiguration, and ThermalShutdown to specified values on a Gen10 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSThermalOption -Connection $connection -ThermalConfiguration OptimalCooling,IncreasedCooling,MaximumCooling -ThermalShutdown Enabled,Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets ThermalConfiguration and ThermalShutdown to specified values on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSThermalOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSTLSConfiguration</command:name> <maml:description> <maml:para>The Set-HPEBIOSTLSConfiguration cmdlet sets the BIOS Transport Layer Security (TLS) configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSTLSConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSTLSConfiguration cmdlet sets the BIOS Transport Layer Security (TLS) configuration. This cmdlet has the following parameters:</maml:para> <maml:para>· Cipher (only available on Gen10 servers)</maml:para> <maml:para>· HostnameCheck (only available on Gen10 servers)</maml:para> <maml:para>· VerifyMode (only available on Gen10 servers)</maml:para> <maml:para>· ProtocolVersion (only available on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSTLSConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>Cipher</maml:name> <maml:description> <maml:para>Sets the encryption used for TLS connection. It can have more than one type of encryption, Example: \"AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256\"</maml:para> </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>HostnameCheck</maml:name> <maml:description> <maml:para>Enables or disables verification of the connected server's hostname with the hostname in the certificate supplied by the server. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VerifyMode</maml:name> <maml:description> <maml:para>Sets the verification mode for TLS connection. Possible values are None and Peer.</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">Peer</command:parameterValue> </command:parameterValueGroup> <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>ProtocolVersion</maml:name> <maml:description> <maml:para>Sets the protocol version for the TLS connection. Possible values are Auto, 1.0, 1.1, and 1.2.</maml:para> <maml:para>· AUTO - Negotiates the highest protocol version that is supported by both the TLS server and the client. · 1.0 - Uses TLS protocol version 1.0. · 1.1 - Uses TLS protocol version 1.1. · 1.2 - Uses TLS protocol version 1.2.</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">1.0</command:parameterValue> <command:parameterValue required="false" variableLength="false">1.1</command:parameterValue> <command:parameterValue required="false" variableLength="false">1.2</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>Cipher</maml:name> <maml:description> <maml:para>Sets the encryption used for TLS connection. It can have more than one type of encryption, Example: \"AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256\"</maml:para> </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>HostnameCheck</maml:name> <maml:description> <maml:para>Enables or disables verification of the connected server's hostname with the hostname in the certificate supplied by the server. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VerifyMode</maml:name> <maml:description> <maml:para>Sets the verification mode for TLS connection. Possible values are None and Peer.</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">Peer</command:parameterValue> </command:parameterValueGroup> <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>ProtocolVersion</maml:name> <maml:description> <maml:para>Sets the protocol version for the TLS connection. Possible values are Auto, 1.0, 1.1, and 1.2.</maml:para> <maml:para>· AUTO - Negotiates the highest protocol version that is supported by both the TLS server and the client. · 1.0 - Uses TLS protocol version 1.0. · 1.1 - Uses TLS protocol version 1.1. · 1.2 - Uses TLS protocol version 1.2.</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">1.0</command:parameterValue> <command:parameterValue required="false" variableLength="false">1.1</command:parameterValue> <command:parameterValue required="false" variableLength="false">1.2</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $ciphers = ,("AES128-SHA","AES256-SHA","AES128-SHA256","AES256-SHA256","AES128-GCM-SHA256","AES256-GCM-SHA384") PS C:\> $connection | Set-HPEBIOSTLSConfiguration -Cipher $ciphers -HostnameCheck Disabled -VerifyMode Peer -ProtocolVersion Auto</dev:code> <dev:remarks> <maml:para>This example sets Cipher, HostnameCheck, VerifyMode, and ProtocolVersion to specified values on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $ciphers = ,(("AES128-SHA","AES256-SHA","AES128-SHA256","AES256-SHA256","AES128-GCM-SHA256","AES256-GCM-SHA384"), ("AES128-SHA","AES256-SHA","AES128-SHA256","AES256-SHA256")) PS C:\> Set-HPEBIOSTLSConfiguration -Connection $connection -Cipher $ciphers -HostnameCheck Disabled,Enabled -VerifyMode Peer,None -ProtocolVersion Auto,1.2</dev:code> <dev:remarks> <maml:para>This example sets Cipher, HostnameCheck, VerifyMode, and ProtocolVersion to specified values on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSTPMConfiguration</command:name> <maml:description> <maml:para>The Set-HPEBIOSTPMConfiguration cmdlet sets the TPM (Trusted Platform Module) configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSTPMConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSTPMConfiguration cmdlet sets the TPM (Trusted Platform Module) configurations. This cmdlet has the following parameters.</maml:para> <maml:para>· TPMChipsetFeatureType (only available on Gen10 with Intel processor servers)</maml:para> <maml:para>· TPMChipset (only available on Gen10 with Intel processor servers)</maml:para> <maml:para>· TPMChipID (only available on Gen10 servers)</maml:para> <maml:para>· TM10Operation (only available on Gen9 servers)</maml:para> <maml:para>· TPM12Operation</maml:para> <maml:para>· TPM20Operation</maml:para> <maml:para>· TM10Visibility (only available on Gen9 servers)</maml:para> <maml:para>· TPMVisibility</maml:para> <maml:para>· TPM20Visibility (only available on Gen9 servers)</maml:para> <maml:para>· TPMBinding (only available on Gen9 servers)</maml:para> <maml:para>· TPMUEFIOptionROMMeasurement</maml:para> <maml:para>· TPM20PhysicalPresence (only available on Gen9 servers)</maml:para> <maml:para>· TPMModeSwitchOperation (only available on Gen10 servers)</maml:para> <maml:para>· TPM20SoftwareInterfaceOperation (only available on Gen10 servers)</maml:para> <maml:para></maml:para> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSTPMConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>TPMChipsetFeatureType</maml:name> <maml:description> <maml:para>Enables the chipset based TPM 2.0 feature type. Possible values are None, PTT, and Other.</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">PTT</command:parameterValue> <command:parameterValue required="false" variableLength="false">Other</command:parameterValue> </command:parameterValueGroup> <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>TPMChipset</maml:name> <maml:description> <maml:para>Enables or diables the TPM 2.0 chipset feature. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TPMChipID</maml:name> <maml:description> <maml:para>Configures the current TPM chip ID. Possible values are None, STMicroGen10, IntelPTT, and NationzTPM20.</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">STMicroGen10</command:parameterValue> <command:parameterValue required="false" variableLength="false">IntelPTT</command:parameterValue> <command:parameterValue required="false" variableLength="false">NationzTPM20</command:parameterValue> </command:parameterValueGroup> <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>TM10Operation</maml:name> <maml:description> <maml:para>Enable the Trusted Module (TM) 1.0 and BIOS secure startup. Possible values are NoAction, Disabled, Enabled, and Clear. When enabled, the TM is fully functional. When disabled, the TM is visible; however, functionality is limited. This option also enables you to reset the TM to factory settings, which clears any assigned passwords, keys, or ownership data. Clearing the TM can prevent the server from booting to a TM-aware operating system if the operating system uses TM's measurements.</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">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Clear</command:parameterValue> </command:parameterValueGroup> <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>TPM12Operation</maml:name> <maml:description> <maml:para>Enables the TPM (Trusted Platform Module) 1.2 and BIOS secure startup. Possible values are NoAction, Disabled, Enabled, and Clear. When enabled, the TPM is fully functional. When disabled, the TPM is visible; however, functionality is limited. This option also enables you to reset the TPM to factory settings, which clears any assigned passwords, keys, or ownership data. Clearing the TPM can prevent the server from booting to a TPM-aware operating system if the operating system uses TPM's measurements.</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">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Clear</command:parameterValue> </command:parameterValueGroup> <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>TPM20Operation</maml:name> <maml:description> <maml:para>Clears the operation on the TPM 2.0. Clearing the TPM can prevent the server from booting to a TPM-aware operating system if the operating system uses TPM's measurements. TPM 2.0 is only supported in UEFI Mode. Possible values are NoAction and Clear.</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">Clear</command:parameterValue> </command:parameterValueGroup> <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>TPMFunctionality</maml:name> <maml:description> <maml:para>Specifies the operational state of TPM. Possible values are Enabled and Disabled.</maml:para> <maml:para>· Enabled - TPM and Secure Boot (when enabled) are fully functional.</maml:para> <maml:para>· Disabled - TPM is visible but functionality is limited. This option also resets TPM to factory settings by clearing assigned passwords, keys, and ownership data.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TPMVisibility</maml:name> <maml:description> <maml:para>Specifies whether TPM 1.2 or TPM 2.0 is hidden or visible from the operating system. Possible values are Visible and Hidden.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Hidden</command:parameterValue> <command:parameterValue required="false" variableLength="false">Visible</command:parameterValue> </command:parameterValueGroup> <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>TM10Visibility</maml:name> <maml:description> <maml:para>Specifies whether TM 1.0 is hidden or visible from the operating system. Possible values are Visible and Hidden.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Hidden</command:parameterValue> <command:parameterValue required="false" variableLength="false">Visible</command:parameterValue> </command:parameterValueGroup> <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>TPM20Visibility</maml:name> <maml:description> <maml:para>Specifies whether TPM 2.0 is hidden or visible from the operating system. Possible values are Visible and Hidden.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Hidden</command:parameterValue> <command:parameterValue required="false" variableLength="false">Visible</command:parameterValue> </command:parameterValueGroup> <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>TPMBinding</maml:name> <maml:description> <maml:para>Specifies whether data is encrypted using a TPM bind key, which is a unique RSA key. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TPMUEFIOptionROMMeasurement</maml:name> <maml:description> <maml:para>Enables the BIOS UEFI to measure the PCI or PCIe expansion ROM code and store that measurement in the TPM. On subsequent reboots, operating systems, or validation software that utilize the measurements stored in the TPM can use this data to detect modifications to PCI or PCIe expansion ROM versions. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TPMExpansionROMMeasuring</maml:name> <maml:description> <maml:para>Enables the BIOS to measure the PCI or PCIe expansion ROM code and store that measurement in the TPM. On subsequent reboots, operating systems or validation software that utilize the measurements stored in the TPM can use this data to detect modifications to PCI or PCIe expansion ROM versions. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TPM20PhysicalPresence</maml:name> <maml:description> <maml:para>Controls the Physical Presence Interface for TPM 2.0 operation. This option is used to control whether the user is prompted during the next boot after a TPM 2.0 operation request was initiated by the Operating System. When TPM 2.0 Physical Presence Confirmation is Enabled, the system will prompt for confirmation during POST. When TPM 2.0 Physical Presence Confirmation is Disabled, the system will not prompt for confirmation during POST. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TPMModeSwitchOperation</maml:name> <maml:description> <maml:para>Switches the TPM chip to TPM 1.2 or TPM 2.0. Possible values are NoAction, TPM12, and TPM20.</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">TPM12</command:parameterValue> <command:parameterValue required="false" variableLength="false">TPM20</command:parameterValue> </command:parameterValueGroup> <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>TPM20SoftwareInterfaceOperation</maml:name> <maml:description> <maml:para>Selects the TPM 2.0 software interface for TPM operation. Possible values are NoAction, FIFOInterface, and CRBInterface.</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">FIFOInterface</command:parameterValue> <command:parameterValue required="false" variableLength="false">CRBInterface</command:parameterValue> </command:parameterValueGroup> <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="false" position="named"> <maml:name>TPMClear</maml:name> <maml:description> <maml:para>This switch parameter allows the user to reset the TPM to factory settings by clearing assigned passwords, keys, and ownership data. Clearing the TPM may prevent the server from booting to a TPM-aware operating system if the operating system was utilizing the TPM's measurements.</maml:para> </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" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>TPMChipsetFeatureType</maml:name> <maml:description> <maml:para>Enables the chipset based TPM 2.0 feature type. Possible values are None, PTT, and Other.</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">PTT</command:parameterValue> <command:parameterValue required="false" variableLength="false">Other</command:parameterValue> </command:parameterValueGroup> <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>TPMChipset</maml:name> <maml:description> <maml:para>Enables or diables the TPM 2.0 chipset feature. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TPMChipID</maml:name> <maml:description> <maml:para>Configures the current TPM chip ID. Possible values are None, STMicroGen10, IntelPTT, and NationzTPM20.</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">STMicroGen10</command:parameterValue> <command:parameterValue required="false" variableLength="false">IntelPTT</command:parameterValue> <command:parameterValue required="false" variableLength="false">NationzTPM20</command:parameterValue> </command:parameterValueGroup> <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>TM10Operation</maml:name> <maml:description> <maml:para>Enable the Trusted Module (TM) 1.0 and BIOS secure startup. Possible values are NoAction, Disabled, Enabled, and Clear. When enabled, the TM is fully functional. When disabled, the TM is visible; however, functionality is limited. This option also enables you to reset the TM to factory settings, which clears any assigned passwords, keys, or ownership data. Clearing the TM can prevent the server from booting to a TM-aware operating system if the operating system uses TM's measurements.</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">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Clear</command:parameterValue> </command:parameterValueGroup> <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>TPM12Operation</maml:name> <maml:description> <maml:para>Enables the TPM (Trusted Platform Module) 1.2 and BIOS secure startup. Possible values are NoAction, Disabled, Enabled, and Clear. When enabled, the TPM is fully functional. When disabled, the TPM is visible; however, functionality is limited. This option also enables you to reset the TPM to factory settings, which clears any assigned passwords, keys, or ownership data. Clearing the TPM can prevent the server from booting to a TPM-aware operating system if the operating system uses TPM's measurements.</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">Disabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">Clear</command:parameterValue> </command:parameterValueGroup> <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>TPM20Operation</maml:name> <maml:description> <maml:para>Clears the operation on the TPM 2.0. Clearing the TPM can prevent the server from booting to a TPM-aware operating system if the operating system uses TPM's measurements. TPM 2.0 is only supported in UEFI Mode. Possible values are NoAction and Clear.</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">Clear</command:parameterValue> </command:parameterValueGroup> <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>TPMFunctionality</maml:name> <maml:description> <maml:para>Specifies the operational state of TPM. Possible values are Enabled and Disabled.</maml:para> <maml:para>· Enabled - TPM and Secure Boot (when enabled) are fully functional.</maml:para> <maml:para>· Disabled - TPM is visible but functionality is limited. This option also resets TPM to factory settings by clearing assigned passwords, keys, and ownership data.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TPMVisibility</maml:name> <maml:description> <maml:para>Specifies whether TPM 1.2 or TPM 2.0 is hidden or visible from the operating system. Possible values are Visible and Hidden.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Hidden</command:parameterValue> <command:parameterValue required="false" variableLength="false">Visible</command:parameterValue> </command:parameterValueGroup> <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>TM10Visibility</maml:name> <maml:description> <maml:para>Specifies whether TM 1.0 is hidden or visible from the operating system. Possible values are Visible and Hidden.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Hidden</command:parameterValue> <command:parameterValue required="false" variableLength="false">Visible</command:parameterValue> </command:parameterValueGroup> <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>TPM20Visibility</maml:name> <maml:description> <maml:para>Specifies whether TPM 2.0 is hidden or visible from the operating system. Possible values are Visible and Hidden.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Hidden</command:parameterValue> <command:parameterValue required="false" variableLength="false">Visible</command:parameterValue> </command:parameterValueGroup> <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>TPMBinding</maml:name> <maml:description> <maml:para>Specifies whether data is encrypted using a TPM bind key, which is a unique RSA key. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TPMUEFIOptionROMMeasurement</maml:name> <maml:description> <maml:para>Enables the BIOS UEFI to measure the PCI or PCIe expansion ROM code and store that measurement in the TPM. On subsequent reboots, operating systems, or validation software that utilize the measurements stored in the TPM can use this data to detect modifications to PCI or PCIe expansion ROM versions. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TPMExpansionROMMeasuring</maml:name> <maml:description> <maml:para>Enables the BIOS to measure the PCI or PCIe expansion ROM code and store that measurement in the TPM. On subsequent reboots, operating systems or validation software that utilize the measurements stored in the TPM can use this data to detect modifications to PCI or PCIe expansion ROM versions. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TPM20PhysicalPresence</maml:name> <maml:description> <maml:para>Controls the Physical Presence Interface for TPM 2.0 operation. This option is used to control whether the user is prompted during the next boot after a TPM 2.0 operation request was initiated by the Operating System. When TPM 2.0 Physical Presence Confirmation is Enabled, the system will prompt for confirmation during POST. When TPM 2.0 Physical Presence Confirmation is Disabled, the system will not prompt for confirmation during POST. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TPMModeSwitchOperation</maml:name> <maml:description> <maml:para>Switches the TPM chip to TPM 1.2 or TPM 2.0. Possible values are NoAction, TPM12, and TPM20.</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">TPM12</command:parameterValue> <command:parameterValue required="false" variableLength="false">TPM20</command:parameterValue> </command:parameterValueGroup> <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>TPM20SoftwareInterfaceOperation</maml:name> <maml:description> <maml:para>Selects the TPM 2.0 software interface for TPM operation. Possible values are NoAction, FIFOInterface, and CRBInterface.</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">FIFOInterface</command:parameterValue> <command:parameterValue required="false" variableLength="false">CRBInterface</command:parameterValue> </command:parameterValueGroup> <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="false" position="named"> <maml:name>TPMClear</maml:name> <maml:description> <maml:para>This switch parameter allows the user to reset the TPM to factory settings by clearing assigned passwords, keys, and ownership data. Clearing the TPM may prevent the server from booting to a TPM-aware operating system if the operating system was utilizing the TPM's measurements.</maml:para> </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>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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>• Use Get-HPEBIOSTPMChipInfo cmdlet for TPM chip availability information.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSTPMConfiguration -TPM20Operation Clear -TPM20Visibility Visible -TPMBinding Enabled -TPMUEFIOptionROMMeasurement Enabled -TPM20PhysicalPresence Enabled</dev:code> <dev:remarks> <maml:para>This example sets TPM20Operation, TPM20Visibility, TPMBinding, TPMUEFIOptionROMMeasurement, and TPM20PhysicalPresence to specified values on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSTPMConfiguration -TPM20Operation NoAction -TPMChipsetFeatureType PTT -TPMChipset Enabled -TPMChipID IntelPTT -TPMModeSwitchOperation TPM20 -TPM20SoftwareInterfaceOperation FIFOInterface -TPMVisibility Visible -TPMUEFIOptionROMMeasurement Enabled</dev:code> <dev:remarks> <maml:para>This example sets TPM20Operation, TPMChipsetFeatureType, TPMChipset, TPMChipID, TPMModeSwitchOperation, TPM20SoftwareInterfaceOperation, TPMVisibility, and TPMUEFIOptionROMMeasurement to specified values on a Gen10 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSTPMConfiguration -Connection $connection -TPM20Operation Clear,NoAction -TPM20Visibility Visible,Hidden -TPMBinding Enabled,Disabled -TPMUEFIOptionROMMeasurement Enabled,Disabled -TPM20PhysicalPresence Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets TPM20Operation, TPM20Visibility, TPMBinding, TPMUEFIOptionROMMeasurement, and TPM20PhysicalPresence to specified values on Gen9 servers with a list of BIOS 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSTPMConfiguration -Connection $connection -TPM20Operation Clear,NoAction -TPMChipsetFeatureType PTT,None -TPMChipset Enabled,Disabled -TPMChipID IntelPTT,None -TPMModeSwitchOperation TPM20,NoAction -TPM20SoftwareInterfaceOperation FIFOInterface,NoAction -TPMVisibility Visible,Visible -TPMUEFIOptionROMMeasurement Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets TPM20Operation, TPMChipsetFeatureType, TPMChipset, TPMChipID, TPMModeSwitchOperation, TPM20SoftwareInterfaceOperation, TPMVisibility, and TPMUEFIOptionROMMeasurement to specified values on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTPMChipInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTPMConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUEFIBootOrder</command:name> <maml:description> <maml:para>The Set-HPEBIOSUEFIBootOrder cmdlet sets the UEFI Boot Order configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSUEFIBootOrder</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSUEFIBootOrder cmdlet configures the UEFI Boot Order list and controls the order in which the server attempts to boot various UEFI configured options. This cmdlet has the following parameters.</maml:para> <maml:para>· UEFIBootOrder</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSUEFIBootOrder</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UEFIBootOrder</maml:name> <maml:description> <maml:para>Use this option change the UEFI Boot Order list. This list shows you the order in which the server attempts to boot various UEFI configured options. To boot to a particular option, the option must be at the top of the list so that the server boots the option first.</maml:para> <maml:para>You may need to execute Get-HPEBIOSUEFIBootOrder first to check supported boot devices on the system.</maml:para> </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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UEFIBootOrder</maml:name> <maml:description> <maml:para>Use this option change the UEFI Boot Order list. This list shows you the order in which the server attempts to boot various UEFI configured options. To boot to a particular option, the option must be at the top of the list so that the server boots the option first.</maml:para> <maml:para>You may need to execute Get-HPEBIOSUEFIBootOrder first to check supported boot devices on the system.</maml:para> </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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[]</maml:name> <maml:uri></maml: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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $bootOrderList = $connection | Get-HPEBIOSUEFIBootOrder PS C:\> $bootOrderList.UEFIBootOrder Index DeviceName ----- ---------- 1 Embedded SATA Port 10 CD/DVD ROM : hp DVDRAM GUB0N 2 Generic USB Boot 3 Embedded RAID 1 : Smart Array P440ar Controller - 1117.78 GiB, RAID 1 Logical Drive(Target:0, Lun:0) 4 Embedded FlexibleLOM 1 Port 1 : HP FlexFabric 10Gb 2-port 533FLR-T Adapter - NIC (PXE IPv4) 5 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv4) 6 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv6) 7 Embedded FlexibleLOM 1 Port 1 : HP FlexFabric 10Gb 2-port 533FLR-T Adapter - NIC (PXE IPv6) 8 Slot 6 Port 1 : HP Ethernet 1Gb 2-port 361T Adapter - NIC (PXE IPv4) 9 Slot 6 Port 1 : HP Ethernet 1Gb 2-port 361T Adapter - NIC (PXE IPv6) PS C:\> $connection | Set-HPEBIOSUEFIBootOrder -UEFIBootOrder "3,1,2" PS C:\> $bootOrderList = $connection | Get-HPEBIOSUEFIBootOrder PS C:\> $bootOrderList.UEFIBootOrder Index DeviceName ----- ---------- 1 Embedded RAID 1 : Smart Array P440ar Controller - 1117.78 GiB, RAID 1 Logical Drive(Target:0, Lun:0) 2 Embedded SATA Port 10 CD/DVD ROM : hp DVDRAM GUB0N 3 Generic USB Boot 4 Embedded FlexibleLOM 1 Port 1 : HP FlexFabric 10Gb 2-port 533FLR-T Adapter - NIC (PXE IPv4) 5 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv4) 6 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv6) 7 Embedded FlexibleLOM 1 Port 1 : HP FlexFabric 10Gb 2-port 533FLR-T Adapter - NIC (PXE IPv6) 8 Slot 6 Port 1 : HP Ethernet 1Gb 2-port 361T Adapter - NIC (PXE IPv4) 9 Slot 6 Port 1 : HP Ethernet 1Gb 2-port 361T Adapter - NIC (PXE IPv6)</dev:code> <dev:remarks> <maml:para>This example sets UEFIBootOrder to specified values on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $bootOrderList = Get-HPEBIOSUEFIBootOrder -Connection $connection PS C:\> $bootOrderList.UEFIBootOrder Index DeviceName ----- ---------- 1 Generic USB Boot 2 Internal SD Card 1 : Generic USB3.0-CRW 3 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv4) 4 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (HTTP(S) IPv4) 5 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (HTTP(S) IPv6) 6 Embedded RAID 1 : HPE P450ar - Logical Drives 0 HBA Drives 1 PS C:\> Set-HPEBIOSUEFIBootOrder -Connection $connection -UEFIBootOrder "6,5,1" PS C:\> $bootOrderList = Get-HPEBIOSUEFIBootOrder -Connection $connection PS C:\> $bootOrderList.UEFIBootOrder Index DeviceName ----- ---------- 1 Embedded RAID 1 : HPE P450ar - Logical Drives 0 HBA Drives 1 2 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (HTTP(S) IPv6) 3 Generic USB Boot 4 Internal SD Card 1 : Generic USB3.0-CRW 5 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv4) 6 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (HTTP(S) IPv4)</dev:code> <dev:remarks> <maml:para>This example sets UEFIBootOrder to specified values on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> $bootOrderList = Get-HPEBIOSUEFIBootOrder -Connection $connection PS C:\> $bootOrderList[0].UEFIBootOrder Index DeviceName ----- ---------- 1 Embedded SATA Port 10 CD/DVD ROM : hp DVDRAM GUB0N 2 Generic USB Boot 3 Embedded RAID 1 : Smart Array P440ar Controller - 1117.78 GiB, RAID 1 Logical Drive(Target:0, Lun:0) 4 Embedded FlexibleLOM 1 Port 1 : HP FlexFabric 10Gb 2-port 533FLR-T Adapter - NIC (PXE IPv4) 5 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv4) 6 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv6) 7 Embedded FlexibleLOM 1 Port 1 : HP FlexFabric 10Gb 2-port 533FLR-T Adapter - NIC (PXE IPv6) 8 Slot 6 Port 1 : HP Ethernet 1Gb 2-port 361T Adapter - NIC (PXE IPv4) 9 Slot 6 Port 1 : HP Ethernet 1Gb 2-port 361T Adapter - NIC (PXE IPv6) PS C:\> $bootOrderList[1].UEFIBootOrder Index DeviceName ----- ---------- 1 Generic USB Boot 2 Internal SD Card 1 : Generic USB3.0-CRW 3 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv4) 4 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (HTTP(S) IPv4) 5 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (HTTP(S) IPv6) 6 Embedded RAID 1 : HPE P450ar - Logical Drives 0 HBA Drives 1 PS C:\> Set-HPEBIOSUEFIBootOrder -Connection $connection -UEFIBootOrder "3,1,2","2,3,1" PS C:\> $bootOrderList = Get-HPEBIOSUEFIBootOrder -Connection $connection PS C:\> $bootOrderList[0].UEFIBootOrder Index DeviceName ----- ---------- 1 Embedded RAID 1 : Smart Array P440ar Controller - 1117.78 GiB, RAID 1 Logical Drive(Target:0, Lun:0) 2 Embedded SATA Port 10 CD/DVD ROM : hp DVDRAM GUB0N 3 Generic USB Boot 4 Embedded FlexibleLOM 1 Port 1 : HP FlexFabric 10Gb 2-port 533FLR-T Adapter - NIC (PXE IPv4) 5 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv4) 6 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv6) 7 Embedded FlexibleLOM 1 Port 1 : HP FlexFabric 10Gb 2-port 533FLR-T Adapter - NIC (PXE IPv6) 8 Slot 6 Port 1 : HP Ethernet 1Gb 2-port 361T Adapter - NIC (PXE IPv4) 9 Slot 6 Port 1 : HP Ethernet 1Gb 2-port 361T Adapter - NIC (PXE IPv6) PS C:\> $bootOrderList[1].UEFIBootOrder Index DeviceName ----- ---------- 1 Internal SD Card 1 : Generic USB3.0-CRW 2 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (PXE IPv4) 3 Generic USB Boot 4 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (HTTP(S) IPv4) 5 Embedded LOM 1 Port 1 : HP Ethernet 1Gb 4-port 331i Adapter - NIC (HTTP(S) IPv6) 6 Embedded RAID 1 : HPE P450ar - Logical Drives 0 HBA Drives 1</dev:code> <dev:remarks> <maml:para>This example sets UEFIBootOrder to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSUEFIBootOrder</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUEFIOptimizedBoot</command:name> <maml:description> <maml:para>The Set-HPEBIOSUEFIOptimizedBoot cmdlet sets the BIOS UEFI Optimized Boot configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSUEFIOptimizedBoot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSUEFIOptimizedBoot cmdlet sets the UEFI Optimized Boot state. This cmdlet has the following parameters.</maml:para> <maml:para>· UEFIOptimizedBoot</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSUEFIOptimizedBoot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>UEFIOptimizedBoot</maml:name> <maml:description> <maml:para>Sets the UEFI Optimized Boot to be either Enabled or Disabled. When enabled, the system BIOS boots using native UEFI graphics drivers. When disabled, the system BIOS boots using INT10 legacy video support. This option can be set only when the current Boot Mode is UEFI. The UEFI Optimized Boot must be enabled for VMWare ESXi and for Secure Boot to operate properly, and be disabled when using Microsoft Windows 2008 R2 in UEFI Boot Mode because Legacy BIOS Mode components are needed for video operations in Windows. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>UEFIOptimizedBoot</maml:name> <maml:description> <maml:para>Sets the UEFI Optimized Boot to be either Enabled or Disabled. When enabled, the system BIOS boots using native UEFI graphics drivers. When disabled, the system BIOS boots using INT10 legacy video support. This option can be set only when the current Boot Mode is UEFI. The UEFI Optimized Boot must be enabled for VMWare ESXi and for Secure Boot to operate properly, and be disabled when using Microsoft Windows 2008 R2 in UEFI Boot Mode because Legacy BIOS Mode components are needed for video operations in Windows. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[]</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSUEFIOptimizedBoot -UEFIOptimizedBoot Enabled</dev:code> <dev:remarks> <maml:para>This example sets UEFIOptimizedBoot to specified values on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSUEFIOptimizedBoot -Connection $connection -UEFIOptimizedBoot Disabled</dev:code> <dev:remarks> <maml:para>This example sets UEFIOptimizedBoot to specified values on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSUEFIOptimizedBoot -Connection $connection -UEFIOptimizedBoot Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets UEFIOptimizedBoot to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSUEFIOptimizedBoot</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUPILinkPower</command:name> <maml:description> <maml:para>The Set-HPEBIOSUPILinkPower cmdlet sets the Intel UPI link power configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSUPILinkPower</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSUPILinkPower cmdlet sets the Intel UPI link power configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· IntelDirectToUPI (only available on Gen10 with Intel processor servers)</maml:para> <maml:para>· IntelUPILinkEnablement (only available on Gen10 with Intel processor servers)</maml:para> <maml:para>· IntelUPILinkFrequency (only available on Gen10 with Intel processor servers)</maml:para> <maml:para>· IntelUPILinkPowerManagement (only available on Gen10 with Intel processor servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSUPILinkPower</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>IntelDirectToUPI</maml:name> <maml:description> <maml:para>Configures the direct to UPI (D2K). Possible values are Auto, Enabled, and 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">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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntelUPILinkEnablement</maml:name> <maml:description> <maml:para>Configures the UPI topology to use fewer links between processors, when available. Changing from the default can reduce UPI bandwidth performance in exchange for less power consumption. Possible values are Auto and SingleLink.</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">SingleLink</command:parameterValue> </command:parameterValueGroup> <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>IntelUPILinkFrequency</maml:name> <maml:description> <maml:para>Setting the Intel UPI Link Frequency to a low speed may reduce power consumption but may also impact system performance. You can only configure this option if two or more CPUs are present and the Workload Profile is set to custom. Possible values are Auto and MinUPISpeed.</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">MinUPISpeed</command:parameterValue> </command:parameterValueGroup> <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>IntelUPILinkPowerManagement</maml:name> <maml:description> <maml:para>Enables or disables the Intel UPI Link Power Management. It places the UltraPath Interconnect links into a low power state when the links are not in use. This reduces power usage with minimal performance impact. You can only configure this option if two or more CPUs are present and the Workload Profile is set to custom. 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>IntelDirectToUPI</maml:name> <maml:description> <maml:para>Configures the direct to UPI (D2K). Possible values are Auto, Enabled, and 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">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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>IntelUPILinkEnablement</maml:name> <maml:description> <maml:para>Configures the UPI topology to use fewer links between processors, when available. Changing from the default can reduce UPI bandwidth performance in exchange for less power consumption. Possible values are Auto and SingleLink.</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">SingleLink</command:parameterValue> </command:parameterValueGroup> <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>IntelUPILinkFrequency</maml:name> <maml:description> <maml:para>Setting the Intel UPI Link Frequency to a low speed may reduce power consumption but may also impact system performance. You can only configure this option if two or more CPUs are present and the Workload Profile is set to custom. Possible values are Auto and MinUPISpeed.</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">MinUPISpeed</command:parameterValue> </command:parameterValueGroup> <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>IntelUPILinkPowerManagement</maml:name> <maml:description> <maml:para>Enables or disables the Intel UPI Link Power Management. It places the UltraPath Interconnect links into a low power state when the links are not in use. This reduces power usage with minimal performance impact. You can only configure this option if two or more CPUs are present and the Workload Profile is set to custom. 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSUPILinkPower -IntelDirectToUPI Enabled -IntelUPILinkEnablement Auto -IntelUPILinkFrequency Auto -IntelUPILinkPowerManagement Enabled</dev:code> <dev:remarks> <maml:para>This example sets IntelDirectToUPI, IntelUPILinkEnablement, IntelUPILinkFrequency, and IntelUPILinkPowerManagement to specified values on a Gen10 Intel server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSUPILinkPower -Connection $connection -IntelDirectToUPI Auto,Disabled -IntelUPILinkEnablement Auto,SingleLink -IntelUPILinkFrequency Auto,MinUPISpeed -IntelUPILinkPowerManagement Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets IntelDirectToUPI, IntelUPILinkEnablement, IntelUPILinkFrequency, and IntelUPILinkPowerManagement to specified values on Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSUPILinkPower</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUSBOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSUSBOption cmdlet sets the BIOS USB (Universal Serial Bus) options.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSUSBOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSUSBOption cmdlet sets the BIOS USB (Universal Serial Bus) options. This cmdlet has the following parameters.</maml:para> <maml:para>· USBControl</maml:para> <maml:para>· USBBootSupport</maml:para> <maml:para>· USB3Mode (only available on Gen9 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSUSBOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>USBControl</maml:name> <maml:description> <maml:para>Configures the USB ports and embedded devices operate at startup. Possible values are USBEnabled, USBDisabled, ExternalUSBPortDisabled, and InternalUSBPortDisabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">USBEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">USBDisabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExternalUSBPortDisabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">InternalUSBPortDisabled</command:parameterValue> </command:parameterValueGroup> <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>USBBootSupport</maml:name> <maml:description> <maml:para>Enables or disables the system from booting to any USB devices connected to the server. This includes preventing boot to virtual media devices and the embedded SD or SD card slot, if supported. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>USB3Mode</maml:name> <maml:description> <maml:para>Configures the operating mode of the USB 3.0 ports. When Auto Mode is selected, USB 3.0 capable devices operate at USB 2.0 speeds in the pre-boot environment and during boot. When a USB 3.0 capable OS USB driver loads, USB 3.0 devices transition to USB 3.0 speeds. This mode provides compatibility with operating systems that do not support USB 3.0, while enabling USB 3.0 devices to operate at USB 3.0 speeds with current operating systems. When enabled, USB 3.0 capable devices operate at USB 3.0 speeds at all times (including the pre-boot environment) when in UEFI Boot Mode. Do not use this mode with operating systems that do not support USB 3.0. If operating in Legacy Boot Mode, the USB 3.0 ports do not function in the pre-boot environment, and are not bootable. If set to disabled, USB 3.0 capable devices function at USB 2.0 speeds at all times. Possible values are Auto, Enabled and 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">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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>USBControl</maml:name> <maml:description> <maml:para>Configures the USB ports and embedded devices operate at startup. Possible values are USBEnabled, USBDisabled, ExternalUSBPortDisabled, and InternalUSBPortDisabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">USBEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">USBDisabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExternalUSBPortDisabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">InternalUSBPortDisabled</command:parameterValue> </command:parameterValueGroup> <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>USBBootSupport</maml:name> <maml:description> <maml:para>Enables or disables the system from booting to any USB devices connected to the server. This includes preventing boot to virtual media devices and the embedded SD or SD card slot, if supported. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>USB3Mode</maml:name> <maml:description> <maml:para>Configures the operating mode of the USB 3.0 ports. When Auto Mode is selected, USB 3.0 capable devices operate at USB 2.0 speeds in the pre-boot environment and during boot. When a USB 3.0 capable OS USB driver loads, USB 3.0 devices transition to USB 3.0 speeds. This mode provides compatibility with operating systems that do not support USB 3.0, while enabling USB 3.0 devices to operate at USB 3.0 speeds with current operating systems. When enabled, USB 3.0 capable devices operate at USB 3.0 speeds at all times (including the pre-boot environment) when in UEFI Boot Mode. Do not use this mode with operating systems that do not support USB 3.0. If operating in Legacy Boot Mode, the USB 3.0 ports do not function in the pre-boot environment, and are not bootable. If set to disabled, USB 3.0 capable devices function at USB 2.0 speeds at all times. Possible values are Auto, Enabled and 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">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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSUSBOption -USBControl ExternalUSBPortDisabled -USBBootSupport Enabled -USB3Mode Auto</dev:code> <dev:remarks> <maml:para>This example sets USBControl, USBBootSupport, and USB3Mode to specified values on a Gen9 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.4 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSUSBOption -USBControl InternalUSBPortDisabled -USBBootSupport Enabled</dev:code> <dev:remarks> <maml:para>This example sets USBControl and USBBootSupport to specified values on a Gen10 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSUSBOption -Connection $connection -USBControl USBEnabled,ExternalUSBPortDisabled -USBBootSupport Enabled,Disabled -USB3Mode Auto,Disabled</dev:code> <dev:remarks> <maml:para>This example sets USBControl, USBBootSupport, and USB3Mode to specified values on Gen9 servers with a list of BIOS 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSUSBOption -Connection $connection -USBControl ExternalUSBPortDisabled,InternalUSBPortDisabled -USBBootSupport Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets USBControl and USBBootSupport to specified values on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSUSBOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUserDefault</command:name> <maml:description> <maml:para>The Set-HPEBIOSUserDefault cmdlet sets the BIOS user default configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSUserDefault</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSUserDefault cmdlet saves the current configuration as the custom default configuration. Configure the system as necessary and then enable this option to save the configuration as the default configuration. When the system loads the default settings, the custom default settings are used instead of the manufacturing defaults. This cmdlet has the following parameters.</maml:para> <maml:para>· SaveUserDefault</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSUserDefault</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SaveUserDefault</maml:name> <maml:description> <maml:para>Saves the user default settings when the parameter is provided. Without switch parameter, save user default will be set to No or Cancel.</maml:para> </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" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SaveUserDefault</maml:name> <maml:description> <maml:para>Saves the user default settings when the parameter is provided. Without switch parameter, save user default will be set to No or Cancel.</maml:para> </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>HPE.BIOS.Connection[]</maml:name> <maml:uri></maml: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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSUserDefault -SaveUserDefault</dev:code> <dev:remarks> <maml:para>This example sets the UserDefaults on a Gen9 or Gen10 server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSUserDefault –Connection $connection -SaveUserDefault</dev:code> <dev:remarks> <maml:para>This example sets the UserDefaults on Gen9, and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-HPEBIOSUserDefault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-HPEBIOSUserDefault</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSUtilityLanguage</command:name> <maml:description> <maml:para>The Set-HPEBIOSUtilityLanguage cmdlet sets the BIOS system utility language.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSUtilityLanguage</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSUtilityLanguage cmdlet sets the BIOS system utility language. This cmdlet has the following parameters.</maml:para> <maml:para>· Language</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSUtilityLanguage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>Language</maml:name> <maml:description> <maml:para>Allows a user to select the current language for the system. Possible values are English, Japanese, and Chinese.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">English</command:parameterValue> <command:parameterValue required="false" variableLength="false">Japanese</command:parameterValue> <command:parameterValue required="false" variableLength="false">Chinese</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>Language</maml:name> <maml:description> <maml:para>Allows a user to select the current language for the system. Possible values are English, Japanese, and Chinese.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">English</command:parameterValue> <command:parameterValue required="false" variableLength="false">Japanese</command:parameterValue> <command:parameterValue required="false" variableLength="false">Chinese</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[]</maml:name> <maml:uri></maml: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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSUtilityLanguage -Language English</dev:code> <dev:remarks> <maml:para>This example sets Language to specified value on a Gen9 or Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSUtilityLanguage -Connection $connection -Language English,Japanese,Chinese</dev:code> <dev:remarks> <maml:para>This example sets Language to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSUtilityLanguage</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSVideoOption</command:name> <maml:description> <maml:para>The Set-HPEBIOSVideoOption cmdlet sets the BIOS video configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSVideoOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSVideoOption cmdlet sets the BIOS Video Option. This cmdlet has the following parameters.</maml:para> <maml:para>· EmbeddedVideoConnection</maml:para> <maml:para>· VideoOption</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSVideoOption</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EmbeddedVideoConnection</maml:name> <maml:description> <maml:para>Configures an external video connection to the embedded video connection. Possible values are Auto, AlwaysDisabled, and AlwaysEnabled.</maml:para> <maml:para>Auto - When configured for Auto mode, the external video connection to the embedded video controller is automatically disabled to save power when a monitor is not attached. It is automatically enabled when a monitor is attached, including when the server is operating.</maml:para> <maml:para>AlwaysDisabled - When configured for Always Disabled, the external video connection to the embedded video controller is disabled, and a monitor connected to this port does not display except during system boot. This can be used for security reasons.</maml:para> <maml:para>AlwaysEnabled - When configured for Always Enabled, the external video connection to the embedded video controller is always enabled. This option is only required if a monitor is attached with a monitor detection that does not function properly (making AUTO mode not work properly).</maml:para> <maml:para>Note: This option does not affect Integrated Remote Console video. Also, if you press F9 or F11 during system boot, the configured video connector behavior is overridden, and the video console remains enabled. This lets you reconfigure the Embedded Video Connection option even if the video 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">AlwaysDisabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">AlwaysEnabled</command:parameterValue> </command:parameterValueGroup> <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>VideoOption</maml:name> <maml:description> <maml:para>Configures video settings in the system. Possible values are OptionalVideoPrimaryEmbeddedVideoDisabled, OptionalVideoPrimaryEmbeddedVideoSecondary, EmbeddedVideoPrimaryOptionalVideoSecondary, AddInVideoEnabledEmbeddedVideoDisabled and BothAddInAndEmbeddedVideoEnabled.</maml:para> <maml:para>On Gen8 servers, by default the system BIOS disables the embedded video controller when an optional video controller is installed in the system. This option allows the embedded video controller to remain enabled so that the iLO remote video functions properly or for dual-head video support. Early system startup video is always displayed to the embedded video controller.</maml:para> <maml:para>On Gen9 and Gen10 servers, the system only displays video to the first discovered add-in video controller When set to Add-in Video Enabled, Embedded Video Disabled and the system displays video to both the embedded and the first discovered add-in video controllers When set to Both Add-in and Embedded Video Enabled. In both modes, early system startup video is displayed to the embedded video controller.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">OptionalVideoPrimaryEmbeddedVideoDisabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">OptionalVideoPrimaryEmbeddedVideoSecondary</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedVideoPrimaryOptionalVideoSecondary</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddInVideoEnabledEmbeddedVideoDisabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">BothAddInAndEmbeddedVideoEnabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>EmbeddedVideoConnection</maml:name> <maml:description> <maml:para>Configures an external video connection to the embedded video connection. Possible values are Auto, AlwaysDisabled, and AlwaysEnabled.</maml:para> <maml:para>Auto - When configured for Auto mode, the external video connection to the embedded video controller is automatically disabled to save power when a monitor is not attached. It is automatically enabled when a monitor is attached, including when the server is operating.</maml:para> <maml:para>AlwaysDisabled - When configured for Always Disabled, the external video connection to the embedded video controller is disabled, and a monitor connected to this port does not display except during system boot. This can be used for security reasons.</maml:para> <maml:para>AlwaysEnabled - When configured for Always Enabled, the external video connection to the embedded video controller is always enabled. This option is only required if a monitor is attached with a monitor detection that does not function properly (making AUTO mode not work properly).</maml:para> <maml:para>Note: This option does not affect Integrated Remote Console video. Also, if you press F9 or F11 during system boot, the configured video connector behavior is overridden, and the video console remains enabled. This lets you reconfigure the Embedded Video Connection option even if the video 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">AlwaysDisabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">AlwaysEnabled</command:parameterValue> </command:parameterValueGroup> <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>VideoOption</maml:name> <maml:description> <maml:para>Configures video settings in the system. Possible values are OptionalVideoPrimaryEmbeddedVideoDisabled, OptionalVideoPrimaryEmbeddedVideoSecondary, EmbeddedVideoPrimaryOptionalVideoSecondary, AddInVideoEnabledEmbeddedVideoDisabled and BothAddInAndEmbeddedVideoEnabled.</maml:para> <maml:para>On Gen8 servers, by default the system BIOS disables the embedded video controller when an optional video controller is installed in the system. This option allows the embedded video controller to remain enabled so that the iLO remote video functions properly or for dual-head video support. Early system startup video is always displayed to the embedded video controller.</maml:para> <maml:para>On Gen9 and Gen10 servers, the system only displays video to the first discovered add-in video controller When set to Add-in Video Enabled, Embedded Video Disabled and the system displays video to both the embedded and the first discovered add-in video controllers When set to Both Add-in and Embedded Video Enabled. In both modes, early system startup video is displayed to the embedded video controller.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">OptionalVideoPrimaryEmbeddedVideoDisabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">OptionalVideoPrimaryEmbeddedVideoSecondary</command:parameterValue> <command:parameterValue required="false" variableLength="false">EmbeddedVideoPrimaryOptionalVideoSecondary</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddInVideoEnabledEmbeddedVideoDisabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">BothAddInAndEmbeddedVideoEnabled</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSVideoOption -Connection $connection -VideoOption OptionalVideoPrimaryEmbeddedVideoDisabled,OptionalVideoPrimaryEmbeddedVideoSecondary</dev:code> <dev:remarks> <maml:para>This example sets VideoOption to specified values on Gen9 servers with a list of BIOS connection objects passed as named parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSVideoOption -Connection $connection -EmbeddedVideoConnection AlwaysEnabled,AlwaysDisabled -VideoOption OptionalVideoPrimaryEmbeddedVideoDisabled,OptionalVideoPrimaryEmbeddedVideoSecondary</dev:code> <dev:remarks> <maml:para>This example sets EmbeddedVideoConnection and VideoOption to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSVideoOption</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSVirtualization</command:name> <maml:description> <maml:para>The Set-HPEBIOSVirtualization cmdlet sets the hardware virtualization configurations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSVirtualization</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSVirtualization cmdlet sets the hardware virtualization configurations. This cmdlet has the following parameters.</maml:para> <maml:para>· AMD_Vi_IOMMU (available on Gen10 with AMD processor servers)</maml:para> <maml:para>· CPUVirtualization</maml:para> <maml:para>· Intel_VT_d2 (available on Gen9 and Gen10 with Intel processor servers)</maml:para> <maml:para>· MinimumSEV_ASID (only available on Gen10 with AMD processor servers)</maml:para> <maml:para>· SR_IOV</maml:para> <maml:para>· AccessControlService (only available on Gen10 with AMD processor servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSVirtualization</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AMD_Vi_IOMMU</maml:name> <maml:description> <maml:para>Enables or disables AMD I/O Memory Management Unit (IOMMU) virtualization functionality. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CPUVirtualization</maml:name> <maml:description> <maml:para>Enables or disables Intel Virtualization Technology on Intel processor server or AMD Virtualization on AMD processor server. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Intel_VT_d2</maml:name> <maml:description> <maml:para>Enables or disables a Virtual Machine Manager to use hardware capabilities provided by the Intel Virtualization Technology for Directed I/O. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MinimumSEV_ASID</maml:name> <maml:description> <maml:para>Defines the number of AMD Secure Encrypted Virtualization (SEV) address space identifiers (ASID) that can be used for SEV enabled guests. Non-SEV enabled guests will use the remaining ASID. Possible values are 1 to 16.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SR_IOV</maml:name> <maml:description> <maml:para>Enables or disables a hypervisor to create virtual instances of a PCI-Express device. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AccessControlService</maml:name> <maml:description> <maml:para>If enabled, Access Control Service is enabled for the downstream port. 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:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>AMD_Vi_IOMMU</maml:name> <maml:description> <maml:para>Enables or disables AMD I/O Memory Management Unit (IOMMU) virtualization functionality. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>CPUVirtualization</maml:name> <maml:description> <maml:para>Enables or disables Intel Virtualization Technology on Intel processor server or AMD Virtualization on AMD processor server. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Intel_VT_d2</maml:name> <maml:description> <maml:para>Enables or disables a Virtual Machine Manager to use hardware capabilities provided by the Intel Virtualization Technology for Directed I/O. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>MinimumSEV_ASID</maml:name> <maml:description> <maml:para>Defines the number of AMD Secure Encrypted Virtualization (SEV) address space identifiers (ASID) that can be used for SEV enabled guests. Non-SEV enabled guests will use the remaining ASID. Possible values are 1 to 16.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>SR_IOV</maml:name> <maml:description> <maml:para>Enables or disables a hypervisor to create virtual instances of a PCI-Express device. 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AccessControlService</maml:name> <maml:description> <maml:para>If enabled, Access Control Service is enabled for the downstream port. 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:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSVirtualization -AMD_Vi_IOMMU Enabled -CPUVirtualization Enabled -MinimumSEV_ASID 1 -SR_IOV Enabled</dev:code> <dev:remarks> <maml:para>This example sets AMD_Vi_IOMMU, CPUVirtualization, MinimumSEV_ASID, and SR_IOV to specified values on a Gen10 AMD server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.3 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSVirtualization -CPUVirtualization Enabled -Intel_VT_d2 Enabled -SR_IOV Enabled</dev:code> <dev:remarks> <maml:para>This example sets CPUVirtualization, Intel_VT_d2, and SR_IOV to specified values on Gen9 or Gen10 Intel server with the connection object passed through a pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSVirtualization -Connection $connection -AMD_Vi_IOMMU Enabled,Disabled -CPUVirtualization Enabled,Disabled -MinimumSEV_ASID 3,9 -SR_IOV Enabled,Disabled -AccessControlService Enabled,Disabled</dev:code> <dev:remarks> <maml:para>This example sets AMD_Vi_IOMMU, CPUVirtualization, MinimumSEV_ASID, SR_IOV and AccessControlService to specified values on Gen10 AMD servers with a list of BIOS 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:introduction> <dev:code>PS C:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSVirtualization -Connection $connection -CPUVirtualization Enabled,Disabled,Enabled -Intel_VT_d2 Enabled,Disabled,Disabled -SR_IOV Disabled,Disabled,Enabled</dev:code> <dev:remarks> <maml:para>This example sets CPUVirtualization, Intel_VT_d2, SR_IOV to specified values on Gen9 and Gen10 Intel servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSVirtualization</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSVLANConfiguration</command:name> <maml:description> <maml:para>The Set-HPEBIOSVLANConfiguration cmdlet sets the global VLAN configuration for all enabled network interfaces.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSVLANConfiguration</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSVLANConfiguration cmdlet sets the global VLAN configuration for all enabled network interfaces. This cmdlet has the following parameters.</maml:para> <maml:para>· VLANControl</maml:para> <maml:para>· VLANID</maml:para> <maml:para>· VLANPriority</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSVLANConfiguration</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>VLANControl</maml:name> <maml:description> <maml:para>Enables VLAN tagging on all enabled network interfaces. This setting is disabled by default. 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>None</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>Configures the global VLAN ID for all enabled network interfaces. Possible values are 0 to 4094. A value of 0 sets the device to send untagged frames.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VLANPriority</maml:name> <maml:description> <maml:para>Configures the priority for the VLAN tagged frames. Possible values are 0 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>VLANControl</maml:name> <maml:description> <maml:para>Enables VLAN tagging on all enabled network interfaces. This setting is disabled by default. 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>None</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>Configures the global VLAN ID for all enabled network interfaces. Possible values are 0 to 4094. A value of 0 sets the device to send untagged frames.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>VLANPriority</maml:name> <maml:description> <maml:para>Configures the priority for the VLAN tagged frames. Possible values are 0 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Set-HPEBIOSVLANConfiguration -VLANControl Enabled -VLANID 100 -VLANPriority 5</dev:code> <dev:remarks> <maml:para>This example sets VLANControl, VLANID, and VLANPriority to specified values on a Gen9 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSVLANConfiguration -Connection $connection -VLANControl Disabled -VLANID 0 -VLANPriority 0</dev:code> <dev:remarks> <maml:para>This example sets VLANControl, VLANID, and VLANPriority to specified values on a Gen10 server 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:\> $connection = Connect-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Set-HPEBIOSVLANConfiguration -Connection $connection -VLANControl Enabled,Disabled -VLANID 0,4000 -VLANPriority 0,1</dev:code> <dev:remarks> <maml:para>This example sets VLANControl, VLANID, and VLANPriority to specified values on Gen9 and Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSVLANConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSWorkloadProfile</command:name> <maml:description> <maml:para>The Set-HPEBIOSWorkloadProfile cmdlet sets the BIOS workload profile configuration.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>HPEBIOSWorkloadProfile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-HPEBIOSWorkloadProfile cmdlet sets the BIOS workload profile configuration. This cmdlet has the following parameters.</maml:para> <maml:para>· WorkloadProfile (only available on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-HPEBIOSWorkloadProfile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>WorkloadProfile</maml:name> <maml:description> <maml:para>Enables the user to select the appropriate workload profile based on power and performance characteristics. Possible values are GeneralPowerEfficientCompute, GeneralPeakFrequencyCompute, GeneralThroughputCompute, VirtualizationPowerEfficient, VirtualizationMaximumPerformance, LowLatency, MissionCritical, TransactionalApplicationProcessing, HighPerformanceCompute, DecisionSupport, GraphicProcessing, IOThroughput (Input/Output throughput), WebE-Commerce (Web or E-Commerce), ExtremeEfficientCompute, and Custom.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">GeneralPowerEfficientCompute</command:parameterValue> <command:parameterValue required="false" variableLength="false">GeneralPeakFrequencyCompute</command:parameterValue> <command:parameterValue required="false" variableLength="false">GeneralThroughputCompute</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualizationPowerEfficient</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualizationMaximumPerformance</command:parameterValue> <command:parameterValue required="false" variableLength="false">LowLatency</command:parameterValue> <command:parameterValue required="false" variableLength="false">MissionCritical</command:parameterValue> <command:parameterValue required="false" variableLength="false">TransactionalApplicationProcessing</command:parameterValue> <command:parameterValue required="false" variableLength="false">HighPerformanceCompute</command:parameterValue> <command:parameterValue required="false" variableLength="false">DecisionSupport</command:parameterValue> <command:parameterValue required="false" variableLength="false">GraphicProcessing</command:parameterValue> <command:parameterValue required="false" variableLength="false">IOThroughput</command:parameterValue> <command:parameterValue required="false" variableLength="false">WebE-Commerce</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExtremeEfficientCompute</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>WorkloadProfile</maml:name> <maml:description> <maml:para>Enables the user to select the appropriate workload profile based on power and performance characteristics. Possible values are GeneralPowerEfficientCompute, GeneralPeakFrequencyCompute, GeneralThroughputCompute, VirtualizationPowerEfficient, VirtualizationMaximumPerformance, LowLatency, MissionCritical, TransactionalApplicationProcessing, HighPerformanceCompute, DecisionSupport, GraphicProcessing, IOThroughput (Input/Output throughput), WebE-Commerce (Web or E-Commerce), ExtremeEfficientCompute, and Custom.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">GeneralPowerEfficientCompute</command:parameterValue> <command:parameterValue required="false" variableLength="false">GeneralPeakFrequencyCompute</command:parameterValue> <command:parameterValue required="false" variableLength="false">GeneralThroughputCompute</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualizationPowerEfficient</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualizationMaximumPerformance</command:parameterValue> <command:parameterValue required="false" variableLength="false">LowLatency</command:parameterValue> <command:parameterValue required="false" variableLength="false">MissionCritical</command:parameterValue> <command:parameterValue required="false" variableLength="false">TransactionalApplicationProcessing</command:parameterValue> <command:parameterValue required="false" variableLength="false">HighPerformanceCompute</command:parameterValue> <command:parameterValue required="false" variableLength="false">DecisionSupport</command:parameterValue> <command:parameterValue required="false" variableLength="false">GraphicProcessing</command:parameterValue> <command:parameterValue required="false" variableLength="false">IOThroughput</command:parameterValue> <command:parameterValue required="false" variableLength="false">WebE-Commerce</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExtremeEfficientCompute</command:parameterValue> <command:parameterValue required="false" variableLength="false">Custom</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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.Management.Automation.PSObject[]</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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $result = $connection | Set-HPEBIOSWorkloadProfile -WorkloadProfile ExtremeEfficientCompute PS C:\> $result | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on WorkloadProfile.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]} PS C:\> $result.StatusInfo | fl Category : Dependency Message : Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on WorkloadProfile. AffectedAttribute : {[PowerRegulator, DynamicPowerSavingsMode], [SR_IOV, Disabled], [Intel_VT_d2, Disabled], [CPUVirtualization, Disabled]...} PS C:\> $result.StatusInfo.AffectedAttribute Key Value --- ----- PowerRegulator DynamicPowerSavingsMode SR_IOV Disabled Intel_VT_d2 Disabled CPUVirtualization Disabled MinimumProcessorIdlePowerCoreState C6State MinimumProcessorIdlePowerPackageState PackageC6State EnergyPerformanceBias BalancedPerformance CollaborativePowerControl Disabled IntelDMILinkFrequency GEN1Speed IntelTurboBoost Disabled IntelNICDMAChannel Disabled HWPrefetcher Disabled AdjacentSectorPrefetch Disabled DCUStreamerPrefetcher Disabled DCUIPPrefetcher Enabled NUMAGroupSizeOptimization Clustered MemoryPatrolScrubbing Disabled MemoryRefreshRate Refreshx1 IntelUPILinkPowerManagement Enabled SubNUMAClustering Enabled EnergyEfficientTurbo Enabled UncoreFrequencyScaling Auto ProcessorX2ApicSupport Disabled ChannelInterleaving Enabled</dev:code> <dev:remarks> <maml:para>This example sets WorkloadProfile to specified value on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2,10.20.30.3 -Username admin -Password admin123 PS C:\> Set-HPEBIOSWorkloadProfile -Connection $connection -WorkloadProfile HighPerformanceCompute,DecisionSupport,Custom | fl IP : 10.20.30.1 Hostname : abc1.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on WorkloadProfile.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]} IP : 10.20.30.2 Hostname : abc2.domain.com Status : Warning StatusInfo : @{Category=Dependency; Message=Features(s) listed in AffectedAttribute might get modified to specified values due to dependency on WorkloadProfile.; AffectedAttribute=System.Collections.Generic.Dictionary`2[System.String,System.Object]}</dev:code> <dev:remarks> <maml:para>This example sets WorkloadProfile to specified values on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSWorkloadProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.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-HPEBIOSConnection</command:name> <maml:description> <maml:para>The Test-HPEBIOSConnection cmdlet checks if the connection to the target is still valid.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Test</command:verb> <command:noun>HPEBIOSConnection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-HPEBIOSConnection cmdlet checks whether the connection to the target is still valid. The result will be stored in IsConnected output property. For a valid connection, IsConnected will be True; otherwise it will be False. In case of an error, the StatusInfo output property will hold the error category and message.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="UsernamePasswordSet" default="true"> <!--NAME: UsernamePasswordSet--> <!--TAG: DEFAULT--> <maml:name>Test-HPEBIOSConnection</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>HPE.BIOS.Connection[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml: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 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.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 example shows the output on the server with the BIOS 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.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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Uninstall-HPEBIOSTLSCertificate</command:name> <maml:description> <maml:para>The Uninstall-HPEBIOSTLSCertificate cmdlet uninstalls the installed certificate.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Uninstall</command:verb> <command:noun>HPEBIOSTLSCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Uninstall-HPEBIOSTLSCertificate cmdlet uninstalls the installed certificate. This cmdlet supports only on Gen10 servers. This cmdlet has the following parameter:</maml:para> <maml:para>· TLSCertificateIndex (only available on Gen10 servers)</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Uninstall-HPEBIOSTLSCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>TLSCertificateIndex</maml:name> <maml:description> <maml:para>Use this option to uninstall one or more installed certificates. if you want to uninstall more than one certificate, enter the index value with comma separated delimiter. Example: 1,3.</maml:para> <maml:para>The certificate in uninstallation queue is uninstalled only when you reboot the server. Use the Get-HPEBIOSTLSCertificateUninstallationQueue cmdlet to get the list of certificates in the uninstallation 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="conn , Session"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Connection object to BIOS. This is a session object that identifies the target to which the connection is established. The Connection object is created by the Connect-HPEBIOS command using the IP/Hostname and accompanying Username and Password to log into the BIOS.</maml:para> <maml:para>Aliases: conn, Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</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>TLSCertificateIndex</maml:name> <maml:description> <maml:para>Use this option to uninstall one or more installed certificates. if you want to uninstall more than one certificate, enter the index value with comma separated delimiter. Example: 1,3.</maml:para> <maml:para>The certificate in uninstallation queue is uninstalled only when you reboot the server. Use the Get-HPEBIOSTLSCertificateUninstallationQueue cmdlet to get the list of certificates in the uninstallation 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>HPE.BIOS.Connection[] 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 or System.Management.Automation.PSObject[]</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 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-HPEBIOS -IP 10.20.30.1 -Username admin -Password admin123 PS C:\> $connection | Uninstall-HPEBIOSTLSCertificate -TLSCertificateIndex "1,3"</dev:code> <dev:remarks> <maml:para>This example uninstalls the existing installed certificate at index 1 and 3 on a Gen10 server with the connection object passed through a pipeline.</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-HPEBIOS -IP 10.20.30.1,10.20.30.2 -Username admin -Password admin123 PS C:\> Uninstall-HPEBIOSTLSCertificate -Connection $connection -TLSCertificateIndex 1</dev:code> <dev:remarks> <maml:para>This example uninstalls the existing installed certificate at Index 1 on Gen10 servers with a list of BIOS 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-HPEBIOS</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-HPEBIOSTLSCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2019 v2.3.42--> </helpItems> |