HP iLO 4 Scripting and Command Line Guide

1 HP iLO 4 Scriptingand CommandLineGuideAbstractThis document describes the syntax and tools available for use with the HP iLO firmware through the commandline 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 trainedin recognizing hazards in products with hazardous 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 Part Number: 684919-006 Published:February 2014 Edition: 1 Copyright 2012, 2014 Hewlett-Packard Development Company, computer software. Valid license from HP required for possession, use or copying. Consistent with FAR and , CommercialComputer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the Government undervendor s standard commercial information containedherein is subject to changewithout notice.

2 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 and Windows , are registered trademarks of Microsoft is a trademark of Intel Corporation in the and other is a registered trademark of Oracle and/or its will replacedefective delivery media for a period of 90 days from the date of purchase. This warranty applies to all Insight commandline Guide commandline in this Insight Control server HPQLOCFG for unauthenticated XML system collection in HP applications with HP SIM custom processing using commandline quote variables and namevalue pairs with commandline HPONCFG online configuration supported server server installation ..25 VMware commandline HPONCFG on Windows HPONCFG on Linux basic specific a variable and restoring a SMASH CLP CLP.

3 326 IPMI IPMI IPMI tool tool usage on usage on SMASH CLP CLP commandline CLP commandline the SSO 4 4 Media and Reset firmware properties and RIBCL XML of the runtime one RIBCL runtime runtime runtime runtime return runtime runtime return runtime return runtime runtime return runtime return runtime runtime return runtime return return runtime runtime runtime runtime runtime return runtime runtime return runtime runtime runtime return runtime runtime runtime return and runtime runtime runtime return runtime runtime runtime runtime return runtime parameters (for custom CSR)..1166 ContentsCERTIFICATE_SIGNING_REQUEST runtime runtime runtime (TRIGGER_BB_DATA).. (TRIGGER_BB_DATA) (TRIGGER_BB_DATA) runtime runtime runtime runtime runtime runtime runtime runtime runtime runtime runtime runtime runtime return runtime runtime return runtime runtime runtime return runtime runtime runtime runtime runtime runtime return runtime return runtime runtime runtime return runtime runtime return runtime return runtime return runtime return runtime return runtime return (Legacy).

4 151 SET_PERSISTENT_BOOT runtime (UEFI)..152 SET_PERSISTENT_BOOT runtime return runtime return runtime return return runtime return return return runtime runtime runtime return runtime runtime Return error runtime runtime runtime runtime runtime return return return return runtime runtime runtime Secure SSH Secure key definition SSH keys from SSH keys generated using PERL PERL with the XML 11 XML an SSL XML header and script iLO 4 Shared Network Port feature through XML dedicated NIC management Support and other to collect before contacting to contact bulletin and alert policy for non-HP owned software for software technical support and update to use your software technical support and update authorized Documentation Sample script and Contents1 IntroductionScriptingand commandline Guide overviewHP iLO 4 provides

5 Multipleways to configure, update, and operate HP ProLiant servers iLO User Guidedescribes each feature and explainshow to use these features with thebrowser-based interface and RBSU. For more information, see theHP iLO User Guideon the HPwebsite at iLO Scripting and CommandLine Guidedescribes the syntax and tools available to useiLO 4 through a commandline or scripted XML scripts downloadedfrom the HP website contain commandsfor all iLO otherwise specified, the examples in this Guide are for iLO 4 firmware version andlater. Before using the sample scripts, review the firmware support information in each script totailor the script for the intendedfirmware and version. Downloadthe sample scripts from the HPwebsite at ClickiLO Sample Scripts for WindowsorLights-Out XMLscriptingsample for Linuxon theResourcestab, this manual, iLO 4 is referred to as addition to the GUI, the iLO firmware provides multipleways to configure and control iLO andthe server using scripts and commandline scriptingtools provide a method to configure multipleiLO systems, to incorporate a standardconfiguration into the deployment process, and to control servers and subsystems.

