HP iLO 3 Scripting and Command Line Guide Abstract This document describes the syntax and tools available for use with the HP iLO firmware through the command line or a scripted interface. This document is for the person who installs, administers, and troubleshoots servers and storage systems. HP assumes you are qualified in the servicing of computer equipment and trained in recognizing hazards in products with hazardous energy levels.
© Copyright 2010, 2013 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.
Contents 1 Introduction.............................................................................................11 Scripting and command line guide overview..............................................................................11 Scripting and command line utilities..........................................................................................11 HPQLOCFG Utility.............................................................................................................12 LOCFG.
Using the command line..........................................................................................................33 Escape commands..................................................................................................................34 Base commands.....................................................................................................................35 Specific commands...................................................................................................
GET_ALL_USERS parameters...........................................................................................70 GET_ALL_USERS runtime errors.......................................................................................70 GET_ALL_USERS return messages....................................................................................70 GET_ALL_USER_INFO........................................................................................................70 GET_ALL_USER_INFO parameters........
INSERT_VIRTUAL_MEDIA....................................................................................................92 INSERT_VIRTUAL_MEDIA parameters...............................................................................92 INSERT_VIRTUAL_MEDIA runtime errors...........................................................................93 EJECT_VIRTUAL_MEDIA......................................................................................................93 EJECT_VIRTUAL_MEDIA parameters.........
GET_ALL_LICENSES return messages.............................................................................105 FACTORY_DEFAULTS........................................................................................................105 FACTORY_DEFAULTS parameters...................................................................................106 FACTORY_DEFAULTS runtime errors...............................................................................106 IMPORT_SSH_KEY.................................
GET_PWREG runtime errors..........................................................................................132 SET_PWREG...................................................................................................................132 SET_PWREG parameters..............................................................................................132 SET_PWREG runtime errors..........................................................................................133 GET_POWER_CAP.................
SET_PERS_MOUSE_KEYBOARD_ENABLED.........................................................................142 SET_PERS_MOUSE_KEYBOARD_ENABLED parameters....................................................143 SET_PERS_MOUSE_KEYBOARD_ENABLED runtime errors.................................................143 GET_PERS_MOUSE_KEYBOARD_ENABLED.........................................................................143 GET_PERS_MOUSE_KEYBOARD_ENABLED parameters...................................................
13 Documentation feedback.......................................................................162 Glossary..................................................................................................163 Index.......................................................................................................
1 Introduction Scripting and command line guide overview HP iLO 3 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 the browser-based interface and RBSU. For more information, see the HP iLO User Guide on the HP website at http://www.hp.com/go/ilo3 and click More iLO Documentation.
Table 1 HP iLO 3 1.61 scripting and command line utilities required versions Utility Version Version notes for iLO 3 1.61 HPQLOCFG 1.0 HP Lights-Out Configuration Utility. This replaces the CPQLOCFG utility. HPONCFG 4.2.0 To use this version of the HP Lights-Out Online Configuration Utility you must also upgrade your Channel Interface Driver (CHIF) to version 3.9.0.0. LOCFG.PL 4.20 This utility is available in the HP Lights-Out XML Scripting Sample 4.2.0 bundle. HPLOMIG 4.2.
SMASH CLP provides a standardized set of commands for configuration and control of management processors (called Management Access Points) and host systems. On iLO, access SMASH CLP through the SSH port. IPMI The 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.0 defines a mandatory system interface, and an optional LAN interface.
For more information about the HP Insight Control server deployment, see the documentation that ships on the HP Insight software DVD, or the HP website at http://www.hp.com/go/insightcontrol.
2 HPQLOCFG usage The HPQLOCFG.EXE utility is a Windows-based utility that connects to iLO using a secure connection over the network. RIBCL scripts are passed to iLO over the secure connection to HPQLOCFG. This utility requires a valid user ID and password with the appropriate privileges. Launch the HPQLOCFG utility from HP SIM for Group Administration, or launch it independently from a command prompt for batch processing. Download this utility from the HP website at: http://www.hp.com/support/ilo3.
https:///xmldata?item=all Alternatively, you can select option 1) Enabled (iLO+Server Association Data) from iLO.
0 3.0 0 1 1 Onboard Administrator 123.456.78.90 TestRACK TestRACKEnc-C 2 Creating a system collection in HP SIM To quickly see all system management processors, login to SIM and in the System and Event Collections panel, scroll down to and select All Management Processors.
HPQLOCFG -S RIB1 -F C:\...SCRIPT.XML -L RIB1LOG.TXT -V HPQLOCFG -S RIB2 -F C:\...SCRIPT.XML -L RIB2LOG.TXT -V HPQLOCFG -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 parameters For information on the syntax of the XML data files, see “RIBCL XML Scripting Language” (page 60). Sample XML scripts are available on the HP website at www.hp.com/go/iLO3. .
Command line switches The following command line switches are available to be used with HPQLOCFG.EXE: Table 2 HPQLOCFG command line switches Switch Effect -S Determines the iLO that is to be updated. This switch is followed by either the DNS name or IP address of the target server. When using IPv6 addresses, you can optionally add the port number preceded by a colon (). NOTE: Do not use this switch if you are launching from HP SIM.
Example 2 Web agent example (Mod_SNMP_IM_Settings.xml): PAGE 213 LOCFG.PL usage LOCFG.PL Utility To use the LOCFG.PL utility, you must have the following PERL modules: • Net::SSLeay • IO::Socket::SSL You 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]-f input_filename [-u username -p password] [iLO 3] LOCFG.
4 HPONCFG online configuration utility HPONCFG The HPONCFG utility is an online configuration tool used to set up and configure iLO from within Windows 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 command line using an account with administrator or root access. HPONCFG provides a limited graphical interface for servers that use Windows operating systems.
Windows server installation HPONCFG installs automatically when the Service Pack for ProLiant is installed. To install HPONCFG manually, run the self-extracting executable. HPONCFG creates a directory at: %Program files%\HP\hponcfg. Linux server installation HPONCFG is installed automatically when Service Pack for ProLiant is installed. Download the HPONCFG RPM package for Linux distributions from the HP website. Install the appropriate package using the RPM installation utility.
Table 4 HPONCFG command line parameters (continued) Parameter Effect /w filename Writes the iLO configuration obtained from the device to the XML output file named filename /a or /all Capture the complete configuration of iLO to a file. Must be used with /w command line parameter. /l filename Logs replies to the text log file that has name filename /v or /xmlverbose Display all the responses from iLO.
The command line format is: hponcfg -? hponcfg -h hponcfg -m minFw hponcfg -r [-m minFw ] hponcfg -w filename [-m minFw] hponcfg -g [-m minFw] hponcfg -f filename [-l filename] [-s namevaluepairs] [-v] [-m minFw] hponcfg -i [-l filename] [-s namevaluepairs] [-v] [-m minFw] For more information on using these parameters, see “HPONCFG command line parameters” (page 23).
PAGE 27 Setting a configuration Set a specific configuration by using the command format: hponcfg /f add_user.xml /l log.txt In this example, the input file has contents: PAGE 28
• To power the system on, enter: hponcfg /f Set_Host_Power.xml /s host_power=YES • To power the system off, enter: hponcfg /f Set_Host_Power.
PAGE 305 SMASH CLP usage SMASH CLP The DMTF SMASH initiative is a suite of specifications that deliver architectural semantics, industry standard protocols and profiles to unify the management of the data center. The SMASH CLP specification enables simple and intuitive management of heterogeneous servers in the data center. For more information, see “SMASH CLP Scripting Language” (page 33).
6 IPMI usage The IPMI utility Use the Linux IPMI tool and Windows IPMI util applications to test the IPMI interfaces on server platforms. The Linux IPMI tool is used in environments where scripting is used as the base for platform monitoring. The Windows IPMI util has a dependency on the IPMI driver if using "in-band" (or from a command prompt). The Windows IPMI driver is delivered in Windows Server 2008 R2. IPMI support might be available in later updates of Windows Server 2003 R2.
Most Linux IPMI tool commands can be issued remotely, including retrieving the IML entries and current sensor readings. The following parameter is required to enable the IPMI 2.0 RMCP+ protocol: -l lanplus Advanced IPMIutil usage on Windows Use the Windows IPMIutil.exe application for remote IPMI access to iLO. The commands, although different, provide similar functionality. • To retrieve the general status of iLO, enter: C:\> ipmiutil.
7 SMASH CLP Scripting Language SMASH CLP command line overview SMASH CLP provides a standardized set of commands for the configuration and control of management processors (called Management Access Points) and host systems. On iLO, SMASH CLP is accessed through the SSH port. SMASH CLP command line access The iLO 3 firmware features enable you to execute the supported commands from a SMASH CLP command line.
The privilege level of the logged in user is verified against the privilege required for the command. The command is only executed if the privilege levels match. If the serial command line session status is set to Enabled-No Authentication, then all the commands are executed without verifying the privilege level.
ESC ( Invokes the serial CLI connection. This is not necessary for SSH sessions because they automatically start a CLI session after a successful login. ESC R ESC r ESC R Resets the system. ESC ^ Powers on the system. ESC ESC Erases the current line. There is a one second timeout for entering any of the escape sequence characters.
delete Removes instances of the MAP in the name space. load Moves a binary image from a URL to the MAP. reset Causes a target to cycle from enabled to disabled, and back to enabled. set Sets a property or set of properties to a specific value, and resets iLO to implement the changes. start Causes a target to change the state to a higher run level. stop Causes a target to change the state to a lower run level.
User commands User commands enable you to view and modify user settings. Table 5 (page 37) shows the User Command properties. User settings are located at: /map1/accounts1. Targets All local users are valid targets. For example, if three local users have the login names Administrator, admin, and test, then valid targets are: • Administrator • admin • test Table 5 User Command Properties Property Access Description username read/write Corresponds to the iLO 3 login name.
You must have the Configure iLO Settings privilege to change these properties. SSO is only supported for browser access from trusted HP SIM servers. SSO is a licensed feature. Table 6 (page 38) shows the HP SSO properties. For more information, see the HP iLO User Guide on the HP website at http://www.hp.com/go/ilo3 and click More iLO Documentation. Targets None Table 6 HP SSO Properties Property Access Description oemhp_ssotrust Read/write The Single Sign-On required trust level.
• To assign the operator role Login, Remote Console, Virtual Power and Reset, and Virtual Media privileges: hpiLO-> set /map1/oemhp_ssocfg1 oemhp_ssooperator=login,oemhp_rc,oemhp_power,oemhp_vm • To Add an HP SIM Trusted Server name record: hpiLO-> cd map1/oemhp_ssocfg1 hpiLO-> create hpsim1.corp.
Properties, Targets, and Verbs: • enetport1 Targets ◦ lanendpt1 Properties ◦ EnabledState ◦ OtherTypeDescription ◦ Autosense ◦ PermanentAddress ◦ LinkTechnology ◦ Speed ◦ SystemName ◦ Fullduplex Verbs ◦ cd ◦ version ◦ exit ◦ show ◦ set For example set /map1/enetport1 Speed=100 set /map1/enetport1/lanendpt1/ipendpt1 IPv4Address=15.255.102.245 SubnetMask=255.255.248.
• gateway1 Properties • ◦ AccessInfo ◦ AccessContext dnsserver1 Properties ◦ AccessInfo ◦ AccessContext Verbs • ◦ cd ◦ version ◦ exit ◦ show ◦ set dnsserver2 Properties • ◦ AccessInfo ◦ AccessContext dnsserver3 Properties • ◦ AccessInfo ◦ AccessContext settings1 ◦ Targets DNSSettings1 Properties – DNSServerAddress – RegisterThisConnection – DomainName – DHCPOptionToUse WINSSettingData1 Specific commands 41
Properties ◦ • – WINSServerAddress – RegisterThisConnection – DHCPOptionToUse Verbs – cd – version – exit – show StaticIPSettings1 Properties ◦ oemhp_SRoute1Address ◦ oemhp_Mask1Address ◦ oemhp_Gateway1Address ◦ oemhp_SRoute2Address ◦ oemhp_Mask2Address ◦ oemhp_Gateway2Address ◦ oemhp_SRoute3Address ◦ oemhp_Mask3Address ◦ oemhp_Gateway3Address ◦ DHCPOptionToUse Specify one or more properties on the command line.
Table 7 iLO Properties (continued) Property Access Description oemhp_rbsuenable Read/Write Enables or disables RBSU prompt during POST. Boolean values are accepted. oemhp_rbsulogin Read/Write Enables or disables login requirement for accessing RBSU. Boolean values are accepted. oemhp_rbsushowip Read/Write Enables or disables iLO IP address display during POST. Boolean values are accepted. oemhp_httpport Read/Write Sets the HTTP port value. oemhp_sslport Read/Write Sets the SSL port value.
For example set /map1/config1 oemhp_mapenable=yes oemhp_timeout=30 Specify one or more properties in the command line. If multiple properties are on the same command line, they must be separated by a space. For example: set /map1/config1 oemhp_computer_lock=windows set /map1/config1 oemhp_computer_lock=custom,l_gui,l set /map1/config1 oemhp_computer_lock=disabled For a complete list of oemhp_computer_lock custom keys, see the HP iLO User Guide on the HP website at: http://www.hp.
For example The following command displays the system fan1 properties: hpiLO-> show For example: /system1/fan1 Targets Properties DeviceID=Fan 1 ElementName=System OperationalStatus=Ok VariableSpeed=Yes DesiredSpeed=14 percent HealthState=Ok VRM power supplies are usually mapped to the sensor targets.
SensorType=Temperature HealthState=Ok oemhp_CautionValue=41 oemhp_CriticalValue=45 SNMP settings SNMP settings commands enable you to view and modify SNMP settings. Table 9 (page 46) shows the SNMP command properties. SNMP settings are available at: /map1/snmp1 Targets None Properties Table 9 SNMP Command Properties Property Access Description accessinfo Read/Write Sets the SNMP trap destination address, where is 1, 2, or 3.
License commands License commands enable you to display and modify the iLO license. Table 10 (page 47) shows the License command properties.
Table 12 Directory Command Properties (continued) Property Access Description oemhp_ldapport Read/Write Sets the directory server port. oemhp_dirdn Read/Write Displays the LOM object distinguished name. This field is ignored when the schema-free directory configuration is used. oemhp_usercntxt1, 2 ... (up to 15) Read/Write Displays the directory user login search context. This field is not necessary when the schema-free directory configuration is used.
Table 13 Virtual Media Command Targets Target Description /map1/oemhp_vm1/floppydr1 Virtual floppy or key drive device /map1/oemhp_vm1/cddr1 Virtual CD-ROM device Table 14 Virtual Media Command Properties Property Access Description oemhp_image Read/Write The image path and name for virtual media access. The value is a URL with a maximum length of 80 characters. oemhp_connect Read Displays if a virtual media device is already connected through the CLP or scriptable virtual media.
Tasks • To insert a floppy USB key image into the Virtual Floppy/USBKey, enter: cd /map1/oemhp_vm1/floppydr1 show set oemhp_image=http://my.imageserver.com/floppyimg.bin set oemhp_boot=connect show This example executes the following commands: • ◦ Changes the current context to the floppy or key drive ◦ Shows the current status to verify that the media is not in use ◦ Inserts the desired image into the drive ◦ Connects the media.
• To insert a CD-ROM image and set for single boot, enter: cd /map1/oemhp_vm1/cddr1 set oemhp_image=http://my.imageserver.com/ISO/install_disk1.iso set oemhp_boot=connect set oemhp_boot=once show This example executes the following commands: • ◦ Changes the current context to the CD-ROM drive ◦ Shows the current status to verify that the media is not in use ◦ Inserts the desired image into the drive ◦ Connects the media.
/map1 • reset Set the status of the manual_iLO_reset property using the following commands: • set /map1/ manual_ilo_reset=yes • set /map1/ manual_ilo_reset=no Firmware commands Firmware commands enable you to display and modify the iLO 3 firmware version. Table 17 (page 52) shows the Firmware Update properties. Firmware settings are available at: /map1/firmware1 Targets No targets Table 17 Firmware Update Properties Property Access Description version read Displays the current firmware version.
Targets record:1..n Where n is the total number of records. Table 18 Eventlog Command Properties Property Access Description number read Displays the record number for the event. severity read Displays the severity of the event. Severity levels are informational, noncritical, critical, or unknown. date read Displays the event date. time read Displays the event time. description read Displays a description of the event. For example • show /system1/log1—Displays the IML.
bootsource Where n is the total number of boot sources. The boot source targets and matching boot source values do not change.
/system1/bootconfig1/bootsource5 Targets Properties bootorder=5 Verbs cd version exit show set To change the boot order, enter the following command: set /system1/bootconfig1/bootsource bootorder=. For example, to move bootsource1 (BootfmCd) to be the primary boot device: hpiLO-> set bootsource1 bootorder=1 Bootorder being set.
The CLP format is supported as well: • show /system1/led1—Verifies LED status • start /system1/led1—Turns LED on • stop /system1/led1—Turns LED off System properties and targets The properties and targets described in this section provide information about the server. Table 23 (page 56) shows the System targets. Table 24 (page 57) shows the System properties.
• show /system1/oemhp_power1 oemhp_pwrcap • set /system1/oemhp_power1 oemhp_pwrcap=0 • show /system1/oemhp_power1 oemhp_power_micro_ver The following command shows all the properties for oemhp_power1: show /system1/oemhp_power1 Example output: /system1/oemhp_power1 Targets Properties oemhp_powerreg=os oemhp_pwrcap=0 Watts oemhp_PresentPower=147 Watts oemhp_AvgPower=146 Watts oemhp_MaxPower=180 Watts oemhp_MinPower=146 Watts oemhp_powersupplycapacity=750 Watts oemhp_servermaxpower=361 Watts oemhp_serve
Table 25 System CPU Properties Property Access Description number_cores Read Displays the number of processor cores. active_cores Read Displays the number of active processor cores. threads Read Displays the total number of threads on the active processor cores. speed Read Displays the processor speed. memory_technology Read Displays the bit level technology of the memory. cachememory1 Read Displays the size of the processor level-1 cache.
Table 28 (page 59) shows the System Firmware properties. The properties are available at: /system1/firmware1 Table 28 System Firmware Properties Property Access Description version Read Displays the version of the system ROM. date Read Displays the date the system ROM. For example: • show /system1/cpu1—Displays information on one CPU. • show /system1/memory1—Displays information on one memory slot. • show /system1/slot1—Displays information on one slot.
8 RIBCL XML Scripting Language Overview of the RIBCL RIBCL enables you to write XML scripts to configure and manage iLO 3 configuration settings, user accounts, directory settings, server settings, and HP SSO settings. Download the sample scripts from the HP website at http://www.hp.com/go/iLO3. Click HP iLO Sample Scripts for Windows or HP Lights-Out XML Scripting Sample for Linux under Helpful Downloads..
Response definitions Every command that is sent to iLO generates a response. The response indicates whether the command succeeded or failed. Some commands generate additional information. The additional information appears in execution sequence, provided no errors occurred. For example: PAGE 62Combining multiple commands in one RIBCL script To combine multiple commands in a single RIBCL script, enclose each command in a top level *_INFO tag. One of the following top level tags must enclose each command used, or accidental changes to your configuration can result: • USER_INFO • RIB_INFO • DIR_INFO • BLADESYSTEM_INFO • SERVER_INFO • SSO_INFO See the examples below for contrasting script samples.
Example 3 Incorrectly combined script PAGE 64execute RIBCL commands. The user privileges are verified against the required privilege for a particular command, and an error is returned if the privilege level does not match. For example: Alternatively, the HPQLOCFG utility allows you to specify the login information as parameters on the command line using switches: hpqlocfg -u username -p password LOGIN parameters USER_LOGIN is the login name of the user account.
ADD_USER parameters USER_NAME is the actual name of the user. This parameter can be a combination of any printable characters up to a maximum length of 39 characters.
• Password is too long. • User table is full. No room for new user. • Cannot add user. The user name already exists. • User information is open for read-only access. Write access is required for this operation. • User name cannot be blank. • User login ID cannot be blank. • Boolean value not specified. • User does not have correct privilege for action. ADMIN_PRIV required. DELETE_USER The DELETE_USER command is used to remove an existing local user account.
DEL_SSH_KEY parameters None DEL_SSH_KEY runtime errors Possible DEL_SSH_KEY runtime errors include: • User login name must not be blank • User does not have correct privilege for action. ADMIN_PRIV required. • Unable to clear the SSH key. GET_USER The GET_USER command returns local user information, excluding the password. The USER_LOGIN parameter must exist in the current user database.
MOD_USER The MOD_USER command is used to modify an existing local user account. The USER_LOGIN parameter must exist in the current user database. For this command to parse correctly, the command must appear within a USER_INFO command block, and USER_INFO MODE must be set to write. The user must have the Administer User Accounts privilege. Otherwise, the user can only modify their individual account password.
USER_NAME is the actual name of the user to be modified. This parameter is not case sensitive, can be any valid string, and has a maximum length of 39 characters. This string is used for display only and must not be left blank. PASSWORD is the password associated with the user. This parameter is case sensitive and can be a combination of any printable characters. The length is user defined and can be a minimum of zero characters and a maximum of 39 characters.
GET_ALL_USERS parameters None GET_ALL_USERS runtime errors The possible GET_ALL_USERS error messages include: • User does not have correct privilege for action. ADMIN_PRIV required.
GET_ALL_USER_INFO runtime errors The possible GET_ALL_USER_INFO error messages include: User does not have correct privilege for action. ADMIN_PRIV required. GET_ALL_USER_INFO return messages A possible GET_ALL_USER_INFO return message is: ...... The same information will be repeated for all the users.
RESET_RIB The RESET_RIB command is used to reset iLO. For this command to parse correctly, the command must appear within a RIB_INFO command block, and RIB_INFO MODE can be set to read or write. The user must have the Configure iLO Settings privilege to execute this command. For example: PAGE 73GET_EVENT_LOG runtime errors GET_EVENT_LOG returns a runtime error if it is not called from within the RIB_INFO or SERVER_INFO block. For example: GET_EVENT_LOG return messages The response includes all of the events recorded, in the order that they occurred. Events are not sorted by severity or other criteria.
COUNT="1" DESCRIPTION="POST Error: 1775-Drive Array ProLiant Storage System not Responding" /> ... CLEAR_EVENTLOG The CLEAR_EVENTLOG command clears the iLO Event Log. For this command to parse correctly, the command must appear within a RIB_INFO command block, and RIB_INFO MODE must be set to write. The user must have the Configure iLO Settings privilege to execute this command. For example: PAGE 75 -->
COMPUTER_LOCK_CONFIG parameters COMPUTER_LOCK value— You can customize Windows, Linux and other operating systems by setting the value: • windows—Sets the command to define the computer lock for a Windows based operating system. The computer lock on Windows based operating systems defaults to the Windows logo + L keys. • custom—Sets the command to define the computer lock for a non-Windows based operating system.
GET_NETWORK_SETTINGS parameters None GET_NETWORK_SETTINGS runtime errors None GET_NETWORK_SETTINGS return messages A possible GET_NETWORK_SETTINGS return message is: PAGE 77ADDR_STATUS="ACTIVE"/> VALUE="fe80::1ec1:deff:fe17:b390" PREFIXLEN="64" ADDR_SOURCE="SLAAC" ADDR_STATUS="ACTIVE"/>
MOD_NETWORK_SETTINGS Use MOD_NETWORK_SETTINGS to modify network settings. For this command to parse correctly, the command must appear within a RIB_INFO command block, and RIB_INFO MODE must be set to write. The user must have the Configure iLO Settings privilege to execute this command. The iLO scripting firmware does not attempt to decipher if the network modifications are appropriate for the network environment.
RBSU POST IP example: PAGE 80IPV6_DEST="2001:DB8:2002:3003::" PREFIXLEN="64" IPV6_GATEWAY="2001:DB8:1::40" ADDR_STATUS="ACTIVE"/>
When using the iLO Shared Network Port, flashing the iLO firmware through the XML interface takes approximately 7 minutes to complete. Flashing the firmware using Shared Network Port with iLO does not take any longer to complete than using the dedicated iLO management port. REG_DDNS_SERVER VALUE instructs iLO to register the management port with a DDNS server. The possible values are Yes or No.
SEC_DNS_SERVER specifies the IP address of the secondary DNS server. This parameter is only relevant if the DHCP-assigned DNS server address feature is disabled. If an empty string is entered, the current value is deleted. TER_DNS_SERVER specifies the IP address of the tertiary DNS server. This parameter is only relevant if the DHCP-assigned DNS server address feature is disabled. If an empty string is entered, the current value is deleted.
addresses specified in the script will be in use by iLO after the script successfully completes. All static address entries on iLO can be cleared by specifying a single blank IPV6_ADDRESS entry. • ADDR_SOURCE may be included for ease in turning around GET_NETWORK_SETTINGS output as input to MOD_NETWORK_SETTINGS. However, if the value is not STATIC the entire entry is ignored. • ADDR_STATUS may be included for ease in turning using GET_NETWORK_SETTINGS output as input to MOD_NETWORK_SETTINGS.
addresses are configured, this setting determines the order of use for the primary addresses, then the secondary addresses, and finally the tertiary addresses. DHCPV6_STATELESS_ENABLE and DHCPV6_STATEFUL_ENABLE modifies the operational mode of DHCPv6. The values for both of these parameters can be either Y (enabled) or N (disabled). • DHCPV6_STATEFUL_ENABLE is analagous to DHCPv4, and enables the configuration of a node address and additional parameters such as NTP server location and time zone.
MOD_GLOBAL_SETTIN
As of release iLO 3 version 1.05, the Virtual Serial Port supports automatically enabling and disabling software flow control. By default, this behavior is disabled. You can enable this configuration option using the RIBCL only. To enable this option, execute the following script: Example: PAGE 87• 3—Enabled (records every third authentication failure: this is the default value.) • 5—Enabled (records every fifth authentication failure) SSH_STATUS—Determines if SSH is enabled. The valid values are Yes or No, which enable or disable SSH functionality. SSH_PORT—Specifies the port used for SSH connection on iLO 3. The processor must be reset if this value is changed. SERIAL_CLI_STATUS—Specifies the status of the CLI.
VSP_LOG_ENABLE—Determines whether the virtual serial port output from the server is captured. Valid values are Y (enabled) or N (disabled). The parameter is not case sensitive. PROPAGATE_TIME_TO_HOST—Determines whether iLO sets the system host time to match the iLO time. Valid values are Y (enabled) or N (disabled). If enabled, the propagation time set occurs whenever the iLO is cold-booted. The parameter is not case sensitive.
GET_SNMP_IM_SETTINGS parameters None GET_SNMP_IM_SETTINGS runtime errors None GET_SNMP_IM_SETTINGS return messages A possible GET_SNMP_IM_SETTINGS return message is: MOD_SNMP_IM_SETTINGS MO
MOD_SNMP_IM_SETTINGS runtime errors Possible MOD_SNMP_IM_SETTINGS error messages include: • RIB information is open for read-only access. Write access is required for this operation. • User does not have correct privilege for action. CONFIG_ILO_PRIV required. UPDATE_RIB_FIRMWARE The UPDATE_FIRMWARE command copies a specified file to iLO, starts the upgrade process, and reboots the board after the image has been successfully flashed.
• Unable to read the firmware image update file. • The firmware upgrade file size is too big. • The firmware image file is not valid. • A valid firmware image has not been loaded. • The flash process could not be started. • IMAGE_LOCATION must not be blank. • User does not have correct privilege for action. CONFIG_ILO_PRIV required. GET_FW_VERSION The GET_FW_VERSION command requests the respective iLO firmware information.
LICENSE parameters ACTIVATE followed by a valid KEY value signals the activation of the iLO 3 advanced pack licensing. KEY specifies the license key value. The key must be entered as one continuous string. Commas, periods, or other characters must not separate the key value.
• filename is mandatory. • cgi-helper is optional. This enables the virtual floppy to be writable. In addition, the filename field can contain tokens that expand to host-specific strings: • %m expands to the iLO 3 MAC address. • %i expands to the iLO 3 IP address in dotted-quad form. • %h expands to the iLO 3 hostname. For example: http://john:abc123@imgserver.company.com/disk/win98dos.bin,/cgi-bin/ hpvfhelp.pl http://imgserver.company.com/disk/boot%m.
EJECT_VIRTUAL_MEDIA runtime errors Possible EJECT_VIRTUAL_MEDIA errors are: • RIB information is open for read-only access. Write access is required for this operation. • User does not have correct privilege for action. VIRTUAL_MEDIA_PRIV required. • No image present in the Virtual Media drive. • An invalid Virtual Media option has been given. GET_VM_STATUS GET_VM_STATUS returns the Virtual Media drive status. This command must display within a RIB_INFO element. For example: PAGE 95VM_APPLET = CONNECTED | DISCONNECTED DEVICE = FLOPPY | CDROM BOOT_OPTION = BOOT_ALWAYS | BOOT_ONCE | NO_BOOT WRITE_PROTECT_FLAG = YES | NO IMAGE_INSERTED = YES | NO NOTE: If the BOOT_ONCE boot option is selected, all scriptable virtual media parameters are reset to default settings after the server boots. Specifically BOOT_OPTION = NO_BOOT, WRITE_PROTECT = NO, and IMAGE_INSERTED = NO. SET_VM_STATUS The SET_VM_STATUS command sets the Virtual Media drive status.
Virtual Media device connected, on the subsequent server reboot, the Virtual Media device does not connect and the following Virtual Media device settings reset to their default values: • ◦ BOOT_OPTION=NO_BOOT ◦ IMAGE_INSERTED = NO NO_BOOT sets the VM_BOOT_OPTION to NO_BOOT. The Virtual Media device is not connected during the next server boot. The Virtual Media device is not disconnected immediately when the VM_BOOT_OPTION is set.
CERTIFICATE_SIGNING_REQUEST This command requests a certificate from iLO. When this command is received, iLO generates a certificate signing request. The request is returned to the user enclosed in a CERTIFICATE_SIGNING_REQUEST tag. This command requires HPQLOCFG.EXE version 1.00 or later. For example: PAGE 98• CSR_LOCALITY is too long. • Need a value for the CSR_LOCALITY tag. • CSR_ORGANIZATION is too long. • Need a value for the CSR_ORGANIZATION tag. • CSR_ORGANIZATIONAL_UNIT is too long. • CSR_COMMON_NAME is too long. • Need a value for the CSR_COMMON_NAME tag. • User does NOT have correct privilege for action. CONFIG_ILO_PRIV required.
SET_LANGUAGE Use this command to set the default language on iLO. Use this command with iLO 3 v1.20 or later. Use HPQLOCFG.EXE version 1.00 or later with this command. SET_LANGUAGE parameters LANG_ID is the two letter designation for a language. This parameter is case sensitive, and must not be blank.
GET_ALL_LANGUAGES parameters None GET_ALL_LANGUAGES runtime errors None SET_ASSET_TAG Use this command to set or clear the asset tag. Use this command with iLO 3 v1.50 or later. Use HPQLOCFG.EXE version 1.00 or later with this command. You must have the following privileges to execute this command: Virtual Media, Virtual Power and Reset, Remote Console. PAGE 101GET_SECURITY_MSG Use this command to retrieve the security message for the iLO login screen. Use this command with iLO 3 v1.50 or later. PAGE 102User does NOT have correct privilege for action. CONFIG_ILO_PRIV required. HOTKEY_CONFIG The HOTKEY_CONFIG command configures the remote console hot key settings in iLO. For this command to parse correctly, the command must appear within a RIB_INFO command block, and RIB_INFO MODE must be set to write. The user must have the configure iLO privilege to execute this command.
in its place. The following table lists keys available to combine in a Remote Console hot key sequence. ESC F1 – d s BACKSPACE L_ALT F2 ( e t SYS RQ R_ALT F3 ) f u 1 L_SHIFT F4 * g v 2 R_SHIFT F5 + h w 3 INS F6 : I x 4 DEL F7 < j y 5 HOME F8 > k z 6 END F9 = l ; 7 PG UP F10 [ m ‘ 8 PG DN F11 ] n L_CTRL 9 ENTER F12 \ o R_CTRL 0 TAB SPACE a p NUM PLUS NONE BREAK / b q NUM MINUS L_GUI COMMA .
Unable to get the hot keys.
GET_FIPS_STATUS runtime errors None GET_FIPS_STATUS return messages A possible GET_FIPS_STATUS return message is: The value for FIPS_MODE can be “Enabled” or “Disabled”. GET_ALL_LICENSES Use the GET_ALL_LICENSES command to retrieve license type, key, installation date, and class in iLO 3 v1.60 or later. Use HPQLOCFG.EXE version 1.00 or later with this command.
FACTORY_DEFAULTS parameters None FACTORY_DEFAULTS runtime errors None IMPORT_SSH_KEY The IMPORT_SSH_KEY command imports a SSH_KEY and associated iLO user name into iLO. This command requires HPQLOCFG.EXE version 1.00 or later. After generating an SSH key using ssh-keygen, puttygen.
IMPORT_SSH_KEY parameters None IMPORT_SSH_KEY runtime errors The possible IMPORT_SSH_KEY error messages include: • RIB information is open for read-only access. Write access is required for this operation. • Duplicate of existing SSH key. • Invalid SSH key data. • There is no user name or the user name appended to SSH key does not exist. • SSH key is too large for storage space. DIR_INFO The DIR_INFO command can only appear within a LOGIN command block.
GET_DIR_CONFIG return messages Starting with iLO 3 1.05, directory integration can work with HP Lights-Out schema with or without extensions (schema-free). Depending on your directory configuration, the response to GET_DIR_CONFIG contains different data. Possible GET_DIR_CONFIG return messages are: • A directory services (with schema extension) return message: PAGE 109
• A Kerberos-enabled directory return message:
directory integration and existing schemas. See MOD_SCHEMALESS_DIRECTORY.XML for an example suitable for use in a schemaless directory configuration. For example: PAGE 111 NOTE: To modify only the kerberos authentication, start with the sample script Mod_Kerberos_Config.xml. NOTE: Do not use the following tags when using directory integration with schema extension: • DIR_ENABLE_GRP_ACCT • DIR_GRPACCT1_NAME • DIR_GRPACCT1_PRIV Do not use the following tags when using schema-free directories: • DIR_OBJECT_DN • DIR_OBJECT_PASSWORD Schemaless directory example (MOD_SCHEMALESS_DIR.
value = "1,3,4"/> support information for next tag: All versions. Version 1.20 or later only --> --> --> --> value = "3,6"/> support information for next tag: All versions. Version 1.
DIR_KERBEROS_KDC_PORT specifies the port number used to connect to the domain controller. The Kerberos port number is 88, but the domain controller can be configured for a different port number. DIR_KERBEROS_KEYTAB specifies the contents of the keytab file which is a binary file containing pairs of principals and encrypted passwords. In the Windows environment, the keytab file is generated with a ktpass utility.
used. The values for these parameters are obtained from the directory administrator. Directory User Contexts are limited to 128 characters each. MOD_DIR_CONFIG runtime errors Possible MOD_DIR_CONFIG error messages include: • Directory information is open for read-only access. Write access is required for this operation. • User does not have correct privilege for action. CONFIG_ILO_PRIV required. MOD_KERBEROS The MOD_KERBEROS command modifies the directory settings in iLO.
GET_OA_INFO The GET_OA_INFO command requests the Onboard Administrator information from the enclosure where iLO 3 is located. For this command to parse correctly, the GET_OA_INFO command must appear within a BLADESYSTEM_INFO command block, and BLADESYSTEM_INFO MODE can be set to read or write. For example: PAGE 116
Set host power example:
