Printable version

Drivers & software

HP Lights-Out XML Scripting Sample for Windows

By downloading, you agree to the terms and conditions of the Hewlett Packard Enterprise Software License Agreement.
Note:  Some software requires a valid warranty, current Hewlett Packard Enterprise support contract, or a license fee.

Type: Software - Lights-Out Management
Version: 1.64.0-1(24 Nov 2004)
Operating System(s): Microsoft Windows 2000
Microsoft Windows NT 4.0
Microsoft Windows Server 2003
Novell NetWare 5.1
Novell NetWare 6.5
File name: ilosamplescripts1.64.0-1.zip (109 KB)
The HP Lights-Out management processors support an advanced scripting interface for group configuration and server actions. The scripting capability of the iLO provides an easy and efficient way to configure and maintain management processors in large scale IT environments, saving time and costs. The Lights-Out Configuration Utility can be used to configure iLO, RILOE II, and RILOE.

It takes just a few simple steps to use the scripting interface:

Download and install the Light-Out Configuration Utility on your client system
Download and modify these sample scripts
Run the CPQLOCFG program in a batch process or using Insight Manager 7

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


The following scripts have been added or modified to support additional firmware features available in 1.64:

  • Cert_Request.xml

  • Import_Cert.xml

To ensure the integrity of your download, HPE recommends verifying your results with this SHA-256 Checksum value:

cc234e4edd7b481439c827b923bda081df449bee47388804c44d81cb2c7f4bdf ilosamplescripts1.64.0-1.zip

Reboot Requirement:
Reboot is not required after installation for updates to take effect and hardware stability to be maintained.


Installation:
Extract ilo_xml-1.2.tar.gz to a subdirectory. This compressed file contains the following files:

  • Add_User.xml - Add a user to the iLO user database.

  • Administrator_reset_pw.xml- Reset the default administrator account password using HPONCFG.

  • Cert_Request.xml - Request a Certificate Signing Request from iLO.

  • Change_Password.xml - Change the password of an existing iLO user.

  • Clear_EventLog.xml - Clear the iLO Event Log

  • Delete_User.xml - Delete a user from the iLO user database.

  • Eject_Virtual_Media.xml - Ejects the image of the specified Virtual Media device.

  • Get_All_User_Info.xml - Return the configuration details for all users.

  • Get_All_Users.xml - Return a list of all iLO user accounts.

  • Get_Diagport.xml - Return BL p-class diagport settings.

  • Get_Directory.xml - Return the current directory configuration of an iLO.

  • Get_FW_Version.xml - Return the version and date/time of the iLO firmware.

  • Get_Global.xml - Return global settings.

  • Get_Host_Data.xml - Retrieve SMBIOS data from Server Information page.

  • Get_Host_Power.xml - Return the current power state of the host server.

  • Get_iLO_Log.xml - Retrieve the records in the iLO Event Log.

  • Get_IML.xml - Retrieve the records in the Integrated Management Log.

  • Get_SNMP_IM.xml - Return the current SNMP and Insight Manager security settings.

  • Get_Topology.xml - Return BL p-Class rack infrastructure topology.

  • Get_Network.xml - Return network settings.

  • Get_UID_Status.xml - Return the current state of the server's Unit ID (UID) on the host server.

  • Get_User.xml - Return the configuration details for a single user.

  • Get_VM_Status - Return the status of the specified Virtual Media device.

  • Get_Enc_Bay_IP_Settings.xml - Obtain static IP settings of individual blades in the respective enclosure.

  • Hotkey_Config.xml - Change the values for Remote Console hotkeys.

  • Import_Cert.xml - Import a signed certificate into iLO.

  • Insert_Virtual_Media.xml - Inserts the Virtual Media image via specified URL.

  • License.xml - Add the iLO Advanced Pack license key for a server.

  • Mod_Blade_Rack.xml - Change the BL p-Class blade and rack settings.

  • Mod_DiagPort_Settings.xml - Change the iLO Diagnostic Port network settings.

  • Mod_Directory.xml - Change the directory settings of an iLO.

  • Mod_Global_Settings.xml - Change the iLO Global Settings.

  • Mod_Network_Settings.xml - Change the iLO Network Settings.

  • Mod_SNMP_IM_Settings.xml - Change the iLO SNMP and Insight Manager Settings.

  • Mod_User.xml - Change the login id, display name, password and/or privileges for an existing iLO user account.

  • Mod_Enc_Bay_IP_Settings.xml - Modify the static IP settings of individual blades in the respective enclosure.

  • RBSU_POST_IP.xml - Configure iLO to display the IP address at POST.

  • Reset_RIB.xml - Restart the iLO Management Processor.

  • Reset_Server.xml - Immediately power off and back on the host server.

  • Set_Host_Power.xml - Power on/off the host server.

  • Set_VM_Status.xml - Sets the boot options, write protection of the specified Virtual Media device.

  • Shared_Network_Port.xml - Configure the iLO NIC port on supported platforms.

  • UID_Control.xml - Turn on/off the Unit ID (UID) light on the host server.

  • Update_Firmware.xml - Flash the iLO firmware to a new version.
