HP Scripting Tools for Windows PowerShell User Manual
HP Scripting Tools for Windows PowerShell User Guide
iLO Cmdlets
Abstract
This document contains instructions for using HP Scripting Tools for Windows PowerShell to manage HP iLO. It is intended for
system administrators who use the HP Scripting Tools for Windows PowerShell to manage their IT infrastructure.
HP Part Number: 745004-002a
Published: April 2014
Edition: 2
© Copyright 2013, 2014 Hewlett-Packard Development Company, L.P.
Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial
Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under
vendor's standard commercial license.
The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express
warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall
not be liable for technical or editorial errors or omissions contained herein.
Acknowledgments
Microsoft®, Windows®, Windows® XP, and Windows NT® are U.S. registered trademarks of Microsoft Corporation.
Contents
1 Introduction to HP Scripting Tools for Windows PowerShell...............................4
Windows PowerShell.................................................................................................................4
Features..................................................................................................................................4
2 Installation.................................................................................................5
System prerequisites..................................................................................................................5
Supported operating systems......................................................................................................5
Installing HP iLO Cmdlets for Windows PowerShell........................................................................5
Uninstalling HP iLO Cmdlets for Windows PowerShell....................................................................6
3 HP Scripting Tools for Windows PowerShell cmdlets........................................7
IPv6 support..........................................................................................................................10
Using the Find-HPiLO cmdlet.....................................................................................................11
Piping output from one command to another..............................................................................12
Using the Get-HPiLOModuleVersion and Update-HPiLOModuleVersion cmdlets................................13
Using the Update-HPiLOFirmware cmdlet...................................................................................14
Using iLO cmdlets on multiple targets........................................................................................14
Log processing examples.........................................................................................................17
Return objects and error handling.............................................................................................19
Script writing methodology......................................................................................................20
4 Troubleshooting........................................................................................21
General issues.......................................................................................................................21
Verifying iLO firmware versions............................................................................................21
5 Support and other resources......................................................................22
Contacting HP........................................................................................................................22
Support Information................................................................................................................22
Subscription service............................................................................................................22
HP Support Center.............................................................................................................22
Contact support.................................................................................................................22
Reporting errors to HP........................................................................................................22
Related information............................................................................................................22
Windows PowerShell resources.................................................................................................23
6 Documentation feedback...........................................................................24
Index.........................................................................................................25
Contents 3
1 Introduction to HP Scripting Tools for Windows PowerShell
The HP Scripting Tools for Windows PowerShell provides a simplified and consistent infrastructure
management experience. This set of PowerShell utilities provides a comprehensive set of HP
integration tools. It is designed for IT experts with experience in PowerShell scripting and configuring
ProLiant server hardware.
The HP Scripting Tools for Windows PowerShell includes a set of PowerShell cmdlets for configuring
HP hardware using familiar PowerShell syntax. Documentation describing how to apply these new
tools to configure HP hardware is also included.
This guide is intended for system administrators who use the HP Scripting Tools for Windows
PowerShell to manage their IT infrastructure. Users should be familiar with Windows PowerShell.
This guide describes the cmdlets included in version 1.1 of the HP iLO Cmdlets for Windows
PowerShell. For information on the cmdlets added in version 1.1, see the HP Scripting Tools for
Windows PowerShell Release Notes iLO Cmdlets v1.1.
Windows PowerShell
Windows PowerShell is Microsoft's task automation framework, consisting of a command-line shell
and associated scripting language built on a .NET Framework. As businesses face the need to
configure large numbers of servers in a quick and reliable fashion, HP Scripting Tools for Windows
PowerShell is a powerful set of utilities that can be used to perform various configuration tasks on
HP hardware. These cmdlets follow the standard PowerShell syntax and scripting model, making
it easy for you to incorporate these functions into your administrative scripts.
Features
HP iLO Cmdlets for Windows PowerShell provides the following features:
• Support for iLO 3 and iLO 4 configuration.
• Uses proven PowerShell technology to provide consistent and reliable server configuration.
• Supports the standard PowerShell architecture and scripting model.
• Object oriented—output from one command can be piped to another command.
• Built-in online help for all HP PowerShell cmdlets, documenting syntax and usage examples.
4 Introduction to HP Scripting Tools for Windows PowerShell
2 Installation
System prerequisites
The following prerequisites must be met before installing HP iLO Cmdlets for Windows PowerShell.
There are also several items to consider in the install.
• Microsoft Management Framework 3.0 or later (which includes PowerShell 3.0 or later) must
be installed on your system before installing the HP Scripting Tools for Windows PowerShell.
Microsoft .NET Framework 4 or later must be installed before installing Microsoft Management
Framework 3.0 or later. The following links provide access to the Microsoft download sites
for these applications.
◦ Microsoft .NET Framework 4
◦ Microsoft .NET Framework 4.5
◦ Windows Management Framework 3.0
◦ Windows Management Framework 4.0
• Make sure you read and understand the system requirements and other information provided
on the above pages.
Supported operating systems
HP iLO Cmdlets for Windows PowerShell are supported on the following operating system versions:
• Microsoft Windows 7 SP1
• Microsoft Windows 8
• Microsoft Windows 8.1
• Microsoft Windows Server 2008 R2 SP1
• Microsoft Windows Server 2012
• Microsoft Windows Server 2012 R2
Installing HP iLO Cmdlets for Windows PowerShell
The HP iLO Cmdlets for Windows PowerShell can be downloaded from the following website:
http://www.hp.com/go/powershell.
Using the following guidelines when installing HP iLO Cmdlets for Windows PowerShell:
• Close any PowerShell windows before the installation and open new ones after the installation
is complete.
• The installer should be run from an account with administrative privilege using any normal
method of execution (command line or double click). If you run from an account without
administrative privilege, use one of the following options:
Procedure 1
1. Click Start and select All Programs→Accessories→Windows PowerShell.
2. Right-click one of the PowerShell options and select Run as administrator.
3. Change (CD) to the directory where you unzipped the installer.
4. On the PowerShell command line run either the 64-bit (HPiLOCmdlets-x64.msi) or
the 32-bit (HPiLOCmdlets-x86.msi) installer as appropriate for your system.
System prerequisites 5
Procedure 2
1. Click Start and select Run...
2. In the Run dialog enter the path and filename of the correct installer for your system, either
the 64-bit (HPiLOCmdlets-x64.msi) or the 32-bit (HPiLOCmdlets-x86.msi).
• It might be necessary to change the execution policy for PowerShell. Use the following help
command to get more information to help you to decide what to select:
help about_Execution_Policies
Use the following command to see your current execution policy settings:
Get-ExecutionPolicy -list
You can use the following PowerShell command until you determine if it meets your needs:
Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned
• Upgrading from a previous release is supported.
• The installation will halt and not complete successfully if any of the following conditions are
detected:
◦ Attempting to install the X86 package on a 64-bit operating system
◦ Attempting to install without .NET 4.0 or above
◦ Attempting to install without PowerShell 3.0 or above
Uninstalling HP iLO Cmdlets for Windows PowerShell
To uninstall the HP iLO Cmdlets for Windows PowerShell:
1. Open Windows Control Panel.
2. Select Programs and Features.
3. Select Hewlett-Packard iLO Cmdlets.
4. Click Uninstall.
6 Installation
3 HP Scripting Tools for Windows PowerShell cmdlets
Table 1 provides a list and brief description of all the HPiLOCmdlets for Windows PowerShell.
Cmdlet Help
The HPiLOCmdlets are supported by help, which is used in the same way as other PowerShell
cmdlets. To display a complete list of the HPiLOCmdlets in PowerShell, type:
help *hpilo*
NOTE: You can also use the following command to display the HP iLO Cmdlets:
Get-Command –Module HPiLOCmdlets
To display complete help for a specific cmdlet, type:
help <cmdlet> -Full
where <cmdlet> is the name of the HP iLO Cmdlet.
The HP iLO Cmdlets support the PowerShell Update-Help feature. When you execute this
command, it accesses an HP website, gets the most current help file(s), and puts them in the correct
location on your system.
Table 1 HP iLO Cmdlets for Windows PowerShell
DescriptionCmdlet
Enable-HPiLOFIPS
Add a new HP SIM Single Sign-On (SSO) Server RecordAdd-HPiLOSSORecord
Adds a local user account to the iLOAdd-HPiLOUser
Clear the AHS information from the AHS logsClear-HPiLOAHSData
Clear the iLO event logsClear-HPiLOEventLog
Clear the Integrated Management LogsClear-HPiLOIML
Clears the virtual clock counter without power-cycling the serverClear-HPiLOPowerOnTime
Disables Insight Remote Support functionality and unregisters the serverDisable-HPiLOERSIRSConnection
Disables the display of security text message in the iLO Login BannerDisable-HPiLOSecurityMessage
Dismounts the Virtual Media image if one is mounted.Dismount-HPiLOVirtualMedia
Enables the Federal Information Processing Standard Enforce AES/3DES
Encryption setting
Connect to the Insight Remote Support server, and register the serverEnable-HPiLOERSIRSConnection
Enables the security text message in the iLO Login BannerEnable-HPiLOSecurityMessage
Find list of iLO in a specified subnetFind-HPiLO
Gets the AHS statusGet-HPiLOAHSStatus
Gets the Asset tagGet-HPiLOAssetTag
Gets the Certificate Signing Request statusGet-HPiLOCertificateSigningRequest
Gets the default language on iLOGet-HPiLODefaultLanguage
Gets the current directory configurationGet-HPiLODirectory
Gets the drive details for the serverGet-HPiLODriveInfo
Gets the Integrated Remote Support settingGet-HPiLOERSSetting
7
Table 1 HP iLO Cmdlets for Windows PowerShell (continued)
DescriptionCmdlet
Gets the iLO event logsGet-HPiLOEventLog
Gets the Fan health details from the serverGet-HPiLOFan
Gets the current Enforce AES/3DES Encryption status.Get-HPiLOFIPSStatus
Gets the Firmware details for the iLOGet-HPiLOFirmwareInfo
Gets the iLO Firmware versionGet-HPiLOFirmwareVersion
Gets the iLO Global SettingsGet-HPiLOGlobalSetting
Gets the health information summary of the host serverGet-HPiLOHealthSummary
Gets the current Automatic Power On and Power On Delay settingsGet-HPiLOHostAPO
Gets the host data displayed on the Server Information pageGet-HPiLOHostData
Gets the power state of the serverGet-HPiLOHostPower
Gets the Power Micro Version numberGet-HPiLOHostPowerMicroVersion
Gets the state of the processor power regulator feature of the serverGet-HPiLOHostPowerSaver
Gets hotkeys available for use in remote console sessionsGet-HPiLOHotkeyConfig
Gets the Integrated management logsGet-HPiLOIML
Get-HPiLOOAInfo
Get-HPiLOPowerOnTime
Gets all languages on iLOGet-HPiLOLanguage
Gets license types and keysGet-HPiLOLicense
Gets the Memory details for the host server where the iLO is locatedGet-HPiLOMemoryInfo
Gets the module details for the HPiLOCmdletsGet-HPiLOModuleVersion
Gets the current network settingsGet-HPiLONetworkSetting
Gets the NIC details for the System NIC and the iLO NICGet-HPiLONICInfo
Gets the Onboard Administrator information from the enclosure where iLO
is located
Gets the current state of the one-time bootGet-HPiLOOneTimeBootOrder
Gets the current boot orderGet-HPiLOPersistentBootOrder
Gets the power alert threshold for the iLO devicesGet-HPiLOPowerAlertThreshold
Gets the Power Cap of the serverGet-HPiLOPowerCap
Gets the virtual clock value, in minutes, since the server was last powered
on
Gets the power readings from the server power supplyGet-HPiLOPowerReading
Gets the Power supply details for the host server where the iLO is locatedGet-HPiLOPowerSupply
Gets the processor details for the host serverGet-HPiLOProcessor
Get-HPiLOProfile
8 HP Scripting Tools for Windows PowerShell cmdlets
Gets all the Profile Descriptors and the data stored in them in the perm
directory of the blobstore
Gets the result of the Invoke-HPiLOProfileApply cmdletGet-HPiLOProfileApplyResult
Gets the rack settings for an iLOGet-HPiLORackSetting
Gets the security message for the iLO login screenGet-HPiLOSecurityMessage
Gets the host server name used by iLOGet-HPiLOServerName
Loading...