-
HP iLO 4 Scripting and Command LineGuide
AbstractThis document describes the syntax and tools available
for use with the HP iLO firmware through the command line or a
scriptedinterface. This document is for the person who installs,
administers, and troubleshoots servers and storage systems. HP
assumesyou are qualified in the servicing of computer equipment and
trained in recognizing hazards in products with hazardous
energylevels.
Use this guide for HP iLO ProLiant servers and ProLiant
BladeSystem server blades. For information about iLO for
Integrityservers and server blades, see the HP website at
http://www.hp.com/go/integrityiLO.
HP Part Number: 684919-008Published: September 2014Edition:
1
http://www.hp.com/go/integrityiLO
-
Copyright 2012, 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, CommercialComputer Software, Computer Software
Documentation, and Technical Data for Commercial Items are licensed
to the U.S. Government undervendors 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 expresswarranty statements accompanying such products
and services. Nothing herein should be construed as constituting an
additional warranty. HP shallnot be liable for technical or
editorial errors or omissions contained herein.
Acknowledgments
Microsoft,Windows, and Windows Server are U.S. registered
trademarks of the Microsoft group of companies.
Intel is a trademark of Intel Corporation in the U.S. and other
countries.
Java and Oracle are registered trademarks of Oracle and/or its
affiliates.
Warranty
HP will replace defective delivery media for a period of 90 days
from the date of purchase. This warranty applies to all Insight
Managementproducts.
-
Contents1
Introduction.............................................................................................13
Scripting and command line guide
overview..............................................................................13Scripting
and command line
utilities..........................................................................................13
HPQLOCFG
Utility.............................................................................................................14LOCFG.PL
Script................................................................................................................14HPONCFG
Utility..............................................................................................................14SMASH
CLP......................................................................................................................14IPMI.................................................................................................................................15
New in this
version.................................................................................................................15HP
Insight Control server
deployment........................................................................................15
2 HPQLOCFG
usage...................................................................................16Configuring
for unauthenticated XML
queries..............................................................................16Creating
a system collection in HP
SIM......................................................................................18Launch
applications with HP SIM custom
tools............................................................................18Batch
processing using
HPQLOCFG..........................................................................................18HPQLOCFG
command line
parameters.....................................................................................19
Using quote
characters.......................................................................................................19Command
line
switches......................................................................................................20
Using variables and name value pairs with
HPQLOCFG.....................................................203
LOCFG.PL
usage......................................................................................22
LOCFG.PL
Utility.....................................................................................................................22LOCFG.PL
command line
switches.............................................................................................22
4 HPONCFG online configuration
utility.........................................................23HPONCFG............................................................................................................................23HPONCFG
supported operating
systems...................................................................................23HPONCFG
requirements.........................................................................................................23Installing
HPONCFG...............................................................................................................23
Windows server
installation.................................................................................................24Linux
server installation
......................................................................................................24VMware
installation...........................................................................................................24
HPONCFG
utility....................................................................................................................24HPONCFG
command line
parameters..................................................................................25
Using HPONCFG on Windows
servers............................................................................25Using
HPONCFG on Linux
servers...................................................................................26
Obtaining the basic
configuration........................................................................................26Obtaining
a specific
configuration.......................................................................................27Setting
a
configuration.......................................................................................................28Using
variable
substitution...................................................................................................28Capturing
and restoring a
configuration................................................................................29
5 SMASH CLP
usage...................................................................................31SMASH
CLP
..........................................................................................................................31
6 IPMI
usage..............................................................................................32The
IPMI
utility........................................................................................................................32Basic
IPMI tool
usage..............................................................................................................32Advanced
IPMI tool usage on
Linux...........................................................................................32Advanced
IPMIutil usage on
Windows......................................................................................33
7 SMASH CLP Scripting
Language................................................................34SMASH
CLP command line
overview........................................................................................34
Contents 3
-
SMASH CLP command line
access............................................................................................34Using
the command
line..........................................................................................................34Escape
commands..................................................................................................................35Base
commands.....................................................................................................................36
Using the NIC auto-selection
feature.....................................................................................37Specific
commands.................................................................................................................38
User
commands.................................................................................................................38HP
SSO
settings.................................................................................................................39Network
commands...........................................................................................................41iLO
4
settings....................................................................................................................43iLO
4 embedded health
settings...........................................................................................44SNMP
settings...................................................................................................................45License
commands.............................................................................................................46Directory
commands..........................................................................................................47Virtual
Media
commands....................................................................................................48Start
and Reset
commands..................................................................................................51Firmware
commands..........................................................................................................51
Non-iLO firmware
commands..........................................................................................52Eventlog
commands...........................................................................................................53Blade
commands...............................................................................................................54Boot
commands.................................................................................................................54LED
commands..................................................................................................................57System
properties and
targets..............................................................................................57Other
commands...............................................................................................................60
8 RIBCL XML Scripting
Language...................................................................61Overview
of the
RIBCL.............................................................................................................61
XML
headers.....................................................................................................................61Data
types........................................................................................................................62
String..........................................................................................................................62Specific
string...............................................................................................................63Boolean
string..............................................................................................................63
Response
definitions...........................................................................................................63RIBCL....................................................................................................................................63
RIBCL
parameters...............................................................................................................63RIBCL
runtime
errors...........................................................................................................64Combining
multiple commands in one RIBCL
script.................................................................64
LOGIN..................................................................................................................................65LOGIN
parameters.............................................................................................................66LOGIN
runtime
errors.........................................................................................................66
USER_INFO...........................................................................................................................66ADD_USER.......................................................................................................................66
ADD_USER
parameters..................................................................................................67ADD_USER
runtime
errors..............................................................................................67
DELETE_USER....................................................................................................................68DELETE_USER
parameter................................................................................................68DELETE_USER
runtime
errors...........................................................................................68
DEL_USERS_SSH_KEY........................................................................................................68DEL_SSH_KEY
parameters..............................................................................................69DEL_SSH_KEY
runtime
errors..........................................................................................69
GET_USER........................................................................................................................69GET_USER
parameter....................................................................................................69GET_USER
runtime
errors...............................................................................................69GET_USER
return
messages............................................................................................69
MOD_USER......................................................................................................................70
4 Contents
-
MOD_USER
parameters.................................................................................................70MOD_USER
runtime
errors.............................................................................................71
GET_ALL_USERS................................................................................................................71GET_ALL_USERS
parameters...........................................................................................72GET_ALL_USERS
runtime
errors.......................................................................................72GET_ALL_USERS
return
messages....................................................................................72
GET_ALL_USER_INFO........................................................................................................72GET_ALL_USER_INFO
parameters...................................................................................72GET_ALL_USER_INFO
runtime
errors................................................................................73GET_ALL_USER_INFO
return
messages............................................................................73
RIB_INFO..............................................................................................................................73RESET_RIB.........................................................................................................................74
RESET_RIB
parameters...................................................................................................74RESET_RIB
runtime
errors................................................................................................74
GET_EVENT_LOG..............................................................................................................74GET_EVENT_LOG
parameters........................................................................................74GET_EVENT_LOG
runtime
errors.....................................................................................75GET_EVENT_LOG
return
messages..................................................................................75
GET_FEDERATION_MULTICAST...........................................................................................76GET_FEDERATION_MULTICAST
parameters......................................................................76GET_FEDERATION_MULTICAST
runtime
errors..................................................................76GET_FEDERATION_MULTICAST
return
messages...............................................................76
SET_FEDERATION_MULTICAST............................................................................................76SET_FEDERATION_MULTICAST
parameters.......................................................................77SET_FEDERATION_MULTICAST
runtime
errors...................................................................77
GET_FEDERATION_ALL_GROUPS........................................................................................77GET_FEDERATION_ALL_GROUPS
parameters...................................................................77GET_FEDERATION_ALL_GROUPS
runtime
errors...............................................................78GET_FEDERATION_ALL_GROUPS
return
messages............................................................78
GET_FEDERATION_ALL_GROUPS_INFO...............................................................................78GET_FEDERATION_ALL_GROUPS_INFO
parameters.........................................................78GET_FEDERATION_ALL_GROUPS_INFO
runtime
errors......................................................78GET_FEDERATION_ALL_GROUPS_INFO
return
messages...................................................78
GET_FEDERATION_GROUP................................................................................................79GET_FEDERATION_GROUP
parameters...........................................................................79GET_FEDERATION_GROUP
runtime
errors.......................................................................79GET_FEDERATION_GROUP
return
messages....................................................................80
ADD_FEDERATION_GROUP...............................................................................................80ADD_FEDERATION_GROUP
parameters..........................................................................80ADD_FEDERATION_GROUP
runtime
errors.......................................................................81
MOD_FEDERATION_GROUP..............................................................................................81MOD_FEDERATION_GROUP
parameters.........................................................................81MOD_FEDERATION_GROUP
runtime
errors.....................................................................82
DELETE_FEDERATION_GROUP............................................................................................82DELETE_FEDERATION_GROUP
parameters.......................................................................82DELETE_FEDERATION_GROUP
runtime
errors...................................................................82
CLEAR_EVENTLOG............................................................................................................83CLEAR_EVENTLOG
parameters.......................................................................................83CLEAR_EVENTLOG
runtime
errors...................................................................................83
COMPUTER_LOCK_CONFIG..............................................................................................83COMPUTER_LOCK_CONFIG
parameters.........................................................................84COMPUTER_LOCK_CONFIG
runtime
errors.....................................................................84
GET_NETWORK_SETTINGS................................................................................................84GET_NETWORK_SETTINGS
parameters..........................................................................84GET_NETWORK_SETTINGS
runtime
errors.......................................................................84
Contents 5
-
GET_NETWORK_SETTINGS return
messages....................................................................85MOD_NETWORK_SETTINGS..............................................................................................86
MOD_NETWORK_SETTINGS runtime
errors.....................................................................90MOD_NETWORK_SETTINGS
parameters........................................................................90
GET_GLOBAL_SETTINGS....................................................................................................94GET_GLOBAL_SETTINGS
parameters...............................................................................95GET_GLOBAL_SETTINGS
runtime
errors...........................................................................95GET_GLOBAL_SETTINGS
return
messages........................................................................95
MOD_GLOBAL_SETTINGS..................................................................................................95MOD_GLOBAL_SETTINGS
parameters.............................................................................97MOD_GLOBAL_SETTINGS
runtime
errors.........................................................................99
BROWNOUT_RECOVERY...................................................................................................99BROWNOUT_RECOVERY
parameters.............................................................................99BROWNOUT_RECOVERY
runtime
errors........................................................................100
GET_SNMP_IM_SETTINGS...............................................................................................100GET_SNMP_IM_SETTINGS
parameters..........................................................................100GET_SNMP_IM_SETTINGS
runtime
errors......................................................................100GET_SNMP_IM_SETTINGS
return
messages...................................................................100
MOD_SNMP_IM_SETTINGS.............................................................................................101MOD_SNMP_IM_SETTINGS
parameters........................................................................102MOD_SNMP_IM_SETTINGS
runtime
errors....................................................................103
MOD_ENCRYPT_SETTINGS..............................................................................................104MOD_ENCRYPT_SETTINGS
parameters.........................................................................104MOD_ENCRYPT_SETTINGS
runtime
errors.....................................................................105
GET_ENCRYPT_SETTINGS................................................................................................105GET_ENCRYPT_SETTINGS
parameters...........................................................................105GET_ENCRYPT_SETTINGS
runtime
errors.......................................................................106GET_ENCRYPT_SETTINGS
return
messages....................................................................106
UPDATE_RIB_FIRMWARE and
UPDATE_FIRMWARE..............................................................106UPDATE_FIRMWARE
parameters...................................................................................107UPDATE_FIRMWARE
runtime
errors...............................................................................107
UPDATE_LANG_PACK......................................................................................................107UPDATE_LANG_PACK
parameters.................................................................................107UPDATE_LANG_PACK
runtime
errors.............................................................................108
GET_FW_VERSION.........................................................................................................108GET_FW_VERSION
parameters....................................................................................108GET_FW_VERSION
runtime
errors.................................................................................108GET_FW_VERSION
return
messages.............................................................................108
LICENSE.........................................................................................................................108LICENSE
parameters...................................................................................................109LICENSE
runtime
errors................................................................................................109
INSERT_VIRTUAL_MEDIA..................................................................................................109INSERT_VIRTUAL_MEDIA
parameters.............................................................................109INSERT_VIRTUAL_MEDIA
runtime
errors.........................................................................110
EJECT_VIRTUAL_MEDIA....................................................................................................110EJECT_VIRTUAL_MEDIA
parameters...............................................................................111EJECT_VIRTUAL_MEDIA
runtime
errors...........................................................................111
GET_VM_STATUS............................................................................................................111GET_VM_STATUS
parameters.......................................................................................111GET_VM_STATUS
runtime
errors....................................................................................111GET_VM_STATUS
return
messages................................................................................111
SET_VM_STATUS.............................................................................................................112SET_VM_STATUS
parameters........................................................................................112SET_VM_STATUS
runtime
errors.....................................................................................113
CERTIFICATE_SIGNING_REQUEST.....................................................................................114
6 Contents
-
CERTIFICATE_SIGNING_REQUEST parameters (for custom
CSR).......................................114CERTIFICATE_SIGNING_REQUEST
errors.......................................................................114
IMPORT_CERTIFICATE......................................................................................................115IMPORT_CERTIFICATE
parameters.................................................................................115IMPORT_CERTIFICATE
errors.........................................................................................115
AHS_CLEAR_DATA..........................................................................................................115AHS_CLEAR_DATA
parameters.....................................................................................116AHS_CLEAR_DATA
runtime
errors..................................................................................116
GET_AHS_STATUS...........................................................................................................116GET_AHS_STATUS
parameters......................................................................................116GET_AHS_STATUS
runtime
errors..................................................................................116
SET_AHS_STATUS............................................................................................................116SET_AHS_STATUS
parameters.......................................................................................117SET_AHS_STATUS
runtime
errors...................................................................................117
ERS_AHS_Submit.xml
(TRIGGER_BB_DATA).........................................................................117ERS_AHS_Submit.xml
(TRIGGER_BB_DATA)
parameters...................................................117ERS_AHS_Submit.xml
(TRIGGER_BB_DATA) runtime
errors................................................117
DISABLE_ERS..................................................................................................................117DISABLE_ERS
parameters.............................................................................................118DISABLE_ERS
runtime
errors..........................................................................................118
GET_ERS_SETTINGS........................................................................................................118GET_ERS_SETTINGS
parameters...................................................................................118GET_ERS_SETTINGS
runtime
errors................................................................................118
SET_ERS_IRS_CONNECT..................................................................................................118SET_ERS_IRS_CONNECT
parameters............................................................................118SET_ERS_IRS_CONNECT
runtime
errors.........................................................................118
TRIGGER_L2_COLLECTION..............................................................................................118TRIGGER_L2_COLLECTION
parameters.........................................................................119TRIGGER_L2_COLLECTION
runtime
errors......................................................................119
TRIGGER_TEST_EVENT.....................................................................................................119TRIGGER_TEST_EVENT
parameters................................................................................119TRIGGER_TEST_EVENT
runtime
errors............................................................................119
SET_ERS_DIRECT_CONNECT............................................................................................119SET_ERS_DIRECT_CONNECT
parameters......................................................................120SET_ERS_DIRECT_CONNECT
runtime
errors...................................................................120
DC_REGISTRATION_COMPLETE........................................................................................120DC_REGISTRATION_COMPLETE
parameters...................................................................121DC_REGISTRATION_COMPLETE
runtime
errors...............................................................121
SET_ERS_WEB_PROXY.....................................................................................................121SET_ERS_WEB_PROXY
parameters................................................................................121SET_ERS_WEB_PROXY
runtime
errors............................................................................121
SET_LANGUAGE.............................................................................................................121SET_LANGUAGE
parameters........................................................................................122SET_LANGUAGE
runtime
errors....................................................................................122
GET_LANGUAGE............................................................................................................122GET_LANGUAGE
parameters.......................................................................................122GET_LANGUAGE
runtime
errors...................................................................................122
GET_ALL_LANGUAGES....................................................................................................122GET_ALL_LANGUAGES
parameters...............................................................................122GET_ALL_LANGUAGES
runtime
errors...........................................................................122
GET_ASSET_TAG.............................................................................................................123GET_ASSET_TAG
parameters........................................................................................123GET_ASSET_TAG
runtime
errors....................................................................................123
SET_ASSET_TAG..............................................................................................................123SET_ASSET_TAG
parameters.........................................................................................123
Contents 7
-
SET_ASSET_TAG runtime
errors.....................................................................................123GET_SECURITY_MSG.......................................................................................................124
GET_SECURITY_MSG
parameters..................................................................................124GET_SECURITY_MSG
return
messages...........................................................................124GET_SECURITY_MSG
runtime
errors..............................................................................124
SET_SECURITY_MSG........................................................................................................124SET_SECURITY_MSG
parameters..................................................................................125SET_SECURITY_MSG
runtime
errors...............................................................................125
GET_SPATIAL...................................................................................................................125GET_SPATIAL
parameters.............................................................................................125GET_SPATIAL
return
messages.......................................................................................125GET_SPATIAL
runtime
errors..........................................................................................126
HOTKEY_CONFIG...........................................................................................................126HOTKEY_CONFIG
parameters.....................................................................................127HOTKEY_CONFIG
runtime
errors..................................................................................128
GET_HOTKEY_CONFIG...................................................................................................128GET_HOTKEY_CONFIG
parameters..............................................................................128GET_HOTKEY_CONFIG
runtime
errors..........................................................................128GET_HOTKEY_CONFIG
return
messages.......................................................................128
PROFILE_APPLY................................................................................................................128PROFILE_APPLY
parameters...........................................................................................129PROFILE_APPLY
runtime
errors.......................................................................................129
PROFILE_APPLY_GET_RESULTS...........................................................................................130PROFILE_APPLY_GET_RESULTS
parameters......................................................................130PROFILE_APPLY_GET_RESULTS
runtime
errors..................................................................130
PROFILE_DELETE..............................................................................................................131PROFILE_DELETE
parameters.........................................................................................131PROFILE_DELETE
runtime
errors.....................................................................................131
PROFILE_LIST...................................................................................................................131PROFILE_LIST
parameters..............................................................................................132PROFILE_LIST
runtime
errors..........................................................................................132
PROFILE_DESC_DOWNLOAD...........................................................................................132PROFILE_DESC_DOWNLOAD
parameters......................................................................133PROFILE_DESC_DOWNLOAD
runtime
errors...................................................................133
FIPS_ENABLE..................................................................................................................134FIPS_ENABLE
parameters.............................................................................................134FIPS_ENABLE
runtime
errors..........................................................................................134
GET_FIPS_STATUS............................................................................................................134GET_FIPS_STATUS
parameters......................................................................................134GET_FIPS_STATUS
runtime
errors...................................................................................134GET_FIPS_STATUS
return
messages................................................................................135
GET_ALL_LICENSES.........................................................................................................135GET_ALL_LICENSES
parameters....................................................................................135GET_ALL_LICENSES
runtime
errors.................................................................................135GET_ALL_LICENSES
return
messages.............................................................................135
FACTORY_DEFAULTS........................................................................................................135FACTORY_DEFAULTS
parameters...................................................................................136FACTORY_DEFAULTS
runtime
errors...............................................................................136
IMPORT_SSH_KEY...........................................................................................................136IMPORT_SSH_KEY
parameters......................................................................................136IMPORT_SSH_KEY
runtime
errors..................................................................................137
DIR_INFO............................................................................................................................137GET_DIR_CONFIG..........................................................................................................137
GET_DIR_CONFIG
parameters.....................................................................................137GET_DIR_CONFIG
runtime
errors..................................................................................137
8 Contents
-
GET_DIR_CONFIG return
messages..............................................................................137MOD_DIR_CONFIG........................................................................................................139
MOD_DIR_CONFIG
parameters...................................................................................142MOD_DIR_CONFIG
runtime
errors................................................................................144MOD_KERBEROS........................................................................................................144
RACK_INFO........................................................................................................................144GET_RACK_SETTINGS.....................................................................................................145
GET_RACK_SETTINGS
parameters................................................................................145GET_RACK_SETTINGS
runtime
errors.............................................................................145GET_RACK_SETTINGS
return
messages.........................................................................145
BLADESYSTEM_INFO............................................................................................................145GET_OA_INFO...............................................................................................................146
GET_OA_INFO
parameters..........................................................................................146GET_OA_INFO
runtime
errors......................................................................................146GET_OA_INFO
return
messages...................................................................................146
SERVER_INFO......................................................................................................................146GET_TPM_STATUS...........................................................................................................147
GET_TPM_STATUS
parameters......................................................................................147GET_TPM_STATUS
runtime
errors...................................................................................147GET_TPM_STATUS
return
messages................................................................................147
GET_CURRENT_BOOT_MODE..........................................................................................147GET_CURRENT_BOOT_MODE
parameters.....................................................................148GET_CURRENT_BOOT_MODE
runtime
errors.................................................................148GET_CURRENT_BOOT_MODE
return
messages..............................................................148
GET_PENDING_BOOT_MODE..........................................................................................148GET_PENDING_BOOT_MODE
parameters....................................................................148GET_PENDING_BOOT_MODE
runtime
errors.................................................................148GET_PENDING_BOOT_MODE
return
messages..............................................................148
SET_PENDING_BOOT_MODE..........................................................................................149SET_PENDING_BOOT_MODE
parameters.....................................................................149SET_PENDING_BOOT_MODE
runtime
errors..................................................................149
GET_PERSISTENT_BOOT...................................................................................................149GET_PERSISTENT_BOOT
return
messages.......................................................................149
SET_PERSISTENT_BOOT
(Legacy).......................................................................................150SET_PERSISTENT_BOOT
parameters..............................................................................150SET_PERSISTENT_BOOT
runtime
errors...........................................................................151
SET_PERSISTENT_BOOT
(UEFI)..........................................................................................151SET_PERSISTENT_BOOT
parameters..............................................................................151SET_PERSISTENT_BOOT
runtime
errors...........................................................................152
GET_ONE_TIME_BOOT...................................................................................................152GET_ONE_TIME_BOOT
return
messages.......................................................................152
SET_ONE_TIME_BOOT....................................................................................................153SET_ONE_TIME_BOOT
parameters...............................................................................153SET_ONE_TIME_BOOT
runtime
errors............................................................................154
GET_SUPPORTED_BOOT_MODE.......................................................................................154GET_SUPPORTED_BOOT_MODE
return
messages...........................................................155GET_SUPPORTED_BOOT_MODE
runtime
errors..............................................................155
GET_SERVER_NAME........................................................................................................155GET_SERVER_NAME
return
message.............................................................................155GET_SERVER_NAME
runtime
errors...............................................................................155
SERVER_NAME...............................................................................................................156SERVER_NAME
parameters..........................................................................................156SERVER_NAME
return
message....................................................................................156SERVER_NAME
runtime
errors......................................................................................156
GET_SERVER_FQDN/GET_SMH_FQDN.............................................................................156
Contents 9
-
GET_SERVER_FQDN/GET_SMH_FQDN
parameters.......................................................156GET_SERVER_FQDN/GET_SMH_FQDN
return
messages.................................................156
SERVER_FQDN/SMH_FQDN............................................................................................157SERVER_FQDN/SMH_FQDN
parameters......................................................................157SERVER_FQDN/SMH_FQDN
return
messages................................................................157SERVER_FQDN/SMH_FQDN
runtime
errors...................................................................157
GET_PRODUCT_NAME....................................................................................................157GET_PRODUCT_NAME
parameters...............................................................................158GET_PRODUCT_NAME
runtime
errors...........................................................................158GET_PRODUCT_NAME
return
messages........................................................................158
GET_EMBEDDED_HEALTH................................................................................................158GET_EMBEDDED_HEALTH
parameters...........................................................................159GET_EMBEDDED_HEALTH
return
messages....................................................................159
GET_POWER_READINGS.................................................................................................159GET_POWER_READINGS
parameters............................................................................160GET_POWER_READINGS
return
messages.....................................................................160
GET_PWREG..................................................................................................................160GET_PWREG
parameters.............................................................................................161GET_PWREG
return
messages......................................................................................161GET_PWREG
runtime
errors..........................................................................................161
SET_PWREG...................................................................................................................161SET_PWREG
parameters..............................................................................................161SET_PWREG
runtime
errors..........................................................................................162
GET_POWER_CAP..........................................................................................................162GET_POWER_CAP
parameters.....................................................................................162GET_POWER_CAP
return
messages..............................................................................162
SET_POWER_CAP...........................................................................................................162SET_POWER_CAP
parameters......................................................................................163SET_POWER_CAP
runtime
errors...................................................................................163
GET_HOST_POWER_SAVER_STATUS.................................................................................163GET_HOST_POWER_SAVER_STATUS
parameters............................................................163GET_HOST_POWER_SAVER_STATUS
runtime
errors.........................................................163GET_HOST_POWER_SAVER_STATUS
return
messages.....................................................164
SET_HOST_POWER_SAVER..............................................................................................164SET_HOST_POWER_SAVER
parameters.........................................................................164SET_HOST_POWER_SAVER
runtime
errors......................................................................164
GET_HOST_POWER_STATUS............................................................................................164GET_HOST_POWER_STATUS
parameters.......................................................................165GET_HOST_POWER_STATUS
runtime
errors...................................................................165GET_HOST_POWER_STATUS
Return
Messages...............................................................165
SET_HOST_POWER.........................................................................................................165SET_HOST_POWER
Parameters....................................................................................165SET_HOST_POWER
Runtime
Errors................................................................................165
GET_HOST_PWR_MICRO_VER..........................................................................................166GET_HOST_PWR_MICRO_VER
parameters....................................................................166GET_HOST_PWR_MICRO_VER
runtime
errors.................................................................166GET_HOST_PWR_MICRO_VER
return
messages..............................................................166
RESET_SERVER................................................................................................................166RESET_SERVER
error
messages......................................................................................167RESET_SERVER
parameters...........................................................................................167
PRESS_PWR_BTN.............................................................................................................167PRESS_PWR_BTN
parameters.......................................................................................167PRESS_PWR_BTN
runtime
errors....................................................................................167
HOLD_PWR_BTN............................................................................................................167HOLD_PWR_BTN
parameters.......................................................................................168
10 Contents
-
HOLD_PWR_BTN runtime
errors....................................................................................168COLD_BOOT_SERVER......................................................................................................168
COLD_BOOT_SERVER
parameters.................................................................................168COLD_BOOT_SERVER
runtime
errors.............................................................................168
WARM_BOOT_SERVER....................................................................................................168WARM_BOOT_SERVER
parameters...............................................................................169WARM_BOOT_SERVER
runtime
errors...........................................................................169
SERVER_AUTO_PWR........................................................................................................169SERVER_AUTO_PWR
parameters..................................................................................169SERVER_AUTO_PWR
runtime
errors...............................................................................170
GET_SERVER_AUTO_PWR................................................................................................170GET_SERVER_AUTO_PWR
parameters...........................................................................170GET_SERVER_AUTO_PWR
return
message.....................................................................170
GET_UID_STATUS............................................................................................................170GET_UID_STATUS
parameters.......................................................................................171GET_UID_STATUS
response..........................................................................................171
UID_CONTROL...............................................................................................................171UID_CONTROL
parameters..........................................................................................171UID_CONTROL
errors..................................................................................................171
SET_PERS_MOUSE_KEYBOARD_ENABLED.........................................................................171SET_PERS_MOUSE_KEYBOARD_ENABLED
parameters....................................................172SET_PERS_MOUSE_KEYBOARD_ENABLED
runtime
errors.................................................172
GET_PERS_MOUSE_KEYBOARD_ENABLED.........................................................................172GET_PERS_MOUSE_KEYBOARD_ENABLED
parameters...................................................172GET_PERS_MOUSE_KEYBOARD_ENABLED
return messages.............................................172
GET_SERVER_POWER_ON_TIME......................................................................................172GET_SERVER_POWER_ON_TIME
parameters.................................................................173GET_SERVER_POWER_ON_TIME
return
message............................................................173
CLEAR_SERVER_POWER_ON_TIME...................................................................................173CLEAR_SERVER_POWER_ON_TIME
parameters..............................................................173CLEAR_SERVER_POWER_ON_TIME
return
message........................................................173
SSO_INFO..........................................................................................................................173GET_SSO_SETTINGS.......................................................................................................174
GET_SSO_SETTINGS
parameters..................................................................................174GET_SSO_SETTINGS
return
messages...........................................................................174
MOD_SSO_SETTINGS.....................................................................................................175MOD_SSO_SETTINGS
parameters................................................................................175MOD_SSO_SETTINGS
runtime
errors.............................................................................176
SSO_SERVER..................................................................................................................176SSO_SERVER
parameters.............................................................................................177SSO_SERVER
runtime
errors..........................................................................................178
DELETE_SERVER...............................................................................................................178DELETE_SERVER
parameters.........................................................................................178DELETE_SERVER
runtime
errors......................................................................................178
9 Secure
Shell...........................................................................................179SSH
overview.......................................................................................................................179Supported
SSH
features.........................................................................................................179Using
Secure
Shell................................................................................................................179SSH
key
authorization...........................................................................................................180
Tool definition
files...........................................................................................................180Mxagentconfig
utility........................................................................................................180
Importing SSH keys from
PuTTY...............................................................................................181Importing
SSH keys generated using
ssh-keygen........................................................................183
Contents 11
-
10 PERL
scripting.......................................................................................184Using
PERL with the XML scripting
interface..............................................................................184XML
enhancements...............................................................................................................184Opening
an SSL
connection...................................................................................................184Sending
the XML header and script
body................................................................................185
11 iLO 4
ports...........................................................................................187Enabling
the Shared Network Port feature through XML
scripting.................................................187Re-enabling
the dedicated NIC management
port.....................................................................187
12 Support and other
resources...................................................................189Information
to collect before contacting
HP...............................................................................189How
to contact
HP................................................................................................................189Security
bulletin and alert policy for non-HP owned software
components....................................189
Subscription
service..........................................................................................................189Registering
for software technical support and update
service.....................................................189
How to use your software technical support and update
service.............................................190HP
authorized
resellers..........................................................................................................190Related
information...............................................................................................................190
13 Documentation
feedback.......................................................................192A
Sample script and command
reference......................................................193B
Sample return for
GET_EMBEDDED_HEALTH..............................................197Glossary..................................................................................................205Index.......................................................................................................207
12 Contents
-
1 IntroductionScripting and command line guide overview
HP iLO 4 provides multiple ways to configure, update, and
operate HP ProLiant servers remotely.The HP iLO User Guide
describes each feature and explains how to use these features with
thebrowser-based interface and RBSU. For more information, see the
HP iLO User Guide on the HPwebsite at
http://www.hp.com/go/ilo/docs.The HP iLO Scripting and Command Line
Guide describes the syntax and tools available to useiLO 4 through
a command line or scripted interface.Sample XML scripts downloaded
from the HP website contain commands for all iLO firmware.Unless
otherwise specified, the examples in this guide are for iLO 4
firmware version 2.00 andlater. Before using the sample scripts,
review the firmware support information in each script totailor the
script for the intended firmware and version. Download the sample
scripts from the HPwebsite at http://www.hp.com/go/ilo. Click iLO
Sample Scripts for Windowsor Lights-Out XMLscripting sample for
Linux on the Resources tab, under Support.Throughout this manual,
iLO 4 is referred to as iLO.In addition to the GUI, the iLO
firmware provides multiple ways to configure and control iLO andthe
server using scripts and command line instructions.The scripting
tools provide a method to configure multiple iLO systems, to
incorporate a standardconfiguration into the deployment process,
and to control servers and subsystems. Using the scriptingtools
enables you to:
Change the Administrator password on all your iLO systems
Configure LDAP directory service settings
Control the server power state
Attach a virtual media CD/DVD to the host server
Update the iLO firmware
Retrieve power consumption data
Issue various configuration and control commandsThe command line
tools provide quick and easy methods to send commands to the iLO
firmwareand host servers.
Scripting and command line utilitiesThis section describes the
following scripting and command line tools: HPQLOCFG.EXE
LOCFG.PL
HPONCFG.EXE
SMASH CLP
IPMIThe current version of iLO introduces RIBCL headers that
offer expanded script functionality. Upgradeany of the utilities
you use to the versions listed below to take advantage of the
expandedfunctionality.The current version of iLO 4 requires
upgrades to the following utilities:
Scripting and command line guide overview 13
http://www.hp.com/go/ilo/docshttp://www.hp.com/go/ilo
-
Table 1 HP iLO 4 2.00 scripting and command line utilities
required versions
Version notes for iLO 4 2.00VersionUtility
HP Lights-Out Configuration Utility. This replaces the
CPQLOCFGutility.
1.20HPQLOCFG
4.40HP Light-Out XMLScripting Sample
4.4.0.0HPONCFG
This utility is available in the HP Lights-Out XML Scripting
Sample.4.40LOCFG.PL
Upgrade HPLOMIG before installing this version iLO
4.4.40HPLOMIG
NOTE: Upgrades are required only for the utilities you use.
Continuing to use utilities withoutupgrading will cause the
following message to appear:Scripting utility should be updated to
the latest version.
HPQLOCFG UtilityThe HP Lights-Out Configuration Utility
(HPQLOCFG.EXE) utility replaces the previously usedCPQLOCFG.EXE
utility. HPQLOCFG is a Windows command line utility that sends XML
configurationand control scripts over the network to iLO. Run this
utility manually from a Windows commandprompt, or create a batch
file to run the same script to many iLO devices.The tool accepts
properly formatted XML scripts containing commands and values; see
the XMLscripts in the iLO Sample Scripts for Windows or the HP
Lights-Out XML Scripting Sample for Linuxfor examples of proper
formatting. All available commands are detailed later in this
guide.HPQLOCFG also integrates with HP SIM for easy launching of
the same script on multiple devices.
LOCFG.PL ScriptThe LOCFG.PL scripting utility is a PERL script
that provides similar functionality as the HPQLOCFGutility. Run
this tool on any client that has a compatible PERL environment
(including OpenSSL)installed. This tool uses the same XML scripts
as HPQLOCFG input files.
HPONCFG UtilityUse the HPONCFG.EXE utility to send XML
configuration and control scripts (the same scripts asHPQLOCFG)
from the server host operating system to iLO. HPONCFG has both
Windows andLinux versions. One common usage is to run an HPONCFG
script to configure iLO to a standardconfiguration at the end of
your server deployment process. HPONCFG integrates with HP RDPand
also runs at the end of an unattended OS installation.When you run
HPONCFG from the host operating system, you must be logged in to
the host serverusing an Administrator or root level user account.
An iLO user ID and password is not required.Windows server
operating systems also have the HPONCFG_GUI.EXE utility. This
utility providesthe same basic configuration capabilities as the
iLO F8 ROM-RBSU during the server boot-upprocess.
SMASH CLPSMASH CLP is the DMTF suite of specifications that
deliver industry-standard protocols and profilesto unify the
management of the data center. The SMASH CLP specification enables
simple andintuitive management of heterogeneous servers in a data
center.SMASH CLP provides a standardized set of commands for
configuration and control of managementprocessors (called
Management Access Points) and host systems. On iLO, access SMASH
CLPthrough the SSH port.
14 Introduction
-
IPMIThe IPMI specification is a standard that defines a set of
common interfaces to a computer system.System administrators can
use IPMI to monitor system health and manage the system. IPMI
2.0defines a mandatory system interface, and an optional LAN
interface. The iLO processor supportsboth interfaces.The IPMI
specification defines a standardized interface for platform
management. The IPMIspecification defines the following types of
platform management:
Monitors the status of system information, such as fans,
temperatures, and power supplies
Recovery capabilities, such as system resets and power on/off
operations
Logging capabilities for abnormal events, such as
over-temperature readings or fan failures
Inventory capabilities, such as identifying failed hardware
componentsIPMI commands are sent to iLO using a third-party or open
source utility, such as IPMITOOL,IPMIUTIL, OpenIPMI or FreeIPMI.You
must be familiar with IPMI specifications when issuing raw
commands. For additionalinformation, see the IPMI specification on
the Intel website at
http://www.intel.com/design/servers/ipmi/tools.htm.
New in this versionThis guide reflects changes in the iLO 4
firmware. This guide covers iLO 4 firmware version 2.00and
later.The following updates or additions were made: Added the NIC
auto-selection feature (see Base Command oemhp_nicautosel (page
37))
Modified MOD_NETWORK_SETTINGS to include the NIC auto-selection
feature,DHCPV6_DOMAIN_NAME, SNP_PORT, and reduced the potential
number of reboots neededwhen changing network settings.
HP Insight Control server deploymentHP Insight Control server
deployment integrates with iLO to enable the management of
remoteservers and to monitor the performance of remote console
operations, regardless of the state ofthe operating system or
hardware.The deployment server provides the capability to use the
power management features of iLO topower on, power off, or cycle
power on the target server. Each time a server connects to
thedeployment server, the deployment server polls the target server
to verify the presence of a LOMmanagement device. If installed, the
server gathers information, including the DNS name, IPaddress, and
user login name. Security is maintained by requiring the user to
enter the correctpassword for that user name.For more information
about the HP Insight Control server deployment, see the
documentation thatships on the HP Insight software DVD, or the HP
website at http://www.hp.com/go/insightcontrol.
New in this version 15
http://www.intel.com/design/servers/ipmi/tools.htmhttp://www.intel.com/design/servers/ipmi/tools.htmhttp://www.hp.com/go/insightcontrol
-
2 HPQLOCFG usageThe HPQLOCFG.EXE utility is a Windows-based
utility that connects to iLO using a secure connectionover the
network. RIBCL scripts are passed to iLO over the secure connection
to HPQLOCFG. Thisutility requires a valid user ID and password with
the appropriate privileges. Launch the HPQLOCFGutility from HP SIM
for Group Administration, or launch it independently from a command
promptfor batch processing.Download this utility from the HP
website at: http://www.hp.com/support/ilo4.Version 1.0 or later of
HPQLOCFG is required to support all features of iLO 4 v2.00.HP SIM
discovers iLO devices as management processors. HPQLOCFG sends a
RIBCL file to agroup of iLO devices to manage the user accounts for
those iLO devices. The iLO devices thenperform the action
designated by the RIBCL file and send a response to the log
file.Use HPQLOCFG to execute RIBCL scripts on iLO. HPQLOCFG must
reside on the same server asHP SIM. HPQLOCFG generates two types of
error messages; runtime errors, and syntax errors. Runtime errors
occur when an invalid action is requested. Runtime errors are
logged to the
following directory:C:\Program Files\HP\Systems Insight
Manager\
Syntax errors occur when an invalid XML tag is encountered. When
a syntax error occurs,HPQLOCFG stops running and logs the error in
the runtime script and output log file. Syntaxerrors use the
following format:Syntax error: expected X but found Y.For
example:
Syntax error: expected USER_LOGIN=userlogin but found
USER_NAME=username
Configuring for unauthenticated XML queriesIf configured to do
so, the iLO device returns identifying information in response to
anunauthenticated XML query. By default, the iLO device is
configured to return this information.To disable this feature, set
the CIM_SECURITY_MASK in the MOD_SNMP_IM_SETTINGS commandto disable
unauthenticated XML query return information.You can also disable
the unauthenticated XML query information through the iLO web
interface:1. Go to AdministrationManagement.
The Management page appears.2. Under the Insight Management
Integration heading, click the menu for the Level of Data
Returned option.There are two options in the menu: 1) Enabled
(iLO+Server Association Data)
2) Disabled (No Response to Request)
3. Select 2) Disabled (No Response to Request) to disable
unauthenticated XML query returninformation
NOTE: You must have unauthenticated XML query enabled if you are
performing device discoverieswith HP SIM.
To obtain unauthenticated identifying information, enter the
following command to the iLO webserver port:
16 HPQLOCFG usage
http://www.hp.com/support/ilo4
-
https:///xmldata?item=all
Alternatively, you can select option 1) Enabled (iLO+Server
Association Data) from iLO.A typical response is:
ABC12345678ProLiant BL460c
Gen8BL4608CN71320ZNN036344C42-4E43-3830-3731-33305A4E4E32InactiveBL4608-101100:17:a4:77:08:02200:17:a4:77:08:04300:17:a4:77:08:0049c:8e:99:13:20:cd59c:8e:99:13:20:ca69c:8e:99:13:20:ce79c:8e:99:13:20:cb89c:8e:99:13:20:cf1Integrated
Lights-Out 4 (iLO 4)1.0108/30/2011ASIC:
16ILOABC12345678ILOBL4608ABC123456781
Configuring for unauthenticated XML queries 17
-
03.0011Onboard
Administrator123.456.78.90TestRACKTestRACKEnc-C2
Creating a system collection in HP SIMTo quickly see all system
management processors, login to SIM and in the System and
EventCollections panel, scroll down to and select All Management
Processors. The All ManagementProcessors page appears.To create a
custom group of all iLO devices (or by iLO version), create a
system collection.1. In the System and Event Collections panel,
click Customize. The Customize Collections page
appears.2. In the Show collections of dropdown list, select
Systems. All available system or cluster
collections appear.3. Click New. The New Collection section
appears.4. Select Choose members by attributes.5. In the Search for
dropdown list, select systems .6. In the where dropdown, select
system sub type, and select is from the inclusion/exclusion
dropdown.7. Select an Integrated Lights-Out choice from the
system sub type dropdown at the right.8. Click one of the
following:
View to run the search and display results immediately.
Save as Collection to save the collection.
Cancel to close the New Collection section without saving any
changes.
Launch applications with HP SIM custom toolsUse custom tools in
HP SIM to combine RIBCL, HPQLOCFG, and system collection to
manageGroup Administration of iLO devices. Custom tools are
executed on the CMS and on target systems.You can create a remote
tool that runs on selected target systems, and even schedule its
execution.For more information about custom tools, see the HP SIM
help.
Batch processing using HPQLOCFGGroup Administration is also
delivered to iLO through batch processing. The components neededfor
batch processing are HPQLOCFG, a RIBCL file, and a batch file.The
following example shows a sample batch file used to perform the
Group Administration foriLO:
REM Updating the HP Integrated Lights-Out 3 boardREM Repeat line
for each board to be updatedREM
18 HPQLOCFG usage
-
HPQLOCFG -S RIB1 -F C:\...SCRIPT.XML -L RIB1LOG.TXT -VHPQLOCFG
-S RIB2 -F C:\...SCRIPT.XML -L RIB2LOG.TXT -VHPQLOCFG -S RIB3 -F
C:\...SCRIPT.XML -L RIB3LOG.TXT -V...RIBNLOG -S RIBN -F
C:\...SCRIPT.XML -L LOGFILE.TXT -V
HPQLOCFG overwrites any existing log files.
HPQLOCFG command line parametersFor information on the syntax of
the XML data files, see RIBCL XML Scripting Language (page
61).Download sample XML scripts from the HP website at
http://www.hp.com/go/ilo.. Click iLO Sample Scripts for Windowsor
Lights-Out XML scripting sample for Linux on the Resourcestab,
under Support.
Using quote charactersThe restrictions for using single and
double-quote characters are based on whether they are passedto
HPQLOCFG inside an XML script or on the command line.
Quotes inside XML scriptsWhen using an XML script to enter the
user name and password use the double-quote (") asdelimiters.
However, if you must use " inside the user name or password in the
XML file (if the username or password has double quotes in it),
change the outside double-quote delimeters to singlequotes (').For
example, consider a username with quotes in
it:Sample"simple"name
This must be in an XML script as:'Sample"simple"name'
NOTE: Support for Windows-specific smart-quotes ( and ) as
content delimiters in XML isbeing phased out. Be sure to replace
any smart-quote characters in your script with normal doubleor
single quotes (" and ').
Quotes on the command lineWhen using HPQLOCFG or LOCFG and
entering the password or command on the commandline with the -p
option, you cannot normally use the double-quote special character
("), exceptwhen using an ampersand (&) or less-than (
-
Command line switchesThe following command line switches are
available to be used with HPQLOCFG.EXE:
Table 2 HPQLOCFG command line switches
EffectSwitch
Determines the iLO that is to be updated. This switch is
followed by either the DNS nameor IP address of the target server.
When using IPv6 addresses, you can optionally addthe port number
preceded by a colon ().
NOTE: Do not use this switch if you are launching from HP SIM.
HP SIM automaticallyprovides the address of the iLO when you launch
HPQLOCFG.
-S
Full path location and name of the RIBCL file that contains the
actions to be performed.-F
User login name. Entering this at the command line overrides the
user login name fromthe script.
-U
Password. Entering this at the command line overrides the
password from the script.-P
Defines the log file name and file location. If this switch is
omitted, a default log file withthe DNS name or the IP address is
created in the same directory used to launch
-L1
HPQLOCFG. Ensure that HPQLOCFG is in a directory referenced by
the PATH environmentvariable. Any log files generated are placed in
the same directory as the HPQLOCFGexecutable.This switch cannot
designate an output log filename. The default filename is based on
theDNS name or the IP address.
NOTE: Do not use this switch if launching from HP SIM.The output
values may need to be modified to match the RIBCL syntax.
Enables verbose message return. The resulting log file contains
all commands sent, allresponses received, and any errors. By
default, only errors and responses from GETcommands are logged
without this switch.
-V1
The -t namevaluepairs switch substitutes variables (%variable%)
in the input filewith values specified in name-value pairs.
Separate multiple name-value pairs with acomma. See Using variables
and name value pairs with HPQLOCFG (page 20).
-t namevaluepairs
1 The -L and -V switches might or might not be set depending on
the IT administrator preferences.
Using variables and name value pairs with HPQLOCFGIn Example 1
Script prepared for variables (Get_Asset_Tag.xml) you can see a
sample scriptprepared for use with the -t namevaluepairs
switch.
Example 1 Script prepared for variables (Get_Asset_Tag.xml)
To execute this script correctly, use the -t namevaluepairs
switch on the command line:hpqlocfg -f get_asset_tag.xml -s -t
user=Admin,password=pass
If the parameter contains multiple words, you must enclose the
phrase within double quotes (" ").Up to 25 variables are supported
in an XML file. The maximum length of a variable name is
48characters.
20 HPQLOCFG usage
-
Example 2 Web agent example (Mod_SNMP_IM_Settings.xml):
To execute this script correctly, use the -t namevaluepairs
switch on the command line:hpqlocfg s f u p t
For IPv6, without specifying the port number, invoke the script
using:hpqlocfg s [] f u p t
orhpqlocfg s f u p t
For IPv6, when specifying the port number, invoke the script
using the following:hpqlocfg s []: f u p t
When replacing a token that requires double quotes, use single
quotes around the token.
HPQLOCFG command line parameters 21
-
3 LOCFG.PL usageLOCFG.PL Utility
To use the LOCFG.PL utility, you must have the following PERL
modules: Net::SSLeay
IO::Socket::SSLYou must also have a valid iLO user account and
password for each XML script to use LOCFG.PL.To process the
request, your account must have the appropriate iLO privileges.The
LOCFG.PL script connects to iLO using an SSL connection.For
example:perl locfg.pl -s {servername|ipaddress}[:port] [-l
logfilename]-finput_filename [-u username -p password] [iLO 4]
LOCFG.PL command line switchesThe following command line
switches are available to be used with LOCFG.PL:
Table 3 LOCFG.PL command line switches
EffectSwitch
DNS name of target server.-s servernameDo not use this switch if
launching from HP SIM.
IP address of the target server.-s ipaddressDo not use this
switch if launching from HP SIM.
If a port is not specified, the port defaults to :443.:port
Name of the file to log all output to.-l logfilenameA default
file with the server name and IP address is created if this option
is not specified.Do not use this switch if launching from HP
SIM.
Filename containing the RIB commands.-f input_filename
Command line user name. Entering this at the command line
overrides the user login namefrom the script.
-u username1
Command line password. Entering this at the command line
overrides the password fromthe script.
-p password 1
The -t namevaluepairs switch substitutes variables (%variable%)
in the input filewith values specified in name-value pairs.
Separate multiple name-value pairs with acomma.
-t namevaluepairs
Enables interactive input of username and password.-i
Enables verbose message mode. The resulting log file contains
all commands sent, allresponses received, and any errors. By
default, only errors and responses from GETcommands are logged
without this switch.
-v
Specifies the type of targeted management processor.iLO 4This
flag is optional. Without this flag, LOCFG.PL detects the iLO type
automatically. TheiLO 4 firmware performs better when this flag is
present.
1 Use -u and -p with caution, because command line options are
visible on Linux systems.
For more information, see RIBCL XML Scripting Language (page
61).
22 LOCFG.PL usage
-
4 HPONCFG online configuration utilityHPONCFG
The HPONCFG utility is an online configuration tool used to set
up and configure iLO from withinWindows and Linux operating systems
without requiring a reboot of the server operating system.HPONCFG
runs in a command line mode and must be executed from an operating
system commandline using an account with administrator or root
access. HPONCFG provides a limited graphicalinterface for servers
that use Windows operating systems.
HPONCFG supported operating systems HPONCFG Windows (32 and 64
bit)
Windows Server 2008 Windows Server 2008 R2 Windows Server 2012
Windows Server 2012 Essentials
HPCONFG Linux (32 and 64 bit)
Red Hat Enterprise Linux 5 Server Red Hat Enterprise Linux 6
Server SUSE Linux Enterprise Server 10 SUSE Linux Enterprise Server
11
VMware
VMware 5
HPONCFG requirements Windows-based serversThe following channel
interface and core driver installations must
be loaded on the server:
HP ProLiant iLO 3/4 Channel Interface Driver for Windows HP
ProLiant iLO 3/4 Management Controller Driver Package for
Windows
The management controller driver package provides server
monitoring components and eventlogging. During execution, HPONCFG
issues a warning if it cannot locate the channel interfacedriver.
Each Service Pack for ProLiant (SPP) includes the channel interface
driver. The downloadsare available from the HP website at:
http://www.hp.com/support/ilo4.
Linux-based serversThe HP ProLiant iLO Channel Interface
(KMOD/KMP) mustbe loaded on the server, which includes a health
driver package. Each SPP includes thenecessary interface and health
drivers, and the package is also available from the HP websiteat:
http://www.hp.com/support/ilo4.
Installing HPONCFGThe HPONCFG utility is delivered in separate
packages for Windows and Linux operating systems.For Windows
operating systems, it is included as a smart component. For Linux
operating systems,
HPONCFG 23
http://www.hp.com/support/ilo4http://www.hp.com/support/ilo4
-
it is included as an RPM package file. HPONCFG packages are
included in the Service Pack forProLiant (SPP).
Windows server installationHPONCFG installs automatically when
the Service Pack for ProLiant is installed. To install
HPONCFGmanually, run the self-extracting executable.HPONCFG creates
a directory at:%Program files%\HP\hponcfg.
Linux server installationHPONCFG is installed automatically when
Service Pack for ProLiant is installed. Download theHPONCFG RPM
package for Linux distributions from the HP website. Install the
appropriatepackage using the RPM installation utility.For example,
for a package installation, install the HPONCFG RPM package on Red
Hat EnterpriseLinux 5 by entering the following command:rpm -ivh
hponcfg-4.0.1-2.linux.rpm
If you have an older version of the HPONCFG RPM package
installed on the system, run thefollowing command to remove the
older version before installing the new version of HPONCFG:rpm e
hponcfg
The hp-ilo rpm package and the hp-health rpm package must be
installed on the systembefore installing the hponcfg rpm
package.After installation, the HPONCFG executable is located in
the /sbin directory. Be sure that theappropriate Management
Interface Driver is installed. For details about where to obtain
this driverand file, see HPONCFG requirements (page 23).
VMware installationHPONCFG is available for VMware (ESXi 5
only). HPONCFG is included with the HP customVMware ESXi 5 image.
If you have the standard VMware ESXi image, HPONCFG can
bedownloaded from www.hp.com and installed as a VIB with the
following command:esxcli software vib install -v
For VMware, the hpilo driver is already included in the image
(either HP custom or standardVMware).
HPONCFG utilityThe HPONCFG configuration utility reads an XML
input file, formatted according to the rules ofthe RIBCL language,
and produces a log file containing the requested output. A few
sample scriptsare included in the HPONCFG delivery package.A
package containing various and comprehensive sample scripts is
available for download onthe HP website at:
http://www.hp.com/go/ilo.Click iLO Sample Scripts for Windowsor
Lights-Out XML scripting sample for Linux on the Resourcestab,
under Support.Typical usage is to select a script that is similar
to the desired functionality and modify it for yourexact
requirements. Although no authentication to iLO is required, the
XML syntax requires thatthe USER_LOGIN and PASSWORD tags are
present in the LOGIN tag, and that these fields containdata. To
successfully execute HPONCFG, the utility must be invoked as
Administrator on Windowsservers and as root on Linux servers.
HPONCFG returns an error message if you do not possesssufficient
privileges.
24 HPONCFG online configuration utility
www.hp.comhttp://www.hp.com/go/ilo
-
HPONCFG command line parametersHPONCFG accepts the following
command line parameters:
Table 4 HPONCFG command line parameters
EffectParameter
Displays the help page/help or ?
Resets the iLO to factory default values/reset
Sets and receives the iLO configuration from the information
given in the XML input file thathas name filename
/f filename
Sets and receives iLO configuration from XML input received
through the standard inputstream
/i filename
Writes the iLO configuration obtained from the device to the XML
output file namedfilename
/w filename
Capture the complete configuration of iLO to a file. Must be
used with /w command lineparameter.
/a or /all
Logs replies to the text log file that has name filename/l
filename
Display all the responses from iLO./v or /xmlverbose
Substitutes variables present in the input config file with
values specified in namevaluepairs/s namevaluepairsor
/substitutenamevaluepairs
Receives the host information. Returns the server name and
server serial number/get_hostinfo
Indicates the minimum firmware level that should be present in
the management device toexecute the RIBCL script. If at least this
level of firmware is not present, HPONCFG returnsan error without
performing any additional action
/m
Configures the server for optimized mouse handling to improve
graphical remote consoleperformance. By default, it optimizes for
remote console single cursor mode for the current
/mouse
user. The dualcursor command line option, along with the mouse
option, optimizes mousehandling as suited for remote console
dual-cursor mode. The allusers command lineoption optimizes mouse
handling for all users on the system. This option is available
onlyfor Windows
Configures Windows displ