Utilities and documentation may be downloaded from: http://www.hp.com/servers/lights-out Click on iLO, then click on "Software and Drivers" or "Support and Documents"documentation" for appropriate links.

A valid iLO user account and password is required for each XML script when using CPQLOCFG. The user account must have appropriate lights-out privileges to process the request.

The CPQLOCFG utility connects to the iLO management processor using a 128-bit Secure Sockets Layer (SSL) connection.

    CPQLOCFG -s [servername|ipaddress]|[:port] -l [logfilename] -f [input filename] -v -c
Where:
    -s servername is the DNS name of target server.
    -s ipaddress is the IP Address of the target server. If a port is not specified, the port will default to :443.

      DO NOT USE this switch if launching from Insight Manager 7.

    -l logfilename is the name of the file to log all output to. A default file with the server name/ipaddress is created if this option is not specified.

      DO NOT USE this switch if launching from Insight Manager 7.

    -f input filename is the filename containing the RIB Commands
    -v Enables verbose message logging. By default, only errors and responses from GET commands will be logged without the -v switch.
    -c Will cause CPQLOCFG to check for correct xml formatting, but not open a connection to the management processor.

End User License Agreements:
Hewlett-Packard End User License Agreement


Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


Notes:
Updated iLO User Guide 1.60 and Updated Information Booklet 1.60 can also be found by following the links at: http://h20000.www2.hp.com/bizsupport/TechSupport/DocumentIndex.jsp?contentType=SupportManual&locale=en_US&docIndexId=179911&taskId=101&prodTypeId=15351&prodSeriesId=397989.


Version:5.40.0 (30 Nov 2020)
Fixes

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


This version does not contain any defect fixes.

Enhancements

 This version specifically contains changes related to updating legacy HP branding and brand references from prior to the separation of Hewlett-Packard Company to current HPE branding and references.


Version:5.30.0 (6 Jul 2020)
Enhancements

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


Added Remove_Webserv_Cert.xml script to remove iLO SSL/webserver certificate for iLO3 v1.92 or later.


Version:5.20.0 (20 Dec 2019)
Enhancements

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


Added new tags for Alert mail in Mod_Global_Settings.xml.


Version:5.10.0 (16 Jan 2018)
Enhancements

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


Added Get_PS_Data.xml to sample script bundle.


Version:5.00.0 (12 Jul 2017)
Enhancements

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


iLO 5 support introduced in LOCFG.pl.


Version:4.91.0 (15 May 2017)
Enhancements

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


Support for iLO 4 v2.53 firmware -

  • Ability to enable Generic LDAP from Mod_Directory.xml
  • Ability to Import LDAP CA certificate into an iLO using Import_LDAP_CA_Cert.xml
  • Ability to get LDAP CA certificate status using Get_LDAP_CA_Cert_Status.xml

Version:4.90.0 (24 Oct 2016)
Enhancements

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


Added a new tag to Mod_Network_Settings.xml

  • IPMI_DCMI_OVER_LAN_PORT

Version:4.80.0 (1 Apr 2016)
Enhancements

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


Added support to set or get the critical temperature shutdown behavior of a server

  • Set_Host_CTRO.xml
  • Get_Host_CTRO.xml

Added support to perform Directory Tests

  • Start_Directory_Test.xml
  • Get_Directory_Test_Results.xml
  • Abort_Directory_test.xml

Added 4 new tags to Mod_Network_Settings.xml

  • ILO_NIC_AUTO_SNP_SCAN
  • ILO_NIC_AUTO_DELAY
  • ILO_NIC_FAIL_OVER
  • ILO_NIC_FAIL_OVER_DELAY

Version:4.70.0 (1 Oct 2015)
Fixes

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


  • AUTHENTICATION_FAILURE_DELAY_SECS, AUTHENTICATION_FAILURES_BEFORE_DELAY and LOCK_CONFIGURATION tags added to Mod_Global_Settings.xml

Version:4.60.0 (15 Jun 2015)
Fixes

Upgrade Requirement:
Recommended - HPE recommends users update to this version at their earliest convenience.


  • Improved error handling for script execution in LOCFG.pl
Enhancements

  • Introduced FEDERATION_ENABLE tag in Set_Federation_Multicast_Options.xml
  • 4 new scripts added for Hard Drive zoning - HD_Zone_Defaults.xml, HD_Zone_ReadBackplaneInfo.xml, HD_Zone_ReadZoneTable.xml and HD_Zone_Write_Zone.xml

Version:4.50.0 (30 Mar 2015)
Enhancements

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


- Introduced SNP_PORT tag in Shared_Network_Port.xml
- Added DHCPV6_DOMAIN_NAME and ILO_NIC_AUTO_SELECT tags in Mod_Network_Settings.xml
- SSL_V3_ENABLE tag for iLO2 Management Processor is included in MOD_GLOBAL_SETTINGS.xml
- Result of script execution gets printed at the end of each run in LOCFG.PL
- 2 new scripts added - Get_SDCard_Status.xml and Send_Snmp_Test_Trap.xml


Version:4.40.0 (9 Sep 2014)
Fixes

Upgrade Requirement:
Recommended - HP recommends users update to this version at their earliest convenience.


LOCFG.PL supports iLO fully qualified domain name(FQDN) with –s option