6 Using the scriptingtools enables you to: Changethe 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 commandline tools provide quick and easy methods to send commandsto the iLO firmwareand host commandline utilitiesThis section describes the following scriptingand commandline tools: SMASH CLP IPMIThe current version of iLO introduces RIBCL headers that offer expandedscript functionality. Upgradeany of the utilities you use to the versions listed below to take advantage of the current version of iLO 4 requires upgrades to the following utilities:Scriptingand commandline Guide overview 13 Table 1 HP iLO 4 scriptingand commandline utilitiesrequired versionsVersionnotesfor iLO 4 Lights-Out Configuration Utility. This replaces the use this version of the HP Lights-Out OnlineConfiguration Utilityyou must also upgrade your Channel Interface Driver (CHIF) to utility is available in the HP Lights-Out XML to this version of HPLOMIG before installingthe iLO 4 :Upgrades are required only for the utilities you use.

7 Continuing to use utilities without theupdate will cause the following inform message to appear: Scripting utility should be updated to the latest UtilityThe HP Lights-Out Configuration Utility ( ) utility replaces the previously utility. HPQLOCFG is a Windows commandline 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 tool acceptsproperly formatted XML scripts containingcommandsand values; see the XMLscripts in theiLO Sample Scripts for Windowsor theHP Lights-Out XML Scripting Sample for Linuxfor examples of proper formatting. All available commandsare detailedlater in this also integrates with HP SIM for easy launching of the same script on ScriptThe scriptingutility is a PERL script that provides similarfunctionality as the HPQLOCFG utility. Run this tool on any client that has a compatiblePERL environment (includingOpenSSL)installed.

8 This tool uses the same XML scripts as HPQLOCFG input UtilityUse the utility to send XML configuration and control scripts (the same scripts asHPQLOCFG) from the server host operatingsystem 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 unattendedOS you run HPONCFG from the host operating system, you must be loggedin to the host serverusing an Administrator or root level user account. An iLO user ID and password is not server operatingsystems also have the utility. This utility providesthe same basic configuration capabilities as the iLO F8 ROM-RBSU during the server 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 CLP provides a standardized set of commandsfor configuration and control of managementprocessors (calledManagement Access Points) and host systems.

9 On iLO, access SMASH CLPthrough the SSH IntroductionIPMIThe IPMI specification is a standard that defines a set of common interfaces to a computer administrators can use IPMI to monitor system healthand managethe system. IPMI a mandatory system interface, and an optional LAN interface. The iLO processor supportsboth IPMI specification defines a standardized interface for platform management. The IPMI specification 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 Loggingcapabilities for abnormal events, such as over-temperature readings or fan failures Inventory capabilities, such as identifying failedhardware componentsIPMI commandsare sent to iLO using a third-party or open source utility, such as IPMITOOL,IPMIUTIL, OpenIPMI or must be familiar with IPMI specifications when issuingraw commands. For additionalinformation, see the IPMI specification on the Intel website at in this versionThis Guide reflects changes in the iLO 4 firmware.

10 This Guide covers iLO 4 firmware version following updates or additions were made: iLO Federation ManagementNOTE:iLO Federation Management is supported on IPv4 and IPv6 networks on the iLODedicated Network Port. It is not supported on iLO Shared Network Port. If you receive a datainconsistency error when using iLO Federation Management, refer to the multisystem mappagefor troubleshooting. HP ProLiant Bladeservers must have Onboard Administrator before using iLO Federation Management. Insight Remote Support Direct Connect configuration HP Enterprise Secure Key Manager ESKM and later, which can be used in conjunctionwith HP Secure Encryption. Improved Java Integrated Remote Console (IRC) UEFI System Utilities on the HP ProLiant DL580 Gen8 server Addedthe following commands:Federation commands: ADD_FEDERATION_GROUP DELETE_FEDERATION_GROUP GET_FEDERATION_ALL_GROUPS GET_FEDERATION_ALL_GROUPS_INFO GET_FEDERATION_GROUP GET_FEDERATION_MULTICASTNew in this version 15 MOD_FEDERATION_GROUP SET_FEDERATION_MULTICAST Insight Remote Support Direct Connect commands:DC_REGISTRATION_COMPLETE SET_ERS_DIRECT_CONNECT SET_ERS_WEB_PROXY Boot configuration commands:GET_CURRENT_BOOT_MODE GET_PENDING_BOOT_MODE GET_SUPPORTED_BOOT_MODE SET_PENDING_BOOT_MODE Encryption commands: GET_ENCRYPT_SETTINGS GET_TPM_STATUS MOD_ENCRYPT_SETTINGS Updated the following commands.