Version:4.30.0 (18 Feb 2014)
Fixes

Upgrade Requirement:
Recommended - HP recommends users update to this version at their earliest convenience.


None

Enhancements

New scripts added:

  • Add_Federation_Group.xml
  • Delete_Federation_Group.xml
  • ERS_DC_CompleteRegistration.xml
  • ERS_DC_RegisterDevice.xml
  • Get_Boot_Mode.xml
  • Get_Current_Boot_Mode.xml
  • Get_Federation_All_Groups.xml
  • Get_Federation_All_Groups_Info.xml
  • Get_Federation_Group.xml
  • Get_Federation_Multicast_Options.xml
  • Get_Supported_Boot_Mode.xml
  • Get_TPM_Status.xml
  • Mod_Federation_Group.xml
  • Set_Federation_Multicast_Options.xml
  • Set_Boot_Mode.xml
  • Set_Persistent_Boot_Order.xml

Version:4.20.0 (10 Sep 2013)
Enhancements

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


New scripts added:

  • Get_Embedded_Health.xml
  • Get_Persmouse_Status.xml
  • Get_Product_Name.xml
  • Set_Persmouse_Status.xml
  • Update_Language.xml

Version:4.12.0 (13 May 2013)
Fixes

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


None

Enhancements

Added the following scripts:

  • Set_Persmouse_Status.xml
  • Get_Persmouse_Status.xml

Version:4.11.0 (19 Feb 2013)
Enhancements

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


  • New scripts added:
    • Get_Server_FQDN.xml - This is a sample XML script to get the host server Fully Qualified Domain Name.
    • Set_Server_FQDN.xml - This is a sample XML script to set the host server Fully Qualified Domain Name.
    • Get_Rack_Settings.xml - This is a sample XML script to return enclosure data for c-Class Blade infrastructure.
    • Get_All_Licenses.xml - This is a sample XML script to get the license information.
    • Set_Fips_Enable.xml - This is a sample XML script to enable FIPS mode.
    • Get_Fips_Status.xml - This is a sample XML script to return the current FIPS Mode
       
  • New tags added for supporting the following features:
    • New tags added in Mod_Global_Settings.xml to set Remote Syslog and Alert Mail in iLO 4.
    • New tags added in Mod_SNMP_IM_Setttings.xml to set SNMP traps.

Version:4.10.0 (24 Sep 2012)
Enhancements

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


  • New scripts added:
    • Set_Security_Msg.xml & Get_Security_Msg.xml scripts to retrieve / configure the current security text message set in the iLO Login Banner.
    • Set_FIPS_Enable.xml & Get_FIPS_Status.xml scripts are added to enable FIP’s mode / retrieve current FIP’s Mode in iLO
    • Hotkey_Config.xml - to configure a set of Remote Console hotkeys for iLO
    • Get_Hotkey_Config.xml - to get the Remote Console hotkeys from iLO.
    • Delete_SSH_Key.xml - deletes existing SSH key saved for the user that is referred by the USER_LOGIN value.
    • Cert_Request.xml - to get a certificate signing request from iLO.
    • Profile_Apply.xml - set the Profile Descriptor in iLO.
    • Profile_Apply_Get_Results.xml - to get the results from the Profile_Apply.
    • Profile_Desc_Delete.xml - to delete the Profile Descriptor.
    • Profile_Desc_List.xml - to list all the Profile Descriptors and the data stored in the Profile Descriptor.
    • Profile_Desc_Download.xml - to write a Profile Description, download a specific blob and write the blob to the blob store. 
  • New tags added for supporting the following features:
    • New tags added in Mod_Global_Settings.xml to set the value for SNMP port and SNMP trap port in iLO.
    • New tags added in Mod_Network_Settings.xml for configuring IPv6 network settings.

Version:4.00.0 (16 Apr 2012)
Enhancements

Upgrade Requirement:
Recommended - HP recommends users update to this version at their earliest convenience.


  • Added scripts to support iLO 4.    

Version:3.10.0 (9 Jun 2011)
Enhancements

Upgrade Requirement:
Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


New Scripts Added:

Mod_Kerberos_Config.xml
  • Set_Fqdn.xml
  • Set_default_language.xml
  • Set_One_Time_Boot_Order.xml
  • Set_Persistent_Boot_Order.xml
  • Get_language.xml
  • Get_One_Time_Boot_Order.xml
  • Get_Persistent_Boot_Order.xml
  • Delete_SSH_Key.xml
  • Set_CSR_Custom.xml
  • Set_CSR_Default.xml 
  • Get_Cert_Subject.xml
  • Mod_ConsoleCapture_Port_Settings.xml
  • Mod_VM_Port_Settings.xml
  •  


    Version:3.0.0-2 (26 May 2010)
    Enhancements

    Upgrade Requirement:
    Recommended - HP recommends users update to this version at their earliest convenience.


    Provided Support for Integrated Lights-Out 3 (iLO3)

    New Script added:
       - Clear_Power_On_Time.xml
       - Get_Power_On_Time.xml
       - Get_Pwreg_Alert_Threshold.xml
       - Lock_Configuration.xml
       - Mod_Network_Settings.xml
       - Set_Pwreg_Alert_Threshold.xml


    Version:2.40.0-1 (7 May 2009)
    Enhancements
    Added the following sample scripts:
    • Import_SSH_Key.xml
    • Get_Host_Pwr_Micro_Ver.xml

    Added the following configuration options to Mod_Global_Settings.xml:

    • KEY_UP_KEY_DOWN
    • CAPTURE_MANUAL_EXPORT

    Added the following option to Update_Firmware.xml

    • TPM_ENABLED

    Added the following option to Mod_Directory.xml

    • DIR_USER_CONTEXT_X

    where X can be from 4 to 15.


    Version:2.20.0-1 (26 Jul 2007)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    New support for iLO 2 v1.30.

    Added following sample scripts:

    • Add_SSO_Rec.xml
    • Add_SSO_Settings.xml
    • Mod_SSO_Settings.xml
    • Add_SSO_Rec.xml
    • Delete_SSO_Rec.xml
    • Clear_IML.xml
    • Computer_Lock_Config.xml
    • Get_PowerCap.xml
    • Get_Server_Name.xml
    • Set_Server_Name.xml
    • Set_PowerCap.xml
    Added following commands to Mod_Global_Settings.xml:
    • ENFORCE_AES
    • AUTHENTICATION_FAILURE_LOGGINS
    • CONSOLE_CAPTURE_ENABLE
    • CONSOLE_CAPTURE_BOOT_BUFFER_ENABLE
    • CONSOLE_CAPTURE_FAULT_BUFFER_ENABLE
    • INTERACTIVE_CONSOLE_REPLAY_ENABLE
    • CONSOLE_CAPTURE_PORT
    • CAPTURE_AUTO_EXPORT_ENABLE
    • CAPTURE_AUTO_EXPORT_LOCATION
    • CAPTURE_AUTO_EXPORT_USERNAME
    • CAPTURE_AUTO_EXPORT_PASSWORD
    • SHARED_CONSOLE_ENABLE
    • SHARED_CONSOLE_PORT
    Added locfg.pl command line options "-u username" and "-p password".
  • Note: Use "-u" and "-p" with caution as comamnd line options are visible on Linux.

  • Version:2.10.0-1 (12 Jul 2006)
    Fixes

    Upgrade Requirement:
    Recommended - HPE recommends users update to this version at their earliest convenience.


    Fixed tag names for ILO 2 in Mod_VLAN.xml.

    Enhancements

    New support for iLO 2 v1.1x and v1.20.

    Added following sample scripts:

    • Copy_Virtual_Floppy.xml
    • Get_All_Cables_Status.xml
    • Get_EmHealth.xml
    • Get_Host_APO.xml
    • Get_Power_Readings.xml
    • Get_VPB_Cable_Status.xml
    • Set_Host_APO.xml

    Version:2.00.0-1 (2 Feb 2006)
    Fixes

    Upgrade Requirement:
    Recommended - HPE recommends users update to this version at their earliest convenience.


    Added sample script for set_host_power
    Updated get_ilo_log to not use RIB info mode write Fixes typos in scripts.

    Enhancements

    New support for iLO 2 v1.0x and RILOE-II v1.20.


    Version:1.80.0-1 (14 Jul 2005)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    The following scripts have been added or modified to support additional firmware features available in 1.80:

    Mod_VLAN.xml
    Mod_Schemaless_Directory.xml
    Get_Host_Pwr_Reg_Info.xml
    Mod_2Factor.xml
    Import_2Factor_Certs.xml
    Get_2Factor.xml


    Version:1.70.0-1 (13 Apr 2005)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    The following scripts have been added or modified to support additional firmware features available in 1.70:
    NEW SAMPLE SCRIPTS
    Get_Host_Power_Saver.xml
    Set_Host_Power_Saver.xml


    Version:1.64.0-1 (24 Nov 2004)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    The following scripts have been added or modified to support additional firmware features available in 1.64:

    • Cert_Request.xml

    • Import_Cert.xml

    Version:1.60 (16 Jul 2004)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    The following scripts have been added or modified to support additional firmware features available in 1.55 and 1.60:

    • NEW SAMPLE SCRIPTS
      Eject_Virtual_Media.xml
      Get_VM_Status.xml
      Insert_Virtual_Media.xml
      Set_VM_Status.xml
      Get_Host_Data.xml
      Shared_Network_Port.xml
      RBSU_POST_IP.xml
      Get_IML.xml
      Get_iLO_Log.xml
      Administrator_reset_pw.xml
      Get_Enc_Bay_IP_Settings.xml
      Mod_Network_Settings.xml
      Mod_Enc_Bay_IP_Settings.xml

    • NEW UTILITY
      The HPONCFG.EXE utility is now available, allowing you to use RIBCL scripts on line while running from the host.
    Requirements:
    • iLO 1.41 or later

    • RILOE II 1.13

    • the approprite lights-out driver
    HPONCFG passes the scripts to the local lights-out processor when running from an Administrator or root account on the host.

    You can use this utility to configure and operate lights-out without using the network connection. The utility accepts existing RIBCL scripts.


    Version:1.5 (23 Jan 2004)
    Enhancements
    Updated with new iLO v1.50 scripting commands.

    Type: Software - Lights-Out Management
    Version: 1.64.0-1(24 Nov 2004)
    Operating System(s):
    Microsoft Windows 2000
    Microsoft Windows NT 4.0
    Microsoft Windows Server 2003
    Novell NetWare 5.1
    Novell NetWare 6.5

    Description

    The HP Lights-Out management processors support an advanced scripting interface for group configuration and server actions. The scripting capability of the iLO provides an easy and efficient way to configure and maintain management processors in large scale IT environments, saving time and costs. The Lights-Out Configuration Utility can be used to configure iLO, RILOE II, and RILOE.

    It takes just a few simple steps to use the scripting interface:

    Download and install the Light-Out Configuration Utility on your client system
    Download and modify these sample scripts
    Run the CPQLOCFG program in a batch process or using Insight Manager 7

    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    The following scripts have been added or modified to support additional firmware features available in 1.64:

    • Cert_Request.xml

    • Import_Cert.xml

    Installation Instructions

    To ensure the integrity of your download, HPE recommends verifying your results with this SHA-256 Checksum value:

    cc234e4edd7b481439c827b923bda081df449bee47388804c44d81cb2c7f4bdf ilosamplescripts1.64.0-1.zip

    Reboot Requirement:
    Reboot is not required after installation for updates to take effect and hardware stability to be maintained.


    Installation:
    Extract ilo_xml-1.2.tar.gz to a subdirectory. This compressed file contains the following files:

    • Add_User.xml - Add a user to the iLO user database.

    • Administrator_reset_pw.xml- Reset the default administrator account password using HPONCFG.

    • Cert_Request.xml - Request a Certificate Signing Request from iLO.

    • Change_Password.xml - Change the password of an existing iLO user.

    • Clear_EventLog.xml - Clear the iLO Event Log

    • Delete_User.xml - Delete a user from the iLO user database.

    • Eject_Virtual_Media.xml - Ejects the image of the specified Virtual Media device.

    • Get_All_User_Info.xml - Return the configuration details for all users.

    • Get_All_Users.xml - Return a list of all iLO user accounts.

    • Get_Diagport.xml - Return BL p-class diagport settings.

    • Get_Directory.xml - Return the current directory configuration of an iLO.

    • Get_FW_Version.xml - Return the version and date/time of the iLO firmware.

    • Get_Global.xml - Return global settings.

    • Get_Host_Data.xml - Retrieve SMBIOS data from Server Information page.

    • Get_Host_Power.xml - Return the current power state of the host server.

    • Get_iLO_Log.xml - Retrieve the records in the iLO Event Log.

    • Get_IML.xml - Retrieve the records in the Integrated Management Log.

    • Get_SNMP_IM.xml - Return the current SNMP and Insight Manager security settings.

    • Get_Topology.xml - Return BL p-Class rack infrastructure topology.

    • Get_Network.xml - Return network settings.

    • Get_UID_Status.xml - Return the current state of the server's Unit ID (UID) on the host server.

    • Get_User.xml - Return the configuration details for a single user.

    • Get_VM_Status - Return the status of the specified Virtual Media device.

    • Get_Enc_Bay_IP_Settings.xml - Obtain static IP settings of individual blades in the respective enclosure.

    • Hotkey_Config.xml - Change the values for Remote Console hotkeys.

    • Import_Cert.xml - Import a signed certificate into iLO.

    • Insert_Virtual_Media.xml - Inserts the Virtual Media image via specified URL.

    • License.xml - Add the iLO Advanced Pack license key for a server.

    • Mod_Blade_Rack.xml - Change the BL p-Class blade and rack settings.

    • Mod_DiagPort_Settings.xml - Change the iLO Diagnostic Port network settings.

    • Mod_Directory.xml - Change the directory settings of an iLO.

    • Mod_Global_Settings.xml - Change the iLO Global Settings.

    • Mod_Network_Settings.xml - Change the iLO Network Settings.

    • Mod_SNMP_IM_Settings.xml - Change the iLO SNMP and Insight Manager Settings.

    • Mod_User.xml - Change the login id, display name, password and/or privileges for an existing iLO user account.

    • Mod_Enc_Bay_IP_Settings.xml - Modify the static IP settings of individual blades in the respective enclosure.

    • RBSU_POST_IP.xml - Configure iLO to display the IP address at POST.

    • Reset_RIB.xml - Restart the iLO Management Processor.

    • Reset_Server.xml - Immediately power off and back on the host server.

    • Set_Host_Power.xml - Power on/off the host server.

    • Set_VM_Status.xml - Sets the boot options, write protection of the specified Virtual Media device.

    • Shared_Network_Port.xml - Configure the iLO NIC port on supported platforms.

    • UID_Control.xml - Turn on/off the Unit ID (UID) light on the host server.

    • Update_Firmware.xml - Flash the iLO firmware to a new version.
    Utilities and documentation may be downloaded from: http://www.hp.com/servers/lights-out Click on iLO, then click on "Software and Drivers" or "Support and Documents"documentation" for appropriate links.

    A valid iLO user account and password is required for each XML script when using CPQLOCFG. The user account must have appropriate lights-out privileges to process the request.

    The CPQLOCFG utility connects to the iLO management processor using a 128-bit Secure Sockets Layer (SSL) connection.

      CPQLOCFG -s [servername|ipaddress]|[:port] -l [logfilename] -f [input filename] -v -c
    Where:
      -s servername is the DNS name of target server.
      -s ipaddress is the IP Address of the target server. If a port is not specified, the port will default to :443.

        DO NOT USE this switch if launching from Insight Manager 7.

      -l logfilename is the name of the file to log all output to. A default file with the server name/ipaddress is created if this option is not specified.

        DO NOT USE this switch if launching from Insight Manager 7.

      -f input filename is the filename containing the RIB Commands
      -v Enables verbose message logging. By default, only errors and responses from GET commands will be logged without the -v switch.
      -c Will cause CPQLOCFG to check for correct xml formatting, but not open a connection to the management processor.

    Release Notes

    End User License Agreements:
    Hewlett-Packard End User License Agreement


    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    Notes:
    Updated iLO User Guide 1.60 and Updated Information Booklet 1.60 can also be found by following the links at: http://h20000.www2.hp.com/bizsupport/TechSupport/DocumentIndex.jsp?contentType=SupportManual&locale=en_US&docIndexId=179911&taskId=101&prodTypeId=15351&prodSeriesId=397989.


    Revision History

    Version:5.40.0 (30 Nov 2020)
    Fixes

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    This version does not contain any defect fixes.

    Enhancements

     This version specifically contains changes related to updating legacy HP branding and brand references from prior to the separation of Hewlett-Packard Company to current HPE branding and references.


    Version:5.30.0 (6 Jul 2020)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    Added Remove_Webserv_Cert.xml script to remove iLO SSL/webserver certificate for iLO3 v1.92 or later.


    Version:5.20.0 (20 Dec 2019)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    Added new tags for Alert mail in Mod_Global_Settings.xml.


    Version:5.10.0 (16 Jan 2018)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    Added Get_PS_Data.xml to sample script bundle.


    Version:5.00.0 (12 Jul 2017)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    iLO 5 support introduced in LOCFG.pl.


    Version:4.91.0 (15 May 2017)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    Support for iLO 4 v2.53 firmware -

    • Ability to enable Generic LDAP from Mod_Directory.xml
    • Ability to Import LDAP CA certificate into an iLO using Import_LDAP_CA_Cert.xml
    • Ability to get LDAP CA certificate status using Get_LDAP_CA_Cert_Status.xml

    Version:4.90.0 (24 Oct 2016)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    Added a new tag to Mod_Network_Settings.xml

    • IPMI_DCMI_OVER_LAN_PORT

    Version:4.80.0 (1 Apr 2016)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    Added support to set or get the critical temperature shutdown behavior of a server

    • Set_Host_CTRO.xml
    • Get_Host_CTRO.xml

    Added support to perform Directory Tests

    • Start_Directory_Test.xml
    • Get_Directory_Test_Results.xml
    • Abort_Directory_test.xml

    Added 4 new tags to Mod_Network_Settings.xml

    • ILO_NIC_AUTO_SNP_SCAN
    • ILO_NIC_AUTO_DELAY
    • ILO_NIC_FAIL_OVER
    • ILO_NIC_FAIL_OVER_DELAY

    Version:4.70.0 (1 Oct 2015)
    Fixes

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    • AUTHENTICATION_FAILURE_DELAY_SECS, AUTHENTICATION_FAILURES_BEFORE_DELAY and LOCK_CONFIGURATION tags added to Mod_Global_Settings.xml

    Version:4.60.0 (15 Jun 2015)
    Fixes

    Upgrade Requirement:
    Recommended - HPE recommends users update to this version at their earliest convenience.


    • Improved error handling for script execution in LOCFG.pl
    Enhancements

    • Introduced FEDERATION_ENABLE tag in Set_Federation_Multicast_Options.xml
    • 4 new scripts added for Hard Drive zoning - HD_Zone_Defaults.xml, HD_Zone_ReadBackplaneInfo.xml, HD_Zone_ReadZoneTable.xml and HD_Zone_Write_Zone.xml

    Version:4.50.0 (30 Mar 2015)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    - Introduced SNP_PORT tag in Shared_Network_Port.xml
    - Added DHCPV6_DOMAIN_NAME and ILO_NIC_AUTO_SELECT tags in Mod_Network_Settings.xml
    - SSL_V3_ENABLE tag for iLO2 Management Processor is included in MOD_GLOBAL_SETTINGS.xml
    - Result of script execution gets printed at the end of each run in LOCFG.PL
    - 2 new scripts added - Get_SDCard_Status.xml and Send_Snmp_Test_Trap.xml


    Version:4.40.0 (9 Sep 2014)
    Fixes

    Upgrade Requirement:
    Recommended - HP recommends users update to this version at their earliest convenience.


    LOCFG.PL supports iLO fully qualified domain name(FQDN) with –s option


    Version:4.30.0 (18 Feb 2014)
    Fixes

    Upgrade Requirement:
    Recommended - HP recommends users update to this version at their earliest convenience.


    None

    Enhancements

    New scripts added:

    • Add_Federation_Group.xml
    • Delete_Federation_Group.xml
    • ERS_DC_CompleteRegistration.xml
    • ERS_DC_RegisterDevice.xml
    • Get_Boot_Mode.xml
    • Get_Current_Boot_Mode.xml
    • Get_Federation_All_Groups.xml
    • Get_Federation_All_Groups_Info.xml
    • Get_Federation_Group.xml
    • Get_Federation_Multicast_Options.xml
    • Get_Supported_Boot_Mode.xml
    • Get_TPM_Status.xml
    • Mod_Federation_Group.xml
    • Set_Federation_Multicast_Options.xml
    • Set_Boot_Mode.xml
    • Set_Persistent_Boot_Order.xml

    Version:4.20.0 (10 Sep 2013)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    New scripts added:

    • Get_Embedded_Health.xml
    • Get_Persmouse_Status.xml
    • Get_Product_Name.xml
    • Set_Persmouse_Status.xml
    • Update_Language.xml

    Version:4.12.0 (13 May 2013)
    Fixes

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    None

    Enhancements

    Added the following scripts:

    • Set_Persmouse_Status.xml
    • Get_Persmouse_Status.xml

    Version:4.11.0 (19 Feb 2013)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    • New scripts added:
      • Get_Server_FQDN.xml - This is a sample XML script to get the host server Fully Qualified Domain Name.
      • Set_Server_FQDN.xml - This is a sample XML script to set the host server Fully Qualified Domain Name.
      • Get_Rack_Settings.xml - This is a sample XML script to return enclosure data for c-Class Blade infrastructure.
      • Get_All_Licenses.xml - This is a sample XML script to get the license information.
      • Set_Fips_Enable.xml - This is a sample XML script to enable FIPS mode.
      • Get_Fips_Status.xml - This is a sample XML script to return the current FIPS Mode
         
    • New tags added for supporting the following features:
      • New tags added in Mod_Global_Settings.xml to set Remote Syslog and Alert Mail in iLO 4.
      • New tags added in Mod_SNMP_IM_Setttings.xml to set SNMP traps.

    Version:4.10.0 (24 Sep 2012)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    • New scripts added:
      • Set_Security_Msg.xml & Get_Security_Msg.xml scripts to retrieve / configure the current security text message set in the iLO Login Banner.
      • Set_FIPS_Enable.xml & Get_FIPS_Status.xml scripts are added to enable FIP’s mode / retrieve current FIP’s Mode in iLO
      • Hotkey_Config.xml - to configure a set of Remote Console hotkeys for iLO
      • Get_Hotkey_Config.xml - to get the Remote Console hotkeys from iLO.
      • Delete_SSH_Key.xml - deletes existing SSH key saved for the user that is referred by the USER_LOGIN value.
      • Cert_Request.xml - to get a certificate signing request from iLO.
      • Profile_Apply.xml - set the Profile Descriptor in iLO.
      • Profile_Apply_Get_Results.xml - to get the results from the Profile_Apply.
      • Profile_Desc_Delete.xml - to delete the Profile Descriptor.
      • Profile_Desc_List.xml - to list all the Profile Descriptors and the data stored in the Profile Descriptor.
      • Profile_Desc_Download.xml - to write a Profile Description, download a specific blob and write the blob to the blob store. 
    • New tags added for supporting the following features:
      • New tags added in Mod_Global_Settings.xml to set the value for SNMP port and SNMP trap port in iLO.
      • New tags added in Mod_Network_Settings.xml for configuring IPv6 network settings.

    Version:4.00.0 (16 Apr 2012)
    Enhancements

    Upgrade Requirement:
    Recommended - HP recommends users update to this version at their earliest convenience.


    • Added scripts to support iLO 4.    

    Version:3.10.0 (9 Jun 2011)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    New Scripts Added:

    Mod_Kerberos_Config.xml
  • Set_Fqdn.xml
  • Set_default_language.xml
  • Set_One_Time_Boot_Order.xml
  • Set_Persistent_Boot_Order.xml
  • Get_language.xml
  • Get_One_Time_Boot_Order.xml
  • Get_Persistent_Boot_Order.xml
  • Delete_SSH_Key.xml
  • Set_CSR_Custom.xml
  • Set_CSR_Default.xml 
  • Get_Cert_Subject.xml
  • Mod_ConsoleCapture_Port_Settings.xml
  • Mod_VM_Port_Settings.xml
  •  


    Version:3.0.0-2 (26 May 2010)
    Enhancements

    Upgrade Requirement:
    Recommended - HP recommends users update to this version at their earliest convenience.


    Provided Support for Integrated Lights-Out 3 (iLO3)

    New Script added:
       - Clear_Power_On_Time.xml
       - Get_Power_On_Time.xml
       - Get_Pwreg_Alert_Threshold.xml
       - Lock_Configuration.xml
       - Mod_Network_Settings.xml
       - Set_Pwreg_Alert_Threshold.xml


    Version:2.40.0-1 (7 May 2009)
    Enhancements
    Added the following sample scripts:
    • Import_SSH_Key.xml
    • Get_Host_Pwr_Micro_Ver.xml

    Added the following configuration options to Mod_Global_Settings.xml:

    • KEY_UP_KEY_DOWN
    • CAPTURE_MANUAL_EXPORT

    Added the following option to Update_Firmware.xml

    • TPM_ENABLED

    Added the following option to Mod_Directory.xml

    • DIR_USER_CONTEXT_X

    where X can be from 4 to 15.


    Version:2.20.0-1 (26 Jul 2007)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    New support for iLO 2 v1.30.

    Added following sample scripts:

    • Add_SSO_Rec.xml
    • Add_SSO_Settings.xml
    • Mod_SSO_Settings.xml
    • Add_SSO_Rec.xml
    • Delete_SSO_Rec.xml
    • Clear_IML.xml
    • Computer_Lock_Config.xml
    • Get_PowerCap.xml
    • Get_Server_Name.xml
    • Set_Server_Name.xml
    • Set_PowerCap.xml
    Added following commands to Mod_Global_Settings.xml:
    • ENFORCE_AES
    • AUTHENTICATION_FAILURE_LOGGINS
    • CONSOLE_CAPTURE_ENABLE
    • CONSOLE_CAPTURE_BOOT_BUFFER_ENABLE
    • CONSOLE_CAPTURE_FAULT_BUFFER_ENABLE
    • INTERACTIVE_CONSOLE_REPLAY_ENABLE
    • CONSOLE_CAPTURE_PORT
    • CAPTURE_AUTO_EXPORT_ENABLE
    • CAPTURE_AUTO_EXPORT_LOCATION
    • CAPTURE_AUTO_EXPORT_USERNAME
    • CAPTURE_AUTO_EXPORT_PASSWORD
    • SHARED_CONSOLE_ENABLE
    • SHARED_CONSOLE_PORT
    Added locfg.pl command line options "-u username" and "-p password".
  • Note: Use "-u" and "-p" with caution as comamnd line options are visible on Linux.

  • Version:2.10.0-1 (12 Jul 2006)
    Fixes

    Upgrade Requirement:
    Recommended - HPE recommends users update to this version at their earliest convenience.


    Fixed tag names for ILO 2 in Mod_VLAN.xml.

    Enhancements

    New support for iLO 2 v1.1x and v1.20.

    Added following sample scripts:

    • Copy_Virtual_Floppy.xml
    • Get_All_Cables_Status.xml
    • Get_EmHealth.xml
    • Get_Host_APO.xml
    • Get_Power_Readings.xml
    • Get_VPB_Cable_Status.xml
    • Set_Host_APO.xml

    Version:2.00.0-1 (2 Feb 2006)
    Fixes

    Upgrade Requirement:
    Recommended - HPE recommends users update to this version at their earliest convenience.


    Added sample script for set_host_power
    Updated get_ilo_log to not use RIB info mode write Fixes typos in scripts.

    Enhancements

    New support for iLO 2 v1.0x and RILOE-II v1.20.


    Version:1.80.0-1 (14 Jul 2005)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    The following scripts have been added or modified to support additional firmware features available in 1.80:

    Mod_VLAN.xml
    Mod_Schemaless_Directory.xml
    Get_Host_Pwr_Reg_Info.xml
    Mod_2Factor.xml
    Import_2Factor_Certs.xml
    Get_2Factor.xml


    Version:1.70.0-1 (13 Apr 2005)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    The following scripts have been added or modified to support additional firmware features available in 1.70:
    NEW SAMPLE SCRIPTS
    Get_Host_Power_Saver.xml
    Set_Host_Power_Saver.xml


    Version:1.64.0-1 (24 Nov 2004)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    The following scripts have been added or modified to support additional firmware features available in 1.64:

    • Cert_Request.xml

    • Import_Cert.xml

    Version:1.60 (16 Jul 2004)
    Enhancements

    Upgrade Requirement:
    Optional - Users should update to this version if their system is affected by one of the documented fixes or if there is a desire to utilize any of the enhanced functionality provided by this version.


    The following scripts have been added or modified to support additional firmware features available in 1.55 and 1.60:

    • NEW SAMPLE SCRIPTS
      Eject_Virtual_Media.xml
      Get_VM_Status.xml
      Insert_Virtual_Media.xml
      Set_VM_Status.xml
      Get_Host_Data.xml
      Shared_Network_Port.xml
      RBSU_POST_IP.xml
      Get_IML.xml
      Get_iLO_Log.xml
      Administrator_reset_pw.xml
      Get_Enc_Bay_IP_Settings.xml
      Mod_Network_Settings.xml
      Mod_Enc_Bay_IP_Settings.xml

    • NEW UTILITY
      The HPONCFG.EXE utility is now available, allowing you to use RIBCL scripts on line while running from the host.
    Requirements:
    • iLO 1.41 or later

    • RILOE II 1.13

    • the approprite lights-out driver
    HPONCFG passes the scripts to the local lights-out processor when running from an Administrator or root account on the host.

    You can use this utility to configure and operate lights-out without using the network connection. The utility accepts existing RIBCL scripts.


    Version:1.5 (23 Jan 2004)
    Enhancements
    Updated with new iLO v1.50 scripting commands.

    Legal Disclaimer: Products sold prior to the November 1, 2015 separation of Hewlett-Packard Company into Hewlett Packard Enterprise Company and HP Inc. may have older product names and model numbers that differ from current models.